WorkRequestSummary¶
- class oci.identity.models.WorkRequestSummary(**kwargs)¶
Bases:
objectThe work request summary. Tracks the status of the asynchronous operation.
Attributes:
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
Gets the compartment_id of this WorkRequestSummary.
Gets the errors of this WorkRequestSummary.
[Required] Gets the id of this WorkRequestSummary.
[Required] Gets the operation_type of this WorkRequestSummary.
Gets the percent_complete of this WorkRequestSummary.
Gets the resources of this WorkRequestSummary.
[Required] Gets the status of this WorkRequestSummary.
Gets the time_accepted of this WorkRequestSummary.
Gets the time_finished of this WorkRequestSummary.
Gets the time_started of this WorkRequestSummary.
Methods:
__init__(**kwargs)Initializes a new WorkRequestSummary 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 WorkRequestSummary. 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 WorkRequestSummary. This constant has a value of “DELETE_TAG_DEFINITION”
- STATUS_ACCEPTED = 'ACCEPTED'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “ACCEPTED”
- STATUS_CANCELED = 'CANCELED'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “CANCELED”
- STATUS_CANCELING = 'CANCELING'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “CANCELING”
- STATUS_FAILED = 'FAILED'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “FAILED”
- STATUS_IN_PROGRESS = 'IN_PROGRESS'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “IN_PROGRESS”
- STATUS_SUCCEEDED = 'SUCCEEDED'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “SUCCEEDED”
- __init__(**kwargs)¶
Initializes a new WorkRequestSummary 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 WorkRequestSummary.
operation_type (str) – The value to assign to the operation_type property of this WorkRequestSummary. 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 WorkRequestSummary.
status (str) – The value to assign to the status property of this WorkRequestSummary. 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 WorkRequestSummary.
errors (list[oci.identity.models.WorkRequestError]) – The value to assign to the errors property of this WorkRequestSummary.
time_accepted (datetime) – The value to assign to the time_accepted property of this WorkRequestSummary.
time_started (datetime) – The value to assign to the time_started property of this WorkRequestSummary.
time_finished (datetime) – The value to assign to the time_finished property of this WorkRequestSummary.
percent_complete (float) – The value to assign to the percent_complete property of this WorkRequestSummary.
- property compartment_id¶
Gets the compartment_id of this WorkRequestSummary. The OCID of the compartment that contains the work request.
- Returns
The compartment_id of this WorkRequestSummary.
- Return type
str
- property errors¶
Gets the errors of this WorkRequestSummary. The errors for work request.
- Returns
The errors of this WorkRequestSummary.
- Return type
- property id¶
[Required] Gets the id of this WorkRequestSummary. The OCID of the work request.
- Returns
The id of this WorkRequestSummary.
- Return type
str
- property operation_type¶
[Required] Gets the operation_type of this WorkRequestSummary. 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 WorkRequestSummary.
- Return type
str
- property percent_complete¶
Gets the percent_complete of this WorkRequestSummary. How much progress the operation has made.
- Returns
The percent_complete of this WorkRequestSummary.
- Return type
float
- property resources¶
Gets the resources of this WorkRequestSummary. The resources this work request affects.
- Returns
The resources of this WorkRequestSummary.
- Return type
- property status¶
[Required] Gets the status of this WorkRequestSummary. 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 WorkRequestSummary.
- Return type
str
- property time_accepted¶
Gets the time_accepted of this WorkRequestSummary. 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 WorkRequestSummary.
- Return type
datetime
- property time_finished¶
Gets the time_finished of this WorkRequestSummary. 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 WorkRequestSummary.
- Return type
datetime
- property time_started¶
Gets the time_started of this WorkRequestSummary. 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 WorkRequestSummary.
- Return type
datetime