WorkRequest

class oci.oda.models.WorkRequest(**kwargs)

Bases: object

The description of work request, including its status.

Attributes

REQUEST_ACTION_CHANGE_ODA_INSTANCE_COMPARTMENT A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_CREATE_ASSOCIATION A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_CREATE_ODA_INSTANCE A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_DELETE_ASSOCIATION A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_DELETE_ODA_INSTANCE A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_LOOKUP_ODA_INSTANCES_FOR_CACCT A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_PURGE_ODA_INSTANCE A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_RECOVER_ODA_INSTANCE A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_START_ODA_INSTANCE A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_STOP_ODA_INSTANCE A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_UPDATE_ENTITLEMENTS_FOR_CACCT A constant which can be used with the request_action property of a WorkRequest.
REQUEST_ACTION_UPGRADE_ODA_INSTANCE A constant which can be used with the request_action 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 [Required] Gets the compartment_id of this WorkRequest.
id [Required] Gets the id of this WorkRequest.
oda_instance_id [Required] Gets the oda_instance_id of this WorkRequest.
percent_complete [Required] Gets the percent_complete of this WorkRequest.
request_action [Required] Gets the request_action of this WorkRequest.
resources [Required] Gets the resources of this WorkRequest.
status [Required] Gets the status of this WorkRequest.
status_message Gets the status_message of this WorkRequest.
time_accepted [Required] 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.
REQUEST_ACTION_CHANGE_ODA_INSTANCE_COMPARTMENT = 'CHANGE_ODA_INSTANCE_COMPARTMENT'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “CHANGE_ODA_INSTANCE_COMPARTMENT”

REQUEST_ACTION_CREATE_ASSOCIATION = 'CREATE_ASSOCIATION'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “CREATE_ASSOCIATION”

REQUEST_ACTION_CREATE_ODA_INSTANCE = 'CREATE_ODA_INSTANCE'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “CREATE_ODA_INSTANCE”

REQUEST_ACTION_DELETE_ASSOCIATION = 'DELETE_ASSOCIATION'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “DELETE_ASSOCIATION”

REQUEST_ACTION_DELETE_ODA_INSTANCE = 'DELETE_ODA_INSTANCE'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “DELETE_ODA_INSTANCE”

REQUEST_ACTION_LOOKUP_ODA_INSTANCES_FOR_CACCT = 'LOOKUP_ODA_INSTANCES_FOR_CACCT'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “LOOKUP_ODA_INSTANCES_FOR_CACCT”

REQUEST_ACTION_PURGE_ODA_INSTANCE = 'PURGE_ODA_INSTANCE'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “PURGE_ODA_INSTANCE”

REQUEST_ACTION_RECOVER_ODA_INSTANCE = 'RECOVER_ODA_INSTANCE'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “RECOVER_ODA_INSTANCE”

REQUEST_ACTION_START_ODA_INSTANCE = 'START_ODA_INSTANCE'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “START_ODA_INSTANCE”

REQUEST_ACTION_STOP_ODA_INSTANCE = 'STOP_ODA_INSTANCE'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “STOP_ODA_INSTANCE”

REQUEST_ACTION_UPDATE_ENTITLEMENTS_FOR_CACCT = 'UPDATE_ENTITLEMENTS_FOR_CACCT'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “UPDATE_ENTITLEMENTS_FOR_CACCT”

REQUEST_ACTION_UPGRADE_ODA_INSTANCE = 'UPGRADE_ODA_INSTANCE'

A constant which can be used with the request_action property of a WorkRequest. This constant has a value of “UPGRADE_ODA_INSTANCE”

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.
  • compartment_id (str) – The value to assign to the compartment_id property of this WorkRequest.
  • oda_instance_id (str) – The value to assign to the oda_instance_id property of this WorkRequest.
  • request_action (str) – The value to assign to the request_action property of this WorkRequest. Allowed values for this property are: “CREATE_ODA_INSTANCE”, “UPGRADE_ODA_INSTANCE”, “DELETE_ODA_INSTANCE”, “PURGE_ODA_INSTANCE”, “RECOVER_ODA_INSTANCE”, “STOP_ODA_INSTANCE”, “START_ODA_INSTANCE”, “CHANGE_ODA_INSTANCE_COMPARTMENT”, “CREATE_ASSOCIATION”, “DELETE_ASSOCIATION”, “UPDATE_ENTITLEMENTS_FOR_CACCT”, “LOOKUP_ODA_INSTANCES_FOR_CACCT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • status (str) – The value to assign to the status property of this WorkRequest. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • status_message (str) – The value to assign to the status_message property of this WorkRequest.
  • resources (list[WorkRequestResource]) – The value to assign to the resources property of this WorkRequest.
  • percent_complete (float) – The value to assign to the percent_complete 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.
compartment_id

[Required] Gets the compartment_id of this WorkRequest. The identifier of the compartment that contains the work request.

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

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

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

[Required] Gets the oda_instance_id of this WorkRequest. The identifier of the Digital Assistant instance to which this work request pertains.

Returns:The oda_instance_id of this WorkRequest.
Return type:str
percent_complete

[Required] Gets the percent_complete of this WorkRequest. Percentage of the request completed.

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

[Required] Gets the request_action of this WorkRequest. The type of the operation that’s associated with the work request.

Allowed values for this property are: “CREATE_ODA_INSTANCE”, “UPGRADE_ODA_INSTANCE”, “DELETE_ODA_INSTANCE”, “PURGE_ODA_INSTANCE”, “RECOVER_ODA_INSTANCE”, “STOP_ODA_INSTANCE”, “START_ODA_INSTANCE”, “CHANGE_ODA_INSTANCE_COMPARTMENT”, “CREATE_ASSOCIATION”, “DELETE_ASSOCIATION”, “UPDATE_ENTITLEMENTS_FOR_CACCT”, “LOOKUP_ODA_INSTANCES_FOR_CACCT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The request_action of this WorkRequest.
Return type:str
resources

[Required] Gets the resources of this WorkRequest. The resources that this work request affects.

Returns:The resources of this WorkRequest.
Return type:list[WorkRequestResource]
status

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

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “SUCCEEDED”, “FAILED”, “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
status_message

Gets the status_message of this WorkRequest. A short message that provides more detail about the current status. For example, if a work request fails, then this may include information about why it failed.

Returns:The status_message of this WorkRequest.
Return type:str
time_accepted

[Required] Gets the time_accepted of this WorkRequest. The date and time that the request was created, as described in RFC 3339, section 14.29.

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

Gets the time_finished of this WorkRequest. The date and time that the object finished, as described in RFC 3339. CKQ

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

Gets the time_started of this WorkRequest. The date and time that the request was started, as described in RFC 3339, CKQ section 14.29.

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