WorkRequest

class oci.apigateway.models.WorkRequest(**kwargs)

Bases: object

A description of the work request status.

Attributes

OPERATION_TYPE_CREATE_DEPLOYMENT A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_CREATE_GATEWAY A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_DELETE_DEPLOYMENT A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_DELETE_GATEWAY A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_UPDATE_DEPLOYMENT A constant which can be used with the operation_type property of a WorkRequest.
OPERATION_TYPE_UPDATE_GATEWAY 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_CREATE_DEPLOYMENT = 'CREATE_DEPLOYMENT'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_DEPLOYMENT”

OPERATION_TYPE_CREATE_GATEWAY = 'CREATE_GATEWAY'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_GATEWAY”

OPERATION_TYPE_DELETE_DEPLOYMENT = 'DELETE_DEPLOYMENT'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_DEPLOYMENT”

OPERATION_TYPE_DELETE_GATEWAY = 'DELETE_GATEWAY'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_GATEWAY”

OPERATION_TYPE_UPDATE_DEPLOYMENT = 'UPDATE_DEPLOYMENT'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_DEPLOYMENT”

OPERATION_TYPE_UPDATE_GATEWAY = 'UPDATE_GATEWAY'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_GATEWAY”

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:
  • id (str) – The value to assign to the id property of this WorkRequest.
  • operation_type (str) – The value to assign to the operation_type property of this WorkRequest. Allowed values for this property are: “CREATE_GATEWAY”, “UPDATE_GATEWAY”, “DELETE_GATEWAY”, “CREATE_DEPLOYMENT”, “UPDATE_DEPLOYMENT”, “DELETE_DEPLOYMENT”, ‘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’.
  • compartment_id (str) – The value to assign to the compartment_id property of this WorkRequest.
  • resources (list[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 in which the resource is created.

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

[Required] Gets the id of this WorkRequest. The OCID of the resource.

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

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

Allowed values for this property are: “CREATE_GATEWAY”, “UPDATE_GATEWAY”, “DELETE_GATEWAY”, “CREATE_DEPLOYMENT”, “UPDATE_DEPLOYMENT”, “DELETE_DEPLOYMENT”, ‘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 this work request.

Returns:The resources of this WorkRequest.
Return type:list[WorkRequestResource]
status

[Required] Gets the status of this WorkRequest. 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 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 request 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