WorkRequest¶

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

Bases: object

An asynchronous work request.

Attributes

`OPERATION_TYPE_BACKUP_OPENSEARCH_CLUSTER`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_CONFIGURE_REMOTE_CLUSTER`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_CREATE_OPENSEARCH_CLUSTER`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_CREATE_OPENSEARCH_PIPELINE`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_DELETE_OPENSEARCH_CLUSTER`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_DELETE_OPENSEARCH_CLUSTER_BACKUP`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_DELETE_OPENSEARCH_PIPELINE`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_MOVE_OPENSEARCH_CLUSTER`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_MOVE_OPENSEARCH_CLUSTER_BACKUP`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_RESTORE_OPENSEARCH_CLUSTER`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_UPDATE_OPENSEARCH_CLUSTER`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_UPDATE_OPENSEARCH_CLUSTER_BACKUP`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_UPDATE_OPENSEARCH_CLUSTER_REVERSE_CONNECTION_ENDPOINTS`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_UPDATE_OPENSEARCH_CROSS_CLUSTER_CONFIG`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_UPDATE_OPENSEARCH_PIPELINE`	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_BACKUP_OPENSEARCH_CLUSTER = 'BACKUP_OPENSEARCH_CLUSTER'¶: A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “BACKUP_OPENSEARCH_CLUSTER”

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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_OPENSEARCH_CLUSTER”, “UPDATE_OPENSEARCH_CLUSTER”, “DELETE_OPENSEARCH_CLUSTER”, “MOVE_OPENSEARCH_CLUSTER”, “RESTORE_OPENSEARCH_CLUSTER”, “BACKUP_OPENSEARCH_CLUSTER”, “UPDATE_OPENSEARCH_CLUSTER_BACKUP”, “MOVE_OPENSEARCH_CLUSTER_BACKUP”, “DELETE_OPENSEARCH_CLUSTER_BACKUP”, “CREATE_OPENSEARCH_PIPELINE”, “UPDATE_OPENSEARCH_PIPELINE”, “DELETE_OPENSEARCH_PIPELINE”, “UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG”, “UPDATE_OPENSEARCH_CROSS_CLUSTER_CONFIG”, “UPDATE_OPENSEARCH_CLUSTER_REVERSE_CONNECTION_ENDPOINTS”, “CONFIGURE_REMOTE_CLUSTER”, ‘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.opensearch.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¶

[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

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 type of operation that spawned the work request.

Allowed values for this property are: “CREATE_OPENSEARCH_CLUSTER”, “UPDATE_OPENSEARCH_CLUSTER”, “DELETE_OPENSEARCH_CLUSTER”, “MOVE_OPENSEARCH_CLUSTER”, “RESTORE_OPENSEARCH_CLUSTER”, “BACKUP_OPENSEARCH_CLUSTER”, “UPDATE_OPENSEARCH_CLUSTER_BACKUP”, “MOVE_OPENSEARCH_CLUSTER_BACKUP”, “DELETE_OPENSEARCH_CLUSTER_BACKUP”, “CREATE_OPENSEARCH_PIPELINE”, “UPDATE_OPENSEARCH_PIPELINE”, “DELETE_OPENSEARCH_PIPELINE”, “UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG”, “UPDATE_OPENSEARCH_CROSS_CLUSTER_CONFIG”, “UPDATE_OPENSEARCH_CLUSTER_REVERSE_CONNECTION_ENDPOINTS”, “CONFIGURE_REMOTE_CLUSTER”, ‘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. The percentage complete of the operation tracked by the work request.

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

resources¶

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

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

status¶

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

time_accepted¶

[Required] Gets the time_accepted of this WorkRequest. The date and time the work request was created, in the format defined by 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 reached a terminal state, either FAILED or SUCCEEDED, in the format defined by 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 transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC 3339.

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