WorkRequest¶
- class oci.redis.models.WorkRequest(**kwargs)¶
Bases:
objectAn asynchronous work request.
Attributes:
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the operation_type property of a WorkRequest.
A constant which can be used with the status property of a WorkRequest.
A constant which can be used with the status property of a WorkRequest.
A constant which can be used with the status property of a WorkRequest.
A constant which can be used with the status property of a WorkRequest.
A constant which can be used with the status property of a WorkRequest.
A constant which can be used with the status property of a WorkRequest.
A constant which can be used with the status property of a WorkRequest.
A constant which can be used with the status property of a WorkRequest.
[Required] Gets the compartment_id of this WorkRequest.
[Required] Gets the id of this WorkRequest.
[Required] Gets the operation_type of this WorkRequest.
[Required] Gets the percent_complete of this WorkRequest.
[Required] Gets the resources of this WorkRequest.
[Required] Gets the status of this WorkRequest.
[Required] Gets the time_accepted of this WorkRequest.
Gets the time_finished of this WorkRequest.
Gets the time_started of this WorkRequest.
Methods:
__init__(**kwargs)Initializes a new WorkRequest object with values from keyword arguments.
- OPERATION_TYPE_ATTACH_OCI_CACHE_USERS = 'ATTACH_OCI_CACHE_USERS'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “ATTACH_OCI_CACHE_USERS”
- OPERATION_TYPE_CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT = 'CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT”
- OPERATION_TYPE_CHANGE_OCI_CACHE_USER_COMPARTMENT = 'CHANGE_OCI_CACHE_USER_COMPARTMENT'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CHANGE_OCI_CACHE_USER_COMPARTMENT”
- OPERATION_TYPE_CHANGE_ROLE_TO_SECONDARY = 'CHANGE_ROLE_TO_SECONDARY'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CHANGE_ROLE_TO_SECONDARY”
- OPERATION_TYPE_CLUSTER_ROLLBACK = 'CLUSTER_ROLLBACK'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CLUSTER_ROLLBACK”
- OPERATION_TYPE_CONVERT_TO_SECONDARY_CLUSTER = 'CONVERT_TO_SECONDARY_CLUSTER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CONVERT_TO_SECONDARY_CLUSTER”
- OPERATION_TYPE_CONVERT_TO_STANDALONE_CLUSTER = 'CONVERT_TO_STANDALONE_CLUSTER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CONVERT_TO_STANDALONE_CLUSTER”
- OPERATION_TYPE_CREATE_OCI_CACHE_BACKUP = 'CREATE_OCI_CACHE_BACKUP'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_OCI_CACHE_BACKUP”
- OPERATION_TYPE_CREATE_OCI_CACHE_CONFIG_SET = 'CREATE_OCI_CACHE_CONFIG_SET'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_OCI_CACHE_CONFIG_SET”
- OPERATION_TYPE_CREATE_OCI_CACHE_USER = 'CREATE_OCI_CACHE_USER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_OCI_CACHE_USER”
- OPERATION_TYPE_CREATE_REDIS_CLUSTER = 'CREATE_REDIS_CLUSTER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_REDIS_CLUSTER”
- OPERATION_TYPE_CREATE_REDIS_CONFIG_SET = 'CREATE_REDIS_CONFIG_SET'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_REDIS_CONFIG_SET”
- OPERATION_TYPE_DELETE_OCI_CACHE_BACKUP = 'DELETE_OCI_CACHE_BACKUP'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_OCI_CACHE_BACKUP”
- OPERATION_TYPE_DELETE_OCI_CACHE_CONFIG_SET = 'DELETE_OCI_CACHE_CONFIG_SET'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_OCI_CACHE_CONFIG_SET”
- OPERATION_TYPE_DELETE_OCI_CACHE_USER = 'DELETE_OCI_CACHE_USER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_OCI_CACHE_USER”
- OPERATION_TYPE_DELETE_REDIS_CLUSTER = 'DELETE_REDIS_CLUSTER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_REDIS_CLUSTER”
- OPERATION_TYPE_DELETE_REDIS_CONFIG_SET = 'DELETE_REDIS_CONFIG_SET'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_REDIS_CONFIG_SET”
- OPERATION_TYPE_DETACH_OCI_CACHE_USERS = 'DETACH_OCI_CACHE_USERS'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DETACH_OCI_CACHE_USERS”
- OPERATION_TYPE_EXPORT_OCI_CACHE_BACKUP_TO_OS = 'EXPORT_OCI_CACHE_BACKUP_TO_OS'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “EXPORT_OCI_CACHE_BACKUP_TO_OS”
- OPERATION_TYPE_FAILOVER_REDIS_CLUSTER = 'FAILOVER_REDIS_CLUSTER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “FAILOVER_REDIS_CLUSTER”
- OPERATION_TYPE_MIGRATE_CLUSTER = 'MIGRATE_CLUSTER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “MIGRATE_CLUSTER”
- OPERATION_TYPE_MOVE_OCI_CACHE_BACKUP = 'MOVE_OCI_CACHE_BACKUP'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “MOVE_OCI_CACHE_BACKUP”
- OPERATION_TYPE_MOVE_REDIS_CLUSTER = 'MOVE_REDIS_CLUSTER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “MOVE_REDIS_CLUSTER”
- OPERATION_TYPE_MOVE_REDIS_CONFIG_SET = 'MOVE_REDIS_CONFIG_SET'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “MOVE_REDIS_CONFIG_SET”
- OPERATION_TYPE_PATCH_OCI_CACHE_CLUSTER = 'PATCH_OCI_CACHE_CLUSTER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “PATCH_OCI_CACHE_CLUSTER”
- OPERATION_TYPE_REPLACE_OCI_CACHE_NODE = 'REPLACE_OCI_CACHE_NODE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “REPLACE_OCI_CACHE_NODE”
- OPERATION_TYPE_ROLLBACK_CRR_SETUP = 'ROLLBACK_CRR_SETUP'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “ROLLBACK_CRR_SETUP”
- OPERATION_TYPE_SETUP_CRR = 'SETUP_CRR'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “SETUP_CRR”
- OPERATION_TYPE_SWITCHOVER = 'SWITCHOVER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “SWITCHOVER”
- OPERATION_TYPE_UPDATE_OCI_CACHE_BACKUP = 'UPDATE_OCI_CACHE_BACKUP'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_OCI_CACHE_BACKUP”
- OPERATION_TYPE_UPDATE_OCI_CACHE_CONFIG_SET = 'UPDATE_OCI_CACHE_CONFIG_SET'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_OCI_CACHE_CONFIG_SET”
- OPERATION_TYPE_UPDATE_OCI_CACHE_USER = 'UPDATE_OCI_CACHE_USER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_OCI_CACHE_USER”
- OPERATION_TYPE_UPDATE_REDIS_CLUSTER = 'UPDATE_REDIS_CLUSTER'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_REDIS_CLUSTER”
- OPERATION_TYPE_UPDATE_REDIS_CONFIG_SET = 'UPDATE_REDIS_CONFIG_SET'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_REDIS_CONFIG_SET”
- 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_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the status property of a WorkRequest. This constant has a value of “NEEDS_ATTENTION”
- 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
operation_type (str) – The value to assign to the operation_type property of this WorkRequest. Allowed values for this property are: “CREATE_REDIS_CLUSTER”, “UPDATE_REDIS_CLUSTER”, “DELETE_REDIS_CLUSTER”, “MOVE_REDIS_CLUSTER”, “FAILOVER_REDIS_CLUSTER”, “CREATE_REDIS_CONFIG_SET”, “UPDATE_REDIS_CONFIG_SET”, “DELETE_REDIS_CONFIG_SET”, “MOVE_REDIS_CONFIG_SET”, “MIGRATE_CLUSTER”, “CLUSTER_ROLLBACK”, “ATTACH_OCI_CACHE_USERS”, “DETACH_OCI_CACHE_USERS”, “CREATE_OCI_CACHE_USER”, “UPDATE_OCI_CACHE_USER”, “DELETE_OCI_CACHE_USER”, “CREATE_OCI_CACHE_CONFIG_SET”, “UPDATE_OCI_CACHE_CONFIG_SET”, “DELETE_OCI_CACHE_CONFIG_SET”, “CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT”, “CHANGE_OCI_CACHE_USER_COMPARTMENT”, “CREATE_OCI_CACHE_BACKUP”, “UPDATE_OCI_CACHE_BACKUP”, “DELETE_OCI_CACHE_BACKUP”, “MOVE_OCI_CACHE_BACKUP”, “EXPORT_OCI_CACHE_BACKUP_TO_OS”, “PATCH_OCI_CACHE_CLUSTER”, “REPLACE_OCI_CACHE_NODE”, “CONVERT_TO_SECONDARY_CLUSTER”, “CONVERT_TO_STANDALONE_CLUSTER”, “ROLLBACK_CRR_SETUP”, “SWITCHOVER”, “SETUP_CRR”, “CHANGE_ROLE_TO_SECONDARY”, ‘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”, “WAITING”, “NEEDS_ATTENTION”, “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.redis.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 that contains 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 operation that spawned the work request.
Allowed values for this property are: “CREATE_REDIS_CLUSTER”, “UPDATE_REDIS_CLUSTER”, “DELETE_REDIS_CLUSTER”, “MOVE_REDIS_CLUSTER”, “FAILOVER_REDIS_CLUSTER”, “CREATE_REDIS_CONFIG_SET”, “UPDATE_REDIS_CONFIG_SET”, “DELETE_REDIS_CONFIG_SET”, “MOVE_REDIS_CONFIG_SET”, “MIGRATE_CLUSTER”, “CLUSTER_ROLLBACK”, “ATTACH_OCI_CACHE_USERS”, “DETACH_OCI_CACHE_USERS”, “CREATE_OCI_CACHE_USER”, “UPDATE_OCI_CACHE_USER”, “DELETE_OCI_CACHE_USER”, “CREATE_OCI_CACHE_CONFIG_SET”, “UPDATE_OCI_CACHE_CONFIG_SET”, “DELETE_OCI_CACHE_CONFIG_SET”, “CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT”, “CHANGE_OCI_CACHE_USER_COMPARTMENT”, “CREATE_OCI_CACHE_BACKUP”, “UPDATE_OCI_CACHE_BACKUP”, “DELETE_OCI_CACHE_BACKUP”, “MOVE_OCI_CACHE_BACKUP”, “EXPORT_OCI_CACHE_BACKUP_TO_OS”, “PATCH_OCI_CACHE_CLUSTER”, “REPLACE_OCI_CACHE_NODE”, “CONVERT_TO_SECONDARY_CLUSTER”, “CONVERT_TO_STANDALONE_CLUSTER”, “ROLLBACK_CRR_SETUP”, “SWITCHOVER”, “SETUP_CRR”, “CHANGE_ROLE_TO_SECONDARY”, ‘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. The percentage complete of the operation tracked by the work request.
- Returns
The percent_complete of this WorkRequest.
- Return type
float
- property 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
- property status¶
[Required] Gets the status of this WorkRequest. The status of current work request.
Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “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 the work request was created, in the format defined by RFC 3339.
- Returns
The time_accepted of this WorkRequest.
- Return type
datetime