WorkRequest¶

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

Bases: object

An asynchronous work request.

Attributes

`OPERATION_TYPE_EXECUTE_SQL`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_EXECUTE_SQL_SCHEDULED_DELETION`	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.
`STATUS_WAITING`	A constant which can be used with the status property of a WorkRequest.
`compartment_id`	[Required] Gets the compartment_id of this WorkRequest.
`created_by_principal_domain_id`	Gets the created_by_principal_domain_id of this WorkRequest.
`created_by_principal_id`	Gets the created_by_principal_id of this WorkRequest.
`display_name`	Gets the display_name 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_scheduled`	Gets the time_scheduled of this WorkRequest.
`time_started`	Gets the time_started of this WorkRequest.
`time_updated`	Gets the time_updated of this WorkRequest.

Methods

__init__(**kwargs) Initializes a new WorkRequest object with values from keyword arguments.

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

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

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”

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

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

display_name (str) – The value to assign to the display_name property of this WorkRequest.
operation_type (str) – The value to assign to the operation_type property of this WorkRequest. Allowed values for this property are: “EXECUTE_SQL”, “EXECUTE_SQL_SCHEDULED_DELETION”, ‘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”, “WAITING”, ‘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.
created_by_principal_id (str) – The value to assign to the created_by_principal_id property of this WorkRequest.
created_by_principal_domain_id (str) – The value to assign to the created_by_principal_domain_id property of this WorkRequest.
resources (list[oci.database_tools_runtime.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.
time_updated (datetime) – The value to assign to the time_updated property of this WorkRequest.
time_scheduled (datetime) – The value to assign to the time_scheduled property of this WorkRequest.

compartment_id¶

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

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

created_by_principal_domain_id¶

Gets the created_by_principal_domain_id of this WorkRequest. Identity domain OCID for the user that submitted the asynchronous request.

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

created_by_principal_id¶

Gets the created_by_principal_id of this WorkRequest. Principal id of the user or resource that submitted the asynchrounous request.

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

display_name¶

Gets the display_name of this WorkRequest. A user-friendly name for the operation. If provided for an asynchronous operation, this value will be propagated to the displayName property of the resulting Work Request, allowing for easier identification and tracking of the operation’s progress and outcome. This name is purely for descriptive purposes and does not affect the functionality of the operation itself.

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

id¶

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

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

operation_type¶

[Required] Gets the operation_type of this WorkRequest. The asynchronous operation tracked by this work request.

Allowed values for this property are: “EXECUTE_SQL”, “EXECUTE_SQL_SCHEDULED_DELETION”, ‘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¶

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

status¶

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

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, “WAITING”, ‘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¶

[Required] Gets the time_accepted of this WorkRequest. The date and time the work request was created, in the format defined by RFC3339.

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 reached a terminal state, either FAILED or SUCCEEDED. Format is defined by RFC3339.

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

time_scheduled¶

Gets the time_scheduled of this WorkRequest. The date and time the work request is eligible to be launched, in the format defined by RFC3339.

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

time_started¶

Gets the time_started of this WorkRequest. The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC3339.

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

time_updated¶

Gets the time_updated of this WorkRequest. The date and time the work request was last updated, in the format defined by RFC3339.

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