WorkRequest¶

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

Bases: object

A description of workRequest status.

Attributes

`OPERATION_TYPE_COPY_OBJECT`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_REENCRYPT`	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_COMPLETED`	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.
`compartment_id`	Gets the compartment_id of this WorkRequest.
`id`	Gets the id of this WorkRequest.
`operation_type`	Gets the operation_type of this WorkRequest.
`percent_complete`	Gets the percent_complete of this WorkRequest.
`resources`	Gets the resources of this WorkRequest.
`status`	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_COPY_OBJECT = 'COPY_OBJECT'¶: A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “COPY_OBJECT”

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

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_COMPLETED = 'COMPLETED'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “COMPLETED”

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”

__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:

operation_type (str) – The value to assign to the operation_type property of this WorkRequest. Allowed values for this property are: “COPY_OBJECT”, “REENCRYPT”, ‘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”, “FAILED”, “COMPLETED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
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.
resources (list[oci.object_storage.models.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¶

Gets the compartment_id of this WorkRequest. The OCID of the compartment that contains the work request. Work requests are scoped to the same compartment as the resource the work request affects.

If the work request affects multiple resources and those resources are not in the same compartment, the OCID of the primary resource is used. For example, you can copy an object in a bucket in one compartment to a bucket in another compartment. In this case, the OCID of the source compartment is used.

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

id¶

Gets the id of this WorkRequest. The id of the work request.

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

operation_type¶

Gets the operation_type of this WorkRequest. The type of work request.

Allowed values for this property are: “COPY_OBJECT”, “REENCRYPT”, ‘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. Percentage of the work request completed.

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

resources¶

Gets the resources of this WorkRequest.

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

status¶

Gets the status of this WorkRequest. The status of the specified work request.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “COMPLETED”, “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. The date and time the work request was created, as described in RFC 3339.

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

time_finished¶

Gets the time_finished of this WorkRequest. The date and time the work request was finished, as described in RFC 3339.

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

time_started¶

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

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