WorkRequest

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

Bases: object

Many of the API requests you use to create and configure WAAS policies do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request.

OPERATION_TYPE_CREATE_CUSTOM_PROTECTION_RULE = 'CREATE_CUSTOM_PROTECTION_RULE'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of "CREATE_CUSTOM_PROTECTION_RULE"

OPERATION_TYPE_CREATE_WAAS_POLICY = 'CREATE_WAAS_POLICY'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of "CREATE_WAAS_POLICY"

OPERATION_TYPE_DELETE_CUSTOM_PROTECTION_RULE = 'DELETE_CUSTOM_PROTECTION_RULE'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of "DELETE_CUSTOM_PROTECTION_RULE"

OPERATION_TYPE_DELETE_WAAS_POLICY = 'DELETE_WAAS_POLICY'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of "DELETE_WAAS_POLICY"

OPERATION_TYPE_PURGE_WAAS_POLICY_CACHE = 'PURGE_WAAS_POLICY_CACHE'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of "PURGE_WAAS_POLICY_CACHE"

OPERATION_TYPE_UPDATE_CUSTOM_PROTECTION_RULE = 'UPDATE_CUSTOM_PROTECTION_RULE'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of "UPDATE_CUSTOM_PROTECTION_RULE"

OPERATION_TYPE_UPDATE_WAAS_POLICY = 'UPDATE_WAAS_POLICY'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of "UPDATE_WAAS_POLICY"

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_WAAS_POLICY", "UPDATE_WAAS_POLICY", "DELETE_WAAS_POLICY", "PURGE_WAAS_POLICY_CACHE", "CREATE_CUSTOM_PROTECTION_RULE", "UPDATE_CUSTOM_PROTECTION_RULE", "DELETE_CUSTOM_PROTECTION_RULE", '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 (int) -- The value to assign to the percent_complete property of this WorkRequest.
  • logs (list[WorkRequestLogEntry]) -- The value to assign to the logs property of this WorkRequest.
  • errors (list[WorkRequestError]) -- The value to assign to the errors 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
errors

Gets the errors of this WorkRequest. The list of errors that occurred while fulfilling the work request.

Returns:The errors of this WorkRequest.
Return type:list[WorkRequestError]
id

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

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

Gets the logs of this WorkRequest. The list of log entries from the work request workflow.

Returns:The logs of this WorkRequest.
Return type:list[WorkRequestLogEntry]
operation_type

[Required] Gets the operation_type of this WorkRequest. A description of the operation requested by the work request.

Allowed values for this property are: "CREATE_WAAS_POLICY", "UPDATE_WAAS_POLICY", "DELETE_WAAS_POLICY", "PURGE_WAAS_POLICY_CACHE", "CREATE_CUSTOM_PROTECTION_RULE", "UPDATE_CUSTOM_PROTECTION_RULE", "DELETE_CUSTOM_PROTECTION_RULE", '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

Gets the percent_complete of this WorkRequest. The percentage of work completed by the work request.

Returns:The percent_complete of this WorkRequest.
Return type:int
resources

Gets the resources of this WorkRequest. The resources being used to complete the work request operation.

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

[Required] Gets the status of this WorkRequest. The current 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 work request was created, in the format defined by RFC3339.

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

[Required] Gets the time_finished of this WorkRequest. The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format.

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

[Required] Gets the time_started of this WorkRequest. The date and time the work request moved from the ACCEPTED state to the IN_PROGRESS state, expressed in RFC 3339 timestamp format.

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