WorkRequest¶

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

Bases: object

A Data Flow work request object.

Attributes

`OPERATION_CREATE_PRIVATE_ENDPOINT`	A constant which can be used with the operation property of a WorkRequest.
`OPERATION_DELETE_PRIVATE_ENDPOINT`	A constant which can be used with the operation property of a WorkRequest.
`OPERATION_MOVE_PRIVATE_ENDPOINT`	A constant which can be used with the operation property of a WorkRequest.
`OPERATION_UPDATE_PRIVATE_ENDPOINT`	A constant which can be used with the operation property of a WorkRequest.
`STATUS_ACCEPTED`	A constant which can be used with the status property of a WorkRequest.
`STATUS_CANCELLED`	A constant which can be used with the status property of a WorkRequest.
`STATUS_CANCELLING`	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_INPROGRESS`	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`	[Required] Gets the operation 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`	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_CREATE_PRIVATE_ENDPOINT = 'CREATE_PRIVATE_ENDPOINT'¶: A constant which can be used with the operation property of a WorkRequest. This constant has a value of “CREATE_PRIVATE_ENDPOINT”

OPERATION_DELETE_PRIVATE_ENDPOINT = 'DELETE_PRIVATE_ENDPOINT'¶: A constant which can be used with the operation property of a WorkRequest. This constant has a value of “DELETE_PRIVATE_ENDPOINT”

OPERATION_MOVE_PRIVATE_ENDPOINT = 'MOVE_PRIVATE_ENDPOINT'¶: A constant which can be used with the operation property of a WorkRequest. This constant has a value of “MOVE_PRIVATE_ENDPOINT”

OPERATION_UPDATE_PRIVATE_ENDPOINT = 'UPDATE_PRIVATE_ENDPOINT'¶: A constant which can be used with the operation property of a WorkRequest. This constant has a value of “UPDATE_PRIVATE_ENDPOINT”

STATUS_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “ACCEPTED”

STATUS_CANCELLED = 'CANCELLED'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “CANCELLED”

STATUS_CANCELLING = 'CANCELLING'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “CANCELLING”

STATUS_FAILED = 'FAILED'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “FAILED”

STATUS_INPROGRESS = 'INPROGRESS'¶: A constant which can be used with the status property of a WorkRequest. This constant has a value of “INPROGRESS”

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:

compartment_id (str) – The value to assign to the compartment_id property of this WorkRequest.
id (str) – The value to assign to the id property of this WorkRequest.
operation (str) – The value to assign to the operation property of this WorkRequest. Allowed values for this property are: “CREATE_PRIVATE_ENDPOINT”, “UPDATE_PRIVATE_ENDPOINT”, “DELETE_PRIVATE_ENDPOINT”, “MOVE_PRIVATE_ENDPOINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
percent_complete (float) – The value to assign to the percent_complete property of this WorkRequest.
resources (list[oci.data_flow.models.WorkRequestResource]) – The value to assign to the resources property of this WorkRequest.
status (str) – The value to assign to the status property of this WorkRequest. Allowed values for this property are: “ACCEPTED”, “CANCELLED”, “CANCELLING”, “FAILED”, “INPROGRESS”, “SUCCEEDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
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 OCID of a compartment.

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

id¶

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

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

operation¶

[Required] Gets the operation of this WorkRequest. The operation related to this work request.

Allowed values for this property are: “CREATE_PRIVATE_ENDPOINT”, “UPDATE_PRIVATE_ENDPOINT”, “DELETE_PRIVATE_ENDPOINT”, “MOVE_PRIVATE_ENDPOINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The operation 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

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.data_flow.models.WorkRequestResource]

status¶

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

Allowed values for this property are: “ACCEPTED”, “CANCELLED”, “CANCELLING”, “FAILED”, “INPROGRESS”, “SUCCEEDED”, ‘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 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 the object 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 request was started, as described in RFC 3339, section 14.29.

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