Interface OperationModel

The OperationModel describes the status of an ongoing or completed server operation.

Export

OperationModel

interface OperationModel {
    completedOn?: null | Date;
    createdOn: Date;
    errorMessage?: null | string;
    fileId?: null | string;
    id: string;
    ingestionUnits?: null | number;
    operationType: string;
    percentComplete?: number;
    status: string;
}

Properties

completedOn? createdOn errorMessage? fileId? id ingestionUnits? operationType percentComplete? status

Properties

OptionalcompletedOn

completedOn?: null | Date

The timestamp when the operation completed or failed, in ISO 8601 format. Present only when status is Completed or Failed.

Memberof

OperationModel

createdOn

createdOn: Date

The timestamp when the operation was created, in ISO 8601 format.

Memberof

OperationModel

OptionalerrorMessage

errorMessage?: null | string

A message describing the error that caused the operation to fail. Present only when status is Failed.

Memberof

OperationModel

OptionalfileId

fileId?: null | string

The identifier of the file being operated on.

Memberof

OperationModel

id

id: string

The unique identifier for the operation.

Memberof

OperationModel

OptionalingestionUnits

ingestionUnits?: null | number

The number of ingestion units consumed by this operation. Present only when status is Completed for file ingestion operations.

Memberof

OperationModel

operationType

operationType: string

The kind of action represented by this operation, such as uploading or deleting a file.

Memberof

OperationModel

OptionalpercentComplete

percentComplete?: number

The progress made by the operation, as a percentage (0-100).

Memberof

OperationModel

status

status: string

The status of the operation.

  • Processing: The operation is in progress.
  • Completed: The operation finished successfully.
  • Failed: The operation failed. See error_message for details.

Memberof

OperationModel

Settings

Member Visibility

On This Page

Properties