WorkRequest¶
- class oci.datacc.models.WorkRequest(**kwargs)¶
Bases:
objectWork request details.
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 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.
[Required] Gets the compartment_id of this WorkRequest.
Gets the defined_tags of this WorkRequest.
Gets the freeform_tags of this WorkRequest.
[Required] Gets the id of this WorkRequest.
Gets the opc_request_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.
Gets the system_tags 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_ACTIVATE_BASE_INFRASTRUCTURE = 'ACTIVATE_BASE_INFRASTRUCTURE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “ACTIVATE_BASE_INFRASTRUCTURE”
- OPERATION_TYPE_ANALYZE_BASE_INFRA_NETWORK = 'ANALYZE_BASE_INFRA_NETWORK'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “ANALYZE_BASE_INFRA_NETWORK”
- OPERATION_TYPE_ANALYZE_INFRASTRUCTURE = 'ANALYZE_INFRASTRUCTURE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “ANALYZE_INFRASTRUCTURE”
- OPERATION_TYPE_CHANGE_BASE_INFRASTRUCTURE_COMPARTMENT = 'CHANGE_BASE_INFRASTRUCTURE_COMPARTMENT'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CHANGE_BASE_INFRASTRUCTURE_COMPARTMENT”
- OPERATION_TYPE_CHANGE_BASE_VM_CLUSTER_NETWORK_COMPARTMENT = 'CHANGE_BASE_VM_CLUSTER_NETWORK_COMPARTMENT'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CHANGE_BASE_VM_CLUSTER_NETWORK_COMPARTMENT”
- OPERATION_TYPE_CHANGE_INSTANCE_COMPARTMENT = 'CHANGE_INSTANCE_COMPARTMENT'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CHANGE_INSTANCE_COMPARTMENT”
- OPERATION_TYPE_CHANGE_SOFTWARE_IMAGE_COMPARTMENT = 'CHANGE_SOFTWARE_IMAGE_COMPARTMENT'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CHANGE_SOFTWARE_IMAGE_COMPARTMENT”
- OPERATION_TYPE_CREATE_BASE_INFRASTRUCTURE = 'CREATE_BASE_INFRASTRUCTURE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_BASE_INFRASTRUCTURE”
- OPERATION_TYPE_CREATE_BASE_INFRA_CAPACITY = 'CREATE_BASE_INFRA_CAPACITY'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_BASE_INFRA_CAPACITY”
- OPERATION_TYPE_CREATE_BASE_VM_CLUSTER_NETWORK = 'CREATE_BASE_VM_CLUSTER_NETWORK'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_BASE_VM_CLUSTER_NETWORK”
- OPERATION_TYPE_CREATE_INSTANCE = 'CREATE_INSTANCE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_INSTANCE”
- OPERATION_TYPE_CREATE_MAINTENANCE_RUN = 'CREATE_MAINTENANCE_RUN'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_MAINTENANCE_RUN”
- OPERATION_TYPE_DELETE_BASE_INFRASTRUCTURE = 'DELETE_BASE_INFRASTRUCTURE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_BASE_INFRASTRUCTURE”
- OPERATION_TYPE_DELETE_BASE_INFRA_CAPACITY = 'DELETE_BASE_INFRA_CAPACITY'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_BASE_INFRA_CAPACITY”
- OPERATION_TYPE_DELETE_BASE_VM_CLUSTER_NETWORK = 'DELETE_BASE_VM_CLUSTER_NETWORK'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_BASE_VM_CLUSTER_NETWORK”
- OPERATION_TYPE_DELETE_INSTANCE = 'DELETE_INSTANCE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_INSTANCE”
- OPERATION_TYPE_INFRASTRUCTURE_SCALE_STORAGE = 'INFRASTRUCTURE_SCALE_STORAGE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “INFRASTRUCTURE_SCALE_STORAGE”
- OPERATION_TYPE_INFRASTRUCTURE_SRE_VALIDATION = 'INFRASTRUCTURE_SRE_VALIDATION'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “INFRASTRUCTURE_SRE_VALIDATION”
- OPERATION_TYPE_MIGRATE_INSTANCE = 'MIGRATE_INSTANCE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “MIGRATE_INSTANCE”
- OPERATION_TYPE_RESCHEDULE_MAINTENANCE_RUN = 'RESCHEDULE_MAINTENANCE_RUN'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “RESCHEDULE_MAINTENANCE_RUN”
- OPERATION_TYPE_RESTART_BASE_VM = 'RESTART_BASE_VM'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “RESTART_BASE_VM”
- OPERATION_TYPE_RESTART_INSTANCE = 'RESTART_INSTANCE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “RESTART_INSTANCE”
- OPERATION_TYPE_SCALE_BASE_VM = 'SCALE_BASE_VM'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “SCALE_BASE_VM”
- OPERATION_TYPE_SCALE_INSTANCE = 'SCALE_INSTANCE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “SCALE_INSTANCE”
- OPERATION_TYPE_START_BASE_VM = 'START_BASE_VM'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “START_BASE_VM”
- OPERATION_TYPE_START_INSTANCE = 'START_INSTANCE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “START_INSTANCE”
- OPERATION_TYPE_STOP_BASE_VM = 'STOP_BASE_VM'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “STOP_BASE_VM”
- OPERATION_TYPE_STOP_INSTANCE = 'STOP_INSTANCE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “STOP_INSTANCE”
- OPERATION_TYPE_UPDATE_BASE_INFRASTRUCTURE = 'UPDATE_BASE_INFRASTRUCTURE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_BASE_INFRASTRUCTURE”
- OPERATION_TYPE_UPDATE_BASE_INFRASTRUCTURE_SOFTWARE = 'UPDATE_BASE_INFRASTRUCTURE_SOFTWARE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_BASE_INFRASTRUCTURE_SOFTWARE”
- OPERATION_TYPE_UPDATE_BASE_INFRA_CAPACITY = 'UPDATE_BASE_INFRA_CAPACITY'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_BASE_INFRA_CAPACITY”
- OPERATION_TYPE_UPDATE_BASE_VM_CLUSTER_NETWORK = 'UPDATE_BASE_VM_CLUSTER_NETWORK'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_BASE_VM_CLUSTER_NETWORK”
- OPERATION_TYPE_UPDATE_INSTANCE = 'UPDATE_INSTANCE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_INSTANCE”
- OPERATION_TYPE_UPDATE_MAINTENANCE_RUN = 'UPDATE_MAINTENANCE_RUN'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_MAINTENANCE_RUN”
- OPERATION_TYPE_UPDATE_SOFTWARE_IMAGE = 'UPDATE_SOFTWARE_IMAGE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_SOFTWARE_IMAGE”
- OPERATION_TYPE_VALIDATE_BASE_INFRASTRUCTURE = 'VALIDATE_BASE_INFRASTRUCTURE'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “VALIDATE_BASE_INFRASTRUCTURE”
- OPERATION_TYPE_VALIDATE_BASE_VM_CLUSTER_NETWORK = 'VALIDATE_BASE_VM_CLUSTER_NETWORK'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “VALIDATE_BASE_VM_CLUSTER_NETWORK”
- OPERATION_TYPE_VALIDATE_PROXY = 'VALIDATE_PROXY'¶
A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “VALIDATE_PROXY”
- 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
operation_type (str) – The value to assign to the operation_type property of this WorkRequest. Allowed values for this property are: “CREATE_INSTANCE”, “DELETE_INSTANCE”, “UPDATE_INSTANCE”, “CHANGE_INSTANCE_COMPARTMENT”, “CREATE_BASE_VM_CLUSTER_NETWORK”, “DELETE_BASE_VM_CLUSTER_NETWORK”, “VALIDATE_BASE_VM_CLUSTER_NETWORK”, “UPDATE_BASE_VM_CLUSTER_NETWORK”, “CHANGE_BASE_VM_CLUSTER_NETWORK_COMPARTMENT”, “START_BASE_VM”, “STOP_BASE_VM”, “START_INSTANCE”, “STOP_INSTANCE”, “SCALE_INSTANCE”, “RESTART_INSTANCE”, “RESTART_BASE_VM”, “MIGRATE_INSTANCE”, “SCALE_BASE_VM”, “UPDATE_SOFTWARE_IMAGE”, “CHANGE_SOFTWARE_IMAGE_COMPARTMENT”, “VALIDATE_PROXY”, “CREATE_BASE_INFRA_CAPACITY”, “UPDATE_BASE_INFRA_CAPACITY”, “DELETE_BASE_INFRA_CAPACITY”, “ACTIVATE_BASE_INFRASTRUCTURE”, “CREATE_BASE_INFRASTRUCTURE”, “DELETE_BASE_INFRASTRUCTURE”, “UPDATE_BASE_INFRASTRUCTURE”, “UPDATE_BASE_INFRASTRUCTURE_SOFTWARE”, “VALIDATE_BASE_INFRASTRUCTURE”, “CHANGE_BASE_INFRASTRUCTURE_COMPARTMENT”, “ANALYZE_INFRASTRUCTURE”, “ANALYZE_BASE_INFRA_NETWORK”, “INFRASTRUCTURE_SRE_VALIDATION”, “CREATE_MAINTENANCE_RUN”, “UPDATE_MAINTENANCE_RUN”, “RESCHEDULE_MAINTENANCE_RUN”, “INFRASTRUCTURE_SCALE_STORAGE”, ‘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.
resources (list[oci.datacc.models.WorkRequestResource]) – The value to assign to the resources property of this WorkRequest.
opc_request_id (str) – The value to assign to the opc_request_id 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.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this WorkRequest.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this WorkRequest.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this WorkRequest.
- property compartment_id¶
[Required] Gets the compartment_id of this WorkRequest. OCID of the compartment that contains the work request.
- Returns
The compartment_id of this WorkRequest.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this WorkRequest. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this WorkRequest.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
Gets the freeform_tags of this WorkRequest. Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this WorkRequest.
- Return type
dict(str, 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 opc_request_id¶
Gets the opc_request_id of this WorkRequest. opc-request-id of the request that triggered the work request.
- Returns
The opc_request_id of this WorkRequest.
- Return type
str
- property operation_type¶
[Required] Gets the operation_type of this WorkRequest. Type of the work request.
Allowed values for this property are: “CREATE_INSTANCE”, “DELETE_INSTANCE”, “UPDATE_INSTANCE”, “CHANGE_INSTANCE_COMPARTMENT”, “CREATE_BASE_VM_CLUSTER_NETWORK”, “DELETE_BASE_VM_CLUSTER_NETWORK”, “VALIDATE_BASE_VM_CLUSTER_NETWORK”, “UPDATE_BASE_VM_CLUSTER_NETWORK”, “CHANGE_BASE_VM_CLUSTER_NETWORK_COMPARTMENT”, “START_BASE_VM”, “STOP_BASE_VM”, “START_INSTANCE”, “STOP_INSTANCE”, “SCALE_INSTANCE”, “RESTART_INSTANCE”, “RESTART_BASE_VM”, “MIGRATE_INSTANCE”, “SCALE_BASE_VM”, “UPDATE_SOFTWARE_IMAGE”, “CHANGE_SOFTWARE_IMAGE_COMPARTMENT”, “VALIDATE_PROXY”, “CREATE_BASE_INFRA_CAPACITY”, “UPDATE_BASE_INFRA_CAPACITY”, “DELETE_BASE_INFRA_CAPACITY”, “ACTIVATE_BASE_INFRASTRUCTURE”, “CREATE_BASE_INFRASTRUCTURE”, “DELETE_BASE_INFRASTRUCTURE”, “UPDATE_BASE_INFRASTRUCTURE”, “UPDATE_BASE_INFRASTRUCTURE_SOFTWARE”, “VALIDATE_BASE_INFRASTRUCTURE”, “CHANGE_BASE_INFRASTRUCTURE_COMPARTMENT”, “ANALYZE_INFRASTRUCTURE”, “ANALYZE_BASE_INFRA_NETWORK”, “INFRASTRUCTURE_SRE_VALIDATION”, “CREATE_MAINTENANCE_RUN”, “UPDATE_MAINTENANCE_RUN”, “RESCHEDULE_MAINTENANCE_RUN”, “INFRASTRUCTURE_SCALE_STORAGE”, ‘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 the work request.
- Returns
The resources of this WorkRequest.
- Return type
- 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”, “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
- property system_tags¶
Gets the system_tags of this WorkRequest. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } }
- Returns
The system_tags of this WorkRequest.
- Return type
dict(str, dict(str, object))
- property time_accepted¶
[Required] Gets the time_accepted of this WorkRequest. The date and time that the request was created, as described in RFC 3339, section 14.29.
- Returns
The time_accepted of this WorkRequest.
- Return type
datetime