Search Results for

    Show / Hide Table of Contents

    Class ScheduledOperation

    Abstract base class for scheduled operations, which are long running tasks that are executed on the Execution Server.

    Inheritance
    System.Object
    ScheduledOperation
    ImportExportOperationBase
    ScheduledFieldApplyOperation
    ScheduledLanguageResourcesApplyOperation
    ScheduledRecomputeStatisticsOperation
    ScheduledReindexOperation
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Sdl.LanguagePlatform.TranslationMemoryApi
    Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll
    Syntax
    public abstract class ScheduledOperation

    Properties

    CancelledOn

    Gets when the operation was cancelled if the Status is Cancelled.

    Declaration
    public DateTime? CancelledOn { get; }
    Property Value
    Type Description
    System.Nullable<System.DateTime>

    CompletedOn

    Gets when the operation was completed.

    Declaration
    public DateTime? CompletedOn { get; }
    Property Value
    Type Description
    System.Nullable<System.DateTime>

    ErrorMessage

    Gets the error message in case the Status is Error.

    Declaration
    public string ErrorMessage { get; }
    Property Value
    Type Description
    System.String

    IsFinished

    Gets a value indicating whether this operation has finished.

    Declaration
    public bool IsFinished { get; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    A finished operation has one of the following statues; Completed, Aborted, Cancelled, Recovered or Error.

    IsPending

    Gets a value indicating whether this operation is pending.

    Declaration
    public bool IsPending { get; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    A pending operation has one of the following statues; NotSet, Queued, Cancel, Abort or Recovery.

    IsRunning

    Gets a value indicating whether this operation is running.

    Declaration
    public bool IsRunning { get; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    A running operation has one of the following statues; Aborting, Allocated or Cancelling.

    PercentComplete

    Gets the current percent complete.

    Declaration
    public int PercentComplete { get; }
    Property Value
    Type Description
    System.Int32

    QueuedOn

    Gets when the operation was queued.

    Declaration
    public DateTime? QueuedOn { get; }
    Property Value
    Type Description
    System.Nullable<System.DateTime>

    StartedOn

    Gets when the operation was started by the Execution Server.

    Declaration
    public DateTime? StartedOn { get; }
    Property Value
    Type Description
    System.Nullable<System.DateTime>

    Status

    Gets the current status of the operation.

    Declaration
    public ScheduledOperationStatus Status { get; }
    Property Value
    Type Description
    ScheduledOperationStatus

    WorkItemId

    Gets the unique ID of the Execution Server work item that represents this operation.

    Declaration
    public Guid? WorkItemId { get; }
    Property Value
    Type Description
    System.Nullable<System.Guid>

    Methods

    Queue()

    Queues the operation for execution on the Execution Server.

    Declaration
    public abstract void Queue()

    Refresh()

    Refreshes the status of the operation.

    Declaration
    public abstract void Refresh()

    On this page

    • Properties
      • CancelledOn
      • CompletedOn
      • ErrorMessage
      • IsFinished
      • IsPending
      • IsRunning
      • PercentComplete
      • QueuedOn
      • StartedOn
      • Status
      • WorkItemId
    • Methods
      • Queue()
      • Refresh()
    Back to top Generated by DocFX