WorkRequest¶

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

Bases: object

A description of the work request status.

Attributes

`OPERATION_TYPE_ACCEPT_RECIPIENT_INVITATION`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_ACTIVATE_ORDER_EXISTING_TENANCY`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_ASSIGN_DEFAULT_SUBSCRIPTION`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_CANCEL_SENDER_INVITATION`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_COMPLETE_ORDER_ACTIVATION`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_CREATE_CHILD_TENANCY`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_CREATE_SENDER_INVITATION`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_HARD_TERMINATE_TENANCY`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_LOG_TENANCY_TERMINATION_REQUEST`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_MANUAL_LINK_CREATION`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_REGISTER_DOMAIN`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_RELEASE_DOMAIN`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_RESTORE_TENANCY`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_SELF_OPT_IN`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_SELF_OPT_OUT`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_SOFT_TERMINATE_TENANCY`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_TERMINATE_ORGANIZATION_TENANCY`	A constant which can be used with the operation_type property of a WorkRequest.
`OPERATION_TYPE_UPDATE_SAAS_CAPABILITY`	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_ACCEPT_RECIPIENT_INVITATION = 'ACCEPT_RECIPIENT_INVITATION'¶: A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “ACCEPT_RECIPIENT_INVITATION”

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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_SENDER_INVITATION”, “ACCEPT_RECIPIENT_INVITATION”, “CANCEL_SENDER_INVITATION”, “COMPLETE_ORDER_ACTIVATION”, “ACTIVATE_ORDER_EXISTING_TENANCY”, “REGISTER_DOMAIN”, “RELEASE_DOMAIN”, “CREATE_CHILD_TENANCY”, “ASSIGN_DEFAULT_SUBSCRIPTION”, “MANUAL_LINK_CREATION”, “TERMINATE_ORGANIZATION_TENANCY”, “UPDATE_SAAS_CAPABILITY”, “SOFT_TERMINATE_TENANCY”, “HARD_TERMINATE_TENANCY”, “RESTORE_TENANCY”, “LOG_TENANCY_TERMINATION_REQUEST”, “SELF_OPT_IN”, “SELF_OPT_OUT”, ‘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.tenant_manager_control_plane.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 ID of the work request.

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

operation_type¶

[Required] Gets the operation_type of this WorkRequest. Type of the work request.

Allowed values for this property are: “CREATE_SENDER_INVITATION”, “ACCEPT_RECIPIENT_INVITATION”, “CANCEL_SENDER_INVITATION”, “COMPLETE_ORDER_ACTIVATION”, “ACTIVATE_ORDER_EXISTING_TENANCY”, “REGISTER_DOMAIN”, “RELEASE_DOMAIN”, “CREATE_CHILD_TENANCY”, “ASSIGN_DEFAULT_SUBSCRIPTION”, “MANUAL_LINK_CREATION”, “TERMINATE_ORGANIZATION_TENANCY”, “UPDATE_SAAS_CAPABILITY”, “SOFT_TERMINATE_TENANCY”, “HARD_TERMINATE_TENANCY”, “RESTORE_TENANCY”, “LOG_TENANCY_TERMINATION_REQUEST”, “SELF_OPT_IN”, “SELF_OPT_OUT”, ‘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. Percentage of the request completed.

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

resources¶

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

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

status¶

[Required] Gets the status of this WorkRequest. Status of the 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 request was created, as described in RFC 3339, section 14.29.

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

time_finished¶

Gets the time_finished of this WorkRequest. The date and time the object was finished, as described in 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 request was started, as described in RFC 3339, section 14.29.

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