WorkRequest¶

class oci.identity.models.WorkRequest(**kwargs)¶

Bases: object

The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.

Attributes

`OPERATION_TYPE_DELETE_COMPARTMENT`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_DELETE_TAG_DEFINITION`	A constant which can be used with the operation_type property of a WorkRequest.
`STATUS_ACCEPTED`	A constant which can be used with the status property of a WorkRequest.
`STATUS_CANCELED`	A constant which can be used with the status property of a WorkRequest.
`STATUS_CANCELING`	A constant which can be used with the status property of a WorkRequest.
`STATUS_FAILED`	A constant which can be used with the status property of a WorkRequest.
`STATUS_IN_PROGRESS`	A constant which can be used with the status property of a WorkRequest.
`STATUS_SUCCEEDED`	A constant which can be used with the status property of a WorkRequest.
`compartment_id`	Gets the compartment_id of this WorkRequest.
`errors`	Gets the errors of this WorkRequest.
`id`	[Required] Gets the id of this WorkRequest.
`logs`	Gets the logs of this WorkRequest.
`operation_type`	[Required] Gets the operation_type of this WorkRequest.
`percent_complete`	Gets the percent_complete of this WorkRequest.
`resources`	Gets the resources of this WorkRequest.
`status`	[Required] Gets the status of this WorkRequest.
`time_accepted`	Gets the time_accepted of this WorkRequest.
`time_finished`	Gets the time_finished of this WorkRequest.
`time_started`	Gets the time_started of this WorkRequest.

Methods

__init__(**kwargs) Initializes a new WorkRequest object with values from keyword arguments.

OPERATION_TYPE_DELETE_COMPARTMENT = 'DELETE_COMPARTMENT'¶: A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_COMPARTMENT”

OPERATION_TYPE_DELETE_TAG_DEFINITION = 'DELETE_TAG_DEFINITION'¶: A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_TAG_DEFINITION”

STATUS_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “ACCEPTED”

STATUS_CANCELED = 'CANCELED'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “CANCELED”

STATUS_CANCELING = 'CANCELING'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “CANCELING”

STATUS_FAILED = 'FAILED'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “FAILED”

STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “IN_PROGRESS”

STATUS_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new WorkRequest object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this WorkRequest.
operation_type (str) – The value to assign to the operation_type property of this WorkRequest. Allowed values for this property are: “DELETE_COMPARTMENT”, “DELETE_TAG_DEFINITION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this WorkRequest.
status (str) – The value to assign to the status property of this WorkRequest. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
resources (list[oci.identity.models.WorkRequestResource]) – The value to assign to the resources property of this WorkRequest.
errors (list[oci.identity.models.WorkRequestError]) – The value to assign to the errors property of this WorkRequest.
logs (list[oci.identity.models.WorkRequestLogEntry]) – The value to assign to the logs property of this WorkRequest.
time_accepted (datetime) – The value to assign to the time_accepted property of this WorkRequest.
time_started (datetime) – The value to assign to the time_started property of this WorkRequest.
time_finished (datetime) – The value to assign to the time_finished property of this WorkRequest.
percent_complete (float) – The value to assign to the percent_complete property of this WorkRequest.

compartment_id¶

Gets the compartment_id of this WorkRequest. The OCID of the compartment that contains the work request.

Returns:	The compartment_id of this WorkRequest.
Return type:	str

errors¶

Gets the errors of this WorkRequest. The errors for work request.

Returns:	The errors of this WorkRequest.
Return type:	list[oci.identity.models.WorkRequestError]

id¶

[Required] Gets the id of this WorkRequest. The OCID of the work request.

Returns:	The id of this WorkRequest.
Return type:	str

logs¶

Gets the logs of this WorkRequest. The logs for work request.

Returns:	The logs of this WorkRequest.
Return type:	list[oci.identity.models.WorkRequestLogEntry]

operation_type¶

[Required] Gets the operation_type of this WorkRequest. An enum-like description of the type of work the work request is doing.

Allowed values for this property are: “DELETE_COMPARTMENT”, “DELETE_TAG_DEFINITION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The operation_type of this WorkRequest.
Return type:	str

percent_complete¶

Gets the percent_complete of this WorkRequest. How much progress the operation has made.

Returns:	The percent_complete of this WorkRequest.
Return type:	float

resources¶

Gets the resources of this WorkRequest. The resources this work request affects.

Returns:	The resources of this WorkRequest.
Return type:	list[oci.identity.models.WorkRequestResource]

status¶

[Required] Gets the status of this WorkRequest. The current status of the work request.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this WorkRequest.
Return type:	str

time_accepted¶

Gets the time_accepted of this WorkRequest. Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_accepted of this WorkRequest.
Return type:	datetime

time_finished¶

Gets the time_finished of this WorkRequest. Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_finished of this WorkRequest.
Return type:	datetime

time_started¶

Gets the time_started of this WorkRequest. Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_started of this WorkRequest.
Return type:	datetime