WorkRequestSummary¶
- class oci.apiaccesscontrol.models.WorkRequestSummary(**kwargs)¶
Bases:
objectSummary information about an asynchronous work request.
Attributes:
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
OPERATION_TYPE_CUSTOMER_APPROVAL_CHECK_PRIVILEGED_API_REQUESTA constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the operation_type property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
A constant which can be used with the status property of a WorkRequestSummary.
[Required] Gets the compartment_id of this WorkRequestSummary.
[Required] Gets the id of this WorkRequestSummary.
[Required] Gets the operation_type of this WorkRequestSummary.
[Required] Gets the percent_complete of this WorkRequestSummary.
[Required] Gets the resources of this WorkRequestSummary.
[Required] Gets the status of this WorkRequestSummary.
[Required] Gets the time_accepted of this WorkRequestSummary.
Gets the time_finished of this WorkRequestSummary.
Gets the time_started of this WorkRequestSummary.
Gets the time_updated of this WorkRequestSummary.
Methods:
__init__(**kwargs)Initializes a new WorkRequestSummary object with values from keyword arguments.
- OPERATION_TYPE_APPROVE_PRIVILEGED_API_REQUEST = 'APPROVE_PRIVILEGED_API_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “APPROVE_PRIVILEGED_API_REQUEST”
- OPERATION_TYPE_CANCEL_PRIVILEGED_API_WORK_REQUEST = 'CANCEL_PRIVILEGED_API_WORK_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CANCEL_PRIVILEGED_API_WORK_REQUEST”
- OPERATION_TYPE_CHECK_PRIVILEGED_API_REQUEST_STATUS = 'CHECK_PRIVILEGED_API_REQUEST_STATUS'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CHECK_PRIVILEGED_API_REQUEST_STATUS”
- OPERATION_TYPE_CLOSE_PRIVILEGED_API_REQUEST = 'CLOSE_PRIVILEGED_API_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CLOSE_PRIVILEGED_API_REQUEST”
- OPERATION_TYPE_CREATE_PRIVILEGED_API_CONTROL = 'CREATE_PRIVILEGED_API_CONTROL'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_PRIVILEGED_API_CONTROL”
- OPERATION_TYPE_CREATE_PRIVILEGED_API_REQUEST = 'CREATE_PRIVILEGED_API_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_PRIVILEGED_API_REQUEST”
- OPERATION_TYPE_CUSTOMER_APPROVAL_CHECK_PRIVILEGED_API_REQUEST = 'CUSTOMER_APPROVAL_CHECK_PRIVILEGED_API_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CUSTOMER_APPROVAL_CHECK_PRIVILEGED_API_REQUEST”
- OPERATION_TYPE_DELETE_PRIVILEGED_API_CONTROL = 'DELETE_PRIVILEGED_API_CONTROL'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “DELETE_PRIVILEGED_API_CONTROL”
- OPERATION_TYPE_GET_PRIVILEGED_API_CONTROL = 'GET_PRIVILEGED_API_CONTROL'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “GET_PRIVILEGED_API_CONTROL”
- OPERATION_TYPE_GET_PRIVILEGED_API_REQUEST = 'GET_PRIVILEGED_API_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “GET_PRIVILEGED_API_REQUEST”
- OPERATION_TYPE_GET_PRIVILEGED_API_WORK_REQUEST = 'GET_PRIVILEGED_API_WORK_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “GET_PRIVILEGED_API_WORK_REQUEST”
- OPERATION_TYPE_LIST_API_METADATA = 'LIST_API_METADATA'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “LIST_API_METADATA”
- OPERATION_TYPE_LIST_API_METADATA_BY_ENTITY_TYPE = 'LIST_API_METADATA_BY_ENTITY_TYPE'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “LIST_API_METADATA_BY_ENTITY_TYPE”
- OPERATION_TYPE_LIST_PRIVILEGED_API_CONTROL = 'LIST_PRIVILEGED_API_CONTROL'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “LIST_PRIVILEGED_API_CONTROL”
- OPERATION_TYPE_LIST_PRIVILEGED_API_REQUEST = 'LIST_PRIVILEGED_API_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “LIST_PRIVILEGED_API_REQUEST”
- OPERATION_TYPE_LIST_PRIVILEGED_API_WORK_REQUEST = 'LIST_PRIVILEGED_API_WORK_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “LIST_PRIVILEGED_API_WORK_REQUEST”
- OPERATION_TYPE_LIST_PRIVILEGED_API_WORK_REQUEST_ERRORS = 'LIST_PRIVILEGED_API_WORK_REQUEST_ERRORS'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “LIST_PRIVILEGED_API_WORK_REQUEST_ERRORS”
- OPERATION_TYPE_LIST_PRIVILEGED_API_WORK_REQUEST_LOGS = 'LIST_PRIVILEGED_API_WORK_REQUEST_LOGS'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “LIST_PRIVILEGED_API_WORK_REQUEST_LOGS”
- OPERATION_TYPE_MOVE_PRIVILEGED_API_CONTROL = 'MOVE_PRIVILEGED_API_CONTROL'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “MOVE_PRIVILEGED_API_CONTROL”
- OPERATION_TYPE_REJECT_PRIVILEGED_API_REQUEST = 'REJECT_PRIVILEGED_API_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “REJECT_PRIVILEGED_API_REQUEST”
- OPERATION_TYPE_REVOKE_PRIVILEGED_API_REQUEST = 'REVOKE_PRIVILEGED_API_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “REVOKE_PRIVILEGED_API_REQUEST”
- OPERATION_TYPE_TIMEOUT_PRIVILEGED_API_REQUEST = 'TIMEOUT_PRIVILEGED_API_REQUEST'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “TIMEOUT_PRIVILEGED_API_REQUEST”
- OPERATION_TYPE_UPDATE_PRIVILEGED_API_CONTROL = 'UPDATE_PRIVILEGED_API_CONTROL'¶
A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATE_PRIVILEGED_API_CONTROL”
- STATUS_ACCEPTED = 'ACCEPTED'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “ACCEPTED”
- STATUS_CANCELED = 'CANCELED'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “CANCELED”
- STATUS_CANCELING = 'CANCELING'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “CANCELING”
- STATUS_FAILED = 'FAILED'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “FAILED”
- STATUS_IN_PROGRESS = 'IN_PROGRESS'¶
A constant which can be used with the status property of a WorkRequestSummary. 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 WorkRequestSummary. This constant has a value of “NEEDS_ATTENTION”
- STATUS_SUCCEEDED = 'SUCCEEDED'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “SUCCEEDED”
- STATUS_WAITING = 'WAITING'¶
A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “WAITING”
- __init__(**kwargs)¶
Initializes a new WorkRequestSummary 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 WorkRequestSummary. Allowed values for this property are: “CREATE_PRIVILEGED_API_CONTROL”, “GET_PRIVILEGED_API_CONTROL”, “LIST_PRIVILEGED_API_CONTROL”, “UPDATE_PRIVILEGED_API_CONTROL”, “DELETE_PRIVILEGED_API_CONTROL”, “MOVE_PRIVILEGED_API_CONTROL”, “CREATE_PRIVILEGED_API_REQUEST”, “GET_PRIVILEGED_API_REQUEST”, “LIST_PRIVILEGED_API_REQUEST”, “APPROVE_PRIVILEGED_API_REQUEST”, “REJECT_PRIVILEGED_API_REQUEST”, “REVOKE_PRIVILEGED_API_REQUEST”, “CLOSE_PRIVILEGED_API_REQUEST”, “TIMEOUT_PRIVILEGED_API_REQUEST”, “CUSTOMER_APPROVAL_CHECK_PRIVILEGED_API_REQUEST”, “CHECK_PRIVILEGED_API_REQUEST_STATUS”, “GET_PRIVILEGED_API_WORK_REQUEST”, “LIST_PRIVILEGED_API_WORK_REQUEST”, “LIST_PRIVILEGED_API_WORK_REQUEST_ERRORS”, “LIST_PRIVILEGED_API_WORK_REQUEST_LOGS”, “CANCEL_PRIVILEGED_API_WORK_REQUEST”, “LIST_API_METADATA”, “LIST_API_METADATA_BY_ENTITY_TYPE”, ‘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 WorkRequestSummary. 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 WorkRequestSummary.
compartment_id (str) – The value to assign to the compartment_id property of this WorkRequestSummary.
resources (list[oci.apiaccesscontrol.models.WorkRequestResource]) – The value to assign to the resources property of this WorkRequestSummary.
percent_complete (float) – The value to assign to the percent_complete property of this WorkRequestSummary.
time_accepted (datetime) – The value to assign to the time_accepted property of this WorkRequestSummary.
time_started (datetime) – The value to assign to the time_started property of this WorkRequestSummary.
time_finished (datetime) – The value to assign to the time_finished property of this WorkRequestSummary.
time_updated (datetime) – The value to assign to the time_updated property of this WorkRequestSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this WorkRequestSummary. The OCID of the compartment that contains the work request.
- Returns
The compartment_id of this WorkRequestSummary.
- Return type
str
- property id¶
[Required] Gets the id of this WorkRequestSummary. The OCID of the work request.
- Returns
The id of this WorkRequestSummary.
- Return type
str
- property operation_type¶
[Required] Gets the operation_type of this WorkRequestSummary. The asynchronous operation tracked by this work request.
Allowed values for this property are: “CREATE_PRIVILEGED_API_CONTROL”, “GET_PRIVILEGED_API_CONTROL”, “LIST_PRIVILEGED_API_CONTROL”, “UPDATE_PRIVILEGED_API_CONTROL”, “DELETE_PRIVILEGED_API_CONTROL”, “MOVE_PRIVILEGED_API_CONTROL”, “CREATE_PRIVILEGED_API_REQUEST”, “GET_PRIVILEGED_API_REQUEST”, “LIST_PRIVILEGED_API_REQUEST”, “APPROVE_PRIVILEGED_API_REQUEST”, “REJECT_PRIVILEGED_API_REQUEST”, “REVOKE_PRIVILEGED_API_REQUEST”, “CLOSE_PRIVILEGED_API_REQUEST”, “TIMEOUT_PRIVILEGED_API_REQUEST”, “CUSTOMER_APPROVAL_CHECK_PRIVILEGED_API_REQUEST”, “CHECK_PRIVILEGED_API_REQUEST_STATUS”, “GET_PRIVILEGED_API_WORK_REQUEST”, “LIST_PRIVILEGED_API_WORK_REQUEST”, “LIST_PRIVILEGED_API_WORK_REQUEST_ERRORS”, “LIST_PRIVILEGED_API_WORK_REQUEST_LOGS”, “CANCEL_PRIVILEGED_API_WORK_REQUEST”, “LIST_API_METADATA”, “LIST_API_METADATA_BY_ENTITY_TYPE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The operation_type of this WorkRequestSummary.
- Return type
str
- property percent_complete¶
[Required] Gets the percent_complete of this WorkRequestSummary. Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed.
- Returns
The percent_complete of this WorkRequestSummary.
- Return type
float
- property resources¶
[Required] Gets the resources of this WorkRequestSummary. The resources that are affected by this work request.
- Returns
The resources of this WorkRequestSummary.
- Return type
- property status¶
[Required] Gets the status of this WorkRequestSummary. The status of the 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 WorkRequestSummary.
- Return type
str
- property time_accepted¶
[Required] Gets the time_accepted of this WorkRequestSummary. The date and time the work request was created, in the format defined by RFC 3339.
- Returns
The time_accepted of this WorkRequestSummary.
- Return type
datetime
- property time_finished¶
Gets the time_finished of this WorkRequestSummary. The date and time the work request was finished, in the format defined by RFC 3339.
- Returns
The time_finished of this WorkRequestSummary.
- Return type
datetime