WorkRequest

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

Bases: object

An object representing an asynchronous work flow.

Many of the API requests you use to create and configure connectors do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request.

Attributes:

OPERATION_TYPE_ACTIVATE_SERVICE_CONNECTOR	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_CREATE_SERVICE_CONNECTOR	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_DEACTIVATE_SERVICE_CONNECTOR	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_DELETE_SERVICE_CONNECTOR	A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_UPDATE_SERVICE_CONNECTOR	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	[Required] Gets the compartment_id of this WorkRequest.
id	[Required] Gets the id of this WorkRequest.
operation_type	[Required] Gets the operation_type of this WorkRequest.
percent_complete	[Required] Gets the percent_complete of this WorkRequest.
resources	[Required] Gets the resources of this WorkRequest.
status	[Required] Gets the status 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.

OPERATION_TYPE_ACTIVATE_SERVICE_CONNECTOR = 'ACTIVATE_SERVICE_CONNECTOR'

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

OPERATION_TYPE_CREATE_SERVICE_CONNECTOR = 'CREATE_SERVICE_CONNECTOR'

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

OPERATION_TYPE_DEACTIVATE_SERVICE_CONNECTOR = 'DEACTIVATE_SERVICE_CONNECTOR'

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

OPERATION_TYPE_DELETE_SERVICE_CONNECTOR = 'DELETE_SERVICE_CONNECTOR'

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

OPERATION_TYPE_UPDATE_SERVICE_CONNECTOR = 'UPDATE_SERVICE_CONNECTOR'

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

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

• operation_type (str) – The value to assign to the operation_type property of this WorkRequest. Allowed values for this property are: “CREATE_SERVICE_CONNECTOR”, “UPDATE_SERVICE_CONNECTOR”, “DELETE_SERVICE_CONNECTOR”, “ACTIVATE_SERVICE_CONNECTOR”, “DEACTIVATE_SERVICE_CONNECTOR”, ‘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”, “SUCCEEDED”, “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.sch.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.

property compartment_id

[Required] Gets the compartment_id of this WorkRequest. The OCID of the compartment containing the work request.

Returns

The compartment_id of this WorkRequest.

Return type

str

property id

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

Returns

The id of this WorkRequest.

Return type

str

property operation_type

[Required] Gets the operation_type of this WorkRequest. The type of action the work request represents.

Allowed values for this property are: “CREATE_SERVICE_CONNECTOR”, “UPDATE_SERVICE_CONNECTOR”, “DELETE_SERVICE_CONNECTOR”, “ACTIVATE_SERVICE_CONNECTOR”, “DEACTIVATE_SERVICE_CONNECTOR”, ‘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

property 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

property resources

[Required] Gets the resources of this WorkRequest. The resources affected by this work request.

Returns

The resources of this WorkRequest.

Return type

list[oci.sch.models.WorkRequestResource]

property status

[Required] Gets the status of this WorkRequest. Status of current 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

property time_accepted

[Required] Gets the time_accepted of this WorkRequest. The date and time when the request was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns

The time_accepted of this WorkRequest.

Return type

datetime

property time_finished

Gets the time_finished of this WorkRequest. The date and time when the object finished. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns

The time_finished of this WorkRequest.

Return type

datetime

property time_started

Gets the time_started of this WorkRequest. The date and time when the request was started. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns

The time_started of this WorkRequest.

Return type

datetime