WorkRequestResource¶
- class oci.management_agent.models.WorkRequestResource(**kwargs)¶
Bases:
objectA resource created or operated on by a work request.
Attributes:
A constant which can be used with the action_type property of a WorkRequestResource.
A constant which can be used with the action_type property of a WorkRequestResource.
A constant which can be used with the action_type property of a WorkRequestResource.
A constant which can be used with the action_type property of a WorkRequestResource.
A constant which can be used with the action_type property of a WorkRequestResource.
[Required] Gets the action_type of this WorkRequestResource.
[Required] Gets the entity_type of this WorkRequestResource.
Gets the entity_uri of this WorkRequestResource.
[Required] Gets the identifier of this WorkRequestResource.
Gets the metadata of this WorkRequestResource. Additional metadata about the resource that has been operated upon by this work request. For WorkRequests operationType WORK_DELIVERY the metadata will contain: workDeliveryStatus indicating the status of the work delivery item as a WorkDeliveryStatus value, workSubmissionKey the WorkSubmission request id, and workSubmissionDetails containing any details of result.
Gets the source_id of this WorkRequestResource.
Gets the source_name of this WorkRequestResource.
Gets the source_version of this WorkRequestResource.
Gets the time_accepted of this WorkRequestResource.
Gets the time_finished of this WorkRequestResource.
Gets the time_started of this WorkRequestResource.
Methods:
__init__(**kwargs)Initializes a new WorkRequestResource object with values from keyword arguments.
- ACTION_TYPE_CREATED = 'CREATED'¶
A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “CREATED”
- ACTION_TYPE_DELETED = 'DELETED'¶
A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “DELETED”
- ACTION_TYPE_IN_PROGRESS = 'IN_PROGRESS'¶
A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “IN_PROGRESS”
- ACTION_TYPE_RELATED = 'RELATED'¶
A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “RELATED”
- ACTION_TYPE_UPDATED = 'UPDATED'¶
A constant which can be used with the action_type property of a WorkRequestResource. This constant has a value of “UPDATED”
- __init__(**kwargs)¶
Initializes a new WorkRequestResource object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
entity_type (str) – The value to assign to the entity_type property of this WorkRequestResource.
action_type (str) – The value to assign to the action_type property of this WorkRequestResource. Allowed values for this property are: “CREATED”, “UPDATED”, “DELETED”, “IN_PROGRESS”, “RELATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
identifier (str) – The value to assign to the identifier property of this WorkRequestResource.
source_id (str) – The value to assign to the source_id property of this WorkRequestResource.
source_name (str) – The value to assign to the source_name property of this WorkRequestResource.
source_version (str) – The value to assign to the source_version property of this WorkRequestResource.
entity_uri (str) – The value to assign to the entity_uri property of this WorkRequestResource.
time_accepted (datetime) – The value to assign to the time_accepted property of this WorkRequestResource.
time_started (datetime) – The value to assign to the time_started property of this WorkRequestResource.
time_finished (datetime) – The value to assign to the time_finished property of this WorkRequestResource.
metadata (object) – The value to assign to the metadata property of this WorkRequestResource.
- property action_type¶
[Required] Gets the action_type of this WorkRequestResource. The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
Allowed values for this property are: “CREATED”, “UPDATED”, “DELETED”, “IN_PROGRESS”, “RELATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The action_type of this WorkRequestResource.
- Return type
str
- property entity_type¶
[Required] Gets the entity_type of this WorkRequestResource. The resource type the work request affects.
- Returns
The entity_type of this WorkRequestResource.
- Return type
str
- property entity_uri¶
Gets the entity_uri of this WorkRequestResource. The URI path that the user can do a GET on to access the resource metadata
- Returns
The entity_uri of this WorkRequestResource.
- Return type
str
- property identifier¶
[Required] Gets the identifier of this WorkRequestResource. The identifier of the resource the work request affects.
- Returns
The identifier of this WorkRequestResource.
- Return type
str
- property metadata¶
Gets the metadata of this WorkRequestResource. Additional metadata about the resource that has been operated upon by this work request. For WorkRequests operationType WORK_DELIVERY the metadata will contain: workDeliveryStatus indicating the status of the work delivery item as a WorkDeliveryStatus value, workSubmissionKey the WorkSubmission request id,
and workSubmissionDetails containing any details of result
- Returns
The metadata of this WorkRequestResource.
- Return type
object
- property source_id¶
Gets the source_id of this WorkRequestResource. The identifier of the source the work request is requesting.
- Returns
The source_id of this WorkRequestResource.
- Return type
str
- property source_name¶
Gets the source_name of this WorkRequestResource. The name of the source the work request is requesting.
- Returns
The source_name of this WorkRequestResource.
- Return type
str
- property source_version¶
Gets the source_version of this WorkRequestResource. The version of the source the work request is requesting.
- Returns
The source_version of this WorkRequestResource.
- Return type
str
- property time_accepted¶
Gets the time_accepted of this WorkRequestResource. The date and time the request was created, as described in RFC 3339, section 5.6.
- Returns
The time_accepted of this WorkRequestResource.
- Return type
datetime