Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WorkRequest

An asynchronous work request. See Work Requests.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources aren't in the same compartment, it's up to the service team to pick the primary resource whose compartment should be used.

Optional completedTaskCount

completedTaskCount: undefined | number

The number of tasks had been executed to a terminal state. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional createdBy

createdBy: model.Principal

id

id: string

The OCID of the work request.

operationType

operationType: OperationType

The asynchronous operation tracked by this work request.

percentComplete

percentComplete: number

The percentage complete of the operation tracked by this work request. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

resources

resources: Array<WorkRequestResource>

The resources that are affected by this work request.

status

The status of the work request.

timeAccepted

timeAccepted: Date

The date and time the request was created (formatted according to RFC3339).

Optional timeFinished

timeFinished: Date

The date and time the work request reached a terminal state, either FAILED or SUCCEEDED (formatted according to RFC3339).

Optional timeLastUpdated

timeLastUpdated: Date

The date and time the work request percentage was last updated. (formatted according to RFC3339).

Optional timeStarted

timeStarted: Date

The date and time the work request transitioned from ACCEPTED to _IN_PROGRESS_ (formatted according to RFC3339).

Optional totalTaskCount

totalTaskCount: undefined | number

The total number of tasks to be executed for this work request. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj