IamWorkRequest¶

class oci.identity.models.IamWorkRequest(**kwargs)¶

Bases: object

(For tenancies that support identity domains) An IAM work request object that allows users to track the status of asynchronous API requests.

Attributes

`OPERATION_TYPE_ACTIVATE_DOMAIN`	A constant which can be used with the operation_type property of a IamWorkRequest.
`OPERATION_TYPE_CHANGE_COMPARTMENT_FOR_DOMAIN`	A constant which can be used with the operation_type property of a IamWorkRequest.
`OPERATION_TYPE_CHANGE_LICENSE_TYPE_FOR_DOMAIN`	A constant which can be used with the operation_type property of a IamWorkRequest.
`OPERATION_TYPE_CREATE_DOMAIN`	A constant which can be used with the operation_type property of a IamWorkRequest.
`OPERATION_TYPE_DEACTIVATE_DOMAIN`	A constant which can be used with the operation_type property of a IamWorkRequest.
`OPERATION_TYPE_DELETE_DOMAIN`	A constant which can be used with the operation_type property of a IamWorkRequest.
`OPERATION_TYPE_REPLICATE_DOMAIN_TO_REGION`	A constant which can be used with the operation_type property of a IamWorkRequest.
`OPERATION_TYPE_UPDATE_DOMAIN`	A constant which can be used with the operation_type property of a IamWorkRequest.
`STATUS_ACCEPTED`	A constant which can be used with the status property of a IamWorkRequest.
`STATUS_CANCELED`	A constant which can be used with the status property of a IamWorkRequest.
`STATUS_CANCELING`	A constant which can be used with the status property of a IamWorkRequest.
`STATUS_FAILED`	A constant which can be used with the status property of a IamWorkRequest.
`STATUS_IN_PROGRESS`	A constant which can be used with the status property of a IamWorkRequest.
`STATUS_SUCCEEDED`	A constant which can be used with the status property of a IamWorkRequest.
`compartment_id`	Gets the compartment_id of this IamWorkRequest.
`id`	[Required] Gets the id of this IamWorkRequest.
`operation_type`	[Required] Gets the operation_type of this IamWorkRequest.
`percent_complete`	Gets the percent_complete of this IamWorkRequest.
`resources`	Gets the resources of this IamWorkRequest.
`status`	[Required] Gets the status of this IamWorkRequest.
`time_accepted`	Gets the time_accepted of this IamWorkRequest.
`time_finished`	Gets the time_finished of this IamWorkRequest.
`time_started`	Gets the time_started of this IamWorkRequest.

Methods

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

OPERATION_TYPE_ACTIVATE_DOMAIN = 'ACTIVATE_DOMAIN'¶: A constant which can be used with the operation_type property of a IamWorkRequest. This constant has a value of “ACTIVATE_DOMAIN”

OPERATION_TYPE_CHANGE_COMPARTMENT_FOR_DOMAIN = 'CHANGE_COMPARTMENT_FOR_DOMAIN'¶: A constant which can be used with the operation_type property of a IamWorkRequest. This constant has a value of “CHANGE_COMPARTMENT_FOR_DOMAIN”

OPERATION_TYPE_CHANGE_LICENSE_TYPE_FOR_DOMAIN = 'CHANGE_LICENSE_TYPE_FOR_DOMAIN'¶: A constant which can be used with the operation_type property of a IamWorkRequest. This constant has a value of “CHANGE_LICENSE_TYPE_FOR_DOMAIN”

OPERATION_TYPE_CREATE_DOMAIN = 'CREATE_DOMAIN'¶: A constant which can be used with the operation_type property of a IamWorkRequest. This constant has a value of “CREATE_DOMAIN”

OPERATION_TYPE_DEACTIVATE_DOMAIN = 'DEACTIVATE_DOMAIN'¶: A constant which can be used with the operation_type property of a IamWorkRequest. This constant has a value of “DEACTIVATE_DOMAIN”

OPERATION_TYPE_DELETE_DOMAIN = 'DELETE_DOMAIN'¶: A constant which can be used with the operation_type property of a IamWorkRequest. This constant has a value of “DELETE_DOMAIN”

OPERATION_TYPE_REPLICATE_DOMAIN_TO_REGION = 'REPLICATE_DOMAIN_TO_REGION'¶: A constant which can be used with the operation_type property of a IamWorkRequest. This constant has a value of “REPLICATE_DOMAIN_TO_REGION”

OPERATION_TYPE_UPDATE_DOMAIN = 'UPDATE_DOMAIN'¶: A constant which can be used with the operation_type property of a IamWorkRequest. This constant has a value of “UPDATE_DOMAIN”

STATUS_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the status property of a IamWorkRequest. This constant has a value of “ACCEPTED”

STATUS_CANCELED = 'CANCELED'¶: A constant which can be used with the status property of a IamWorkRequest. This constant has a value of “CANCELED”

STATUS_CANCELING = 'CANCELING'¶: A constant which can be used with the status property of a IamWorkRequest. This constant has a value of “CANCELING”

STATUS_FAILED = 'FAILED'¶: A constant which can be used with the status property of a IamWorkRequest. This constant has a value of “FAILED”

STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the status property of a IamWorkRequest. This constant has a value of “IN_PROGRESS”

STATUS_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the status property of a IamWorkRequest. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new IamWorkRequest object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this IamWorkRequest.
operation_type (str) – The value to assign to the operation_type property of this IamWorkRequest. Allowed values for this property are: “CREATE_DOMAIN”, “REPLICATE_DOMAIN_TO_REGION”, “UPDATE_DOMAIN”, “ACTIVATE_DOMAIN”, “DEACTIVATE_DOMAIN”, “DELETE_DOMAIN”, “CHANGE_COMPARTMENT_FOR_DOMAIN”, “CHANGE_LICENSE_TYPE_FOR_DOMAIN”, ‘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 IamWorkRequest. 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’.
compartment_id (str) – The value to assign to the compartment_id property of this IamWorkRequest.
resources (list[oci.identity.models.IamWorkRequestResource]) – The value to assign to the resources property of this IamWorkRequest.
percent_complete (float) – The value to assign to the percent_complete property of this IamWorkRequest.
time_accepted (datetime) – The value to assign to the time_accepted property of this IamWorkRequest.
time_started (datetime) – The value to assign to the time_started property of this IamWorkRequest.
time_finished (datetime) – The value to assign to the time_finished property of this IamWorkRequest.

compartment_id¶

Gets the compartment_id of this IamWorkRequest. The OCID of the compartment containing this IAM work request.

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

id¶

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

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

operation_type¶

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

Allowed values for this property are: “CREATE_DOMAIN”, “REPLICATE_DOMAIN_TO_REGION”, “UPDATE_DOMAIN”, “ACTIVATE_DOMAIN”, “DEACTIVATE_DOMAIN”, “DELETE_DOMAIN”, “CHANGE_COMPARTMENT_FOR_DOMAIN”, “CHANGE_LICENSE_TYPE_FOR_DOMAIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The operation_type of this IamWorkRequest.
Return type:	str

percent_complete¶

Gets the percent_complete of this IamWorkRequest. How much progress the operation has made.

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

resources¶

Gets the resources of this IamWorkRequest. The resources this work request affects.

Returns:	The resources of this IamWorkRequest.
Return type:	list[oci.identity.models.IamWorkRequestResource]

status¶

[Required] Gets the status of this IamWorkRequest. The status of the 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 IamWorkRequest.
Return type:	str

time_accepted¶

Gets the time_accepted of this IamWorkRequest. Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_accepted of this IamWorkRequest.
Return type:	datetime

time_finished¶

Gets the time_finished of this IamWorkRequest. Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

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

time_started¶

Gets the time_started of this IamWorkRequest. Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

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