WorkRequestSummary¶

class oci.waas.models.WorkRequestSummary(**kwargs)¶

Bases: object

The summarized details of a work request.

Attributes

`OPERATION_TYPE_CREATE_CUSTOM_PROTECTION_RULE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_CREATE_HTTP_REDIRECT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_CREATE_WAAS_POLICY`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_DELETE_CUSTOM_PROTECTION_RULE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_DELETE_HTTP_REDIRECT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_DELETE_WAAS_POLICY`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_PURGE_WAAS_POLICY_CACHE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_UPDATE_CUSTOM_PROTECTION_RULE`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_UPDATE_HTTP_REDIRECT`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`OPERATION_TYPE_UPDATE_WAAS_POLICY`	A constant which can be used with the operation_type property of a WorkRequestSummary.
`STATUS_ACCEPTED`	A constant which can be used with the status property of a WorkRequestSummary.
`STATUS_CANCELED`	A constant which can be used with the status property of a WorkRequestSummary.
`STATUS_CANCELING`	A constant which can be used with the status property of a WorkRequestSummary.
`STATUS_FAILED`	A constant which can be used with the status property of a WorkRequestSummary.
`STATUS_IN_PROGRESS`	A constant which can be used with the status property of a WorkRequestSummary.
`STATUS_SUCCEEDED`	A constant which can be used with the status property of a WorkRequestSummary.
`compartment_id`	[Required] Gets the compartment_id of this WorkRequestSummary.
`id`	[Required] Gets the id of this WorkRequestSummary.
`operation_type`	[Required] Gets the operation_type of this WorkRequestSummary.
`percent_complete`	Gets the percent_complete of this WorkRequestSummary.
`resources`	Gets the resources of this WorkRequestSummary.
`status`	[Required] Gets the status of this WorkRequestSummary.
`time_accepted`	[Required] Gets the time_accepted of this WorkRequestSummary.
`time_finished`	[Required] Gets the time_finished of this WorkRequestSummary.
`time_started`	[Required] Gets the time_started of this WorkRequestSummary.

Methods

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

OPERATION_TYPE_CREATE_CUSTOM_PROTECTION_RULE = 'CREATE_CUSTOM_PROTECTION_RULE'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_CUSTOM_PROTECTION_RULE”

OPERATION_TYPE_CREATE_HTTP_REDIRECT = 'CREATE_HTTP_REDIRECT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “CREATE_HTTP_REDIRECT”

OPERATION_TYPE_CREATE_WAAS_POLICY = 'CREATE_WAAS_POLICY'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. 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 WorkRequestSummary. This constant has a value of “DELETE_CUSTOM_PROTECTION_RULE”

OPERATION_TYPE_DELETE_HTTP_REDIRECT = 'DELETE_HTTP_REDIRECT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “DELETE_HTTP_REDIRECT”

OPERATION_TYPE_DELETE_WAAS_POLICY = 'DELETE_WAAS_POLICY'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. 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 WorkRequestSummary. 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 WorkRequestSummary. This constant has a value of “UPDATE_CUSTOM_PROTECTION_RULE”

OPERATION_TYPE_UPDATE_HTTP_REDIRECT = 'UPDATE_HTTP_REDIRECT'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATE_HTTP_REDIRECT”

OPERATION_TYPE_UPDATE_WAAS_POLICY = 'UPDATE_WAAS_POLICY'¶: A constant which can be used with the operation_type property of a WorkRequestSummary. This constant has a value of “UPDATE_WAAS_POLICY”

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_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the status property of a WorkRequestSummary. This constant has a value of “SUCCEEDED”

__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:

id (str) – The value to assign to the id property of this WorkRequestSummary.
operation_type (str) – The value to assign to the operation_type property of this WorkRequestSummary. Allowed values for this property are: “CREATE_WAAS_POLICY”, “UPDATE_WAAS_POLICY”, “DELETE_WAAS_POLICY”, “CREATE_HTTP_REDIRECT”, “UPDATE_HTTP_REDIRECT”, “DELETE_HTTP_REDIRECT”, “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 WorkRequestSummary. 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 WorkRequestSummary.
resources (list[oci.waas.models.WorkRequestResource]) – The value to assign to the resources property of this WorkRequestSummary.
percent_complete (int) – 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.

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

id¶

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

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

operation_type¶

[Required] Gets the operation_type of this WorkRequestSummary. 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”, “CREATE_HTTP_REDIRECT”, “UPDATE_HTTP_REDIRECT”, “DELETE_HTTP_REDIRECT”, “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 WorkRequestSummary.
Return type:	str

percent_complete¶

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

Returns:	The percent_complete of this WorkRequestSummary.
Return type:	int

resources¶

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

Returns:	The resources of this WorkRequestSummary.
Return type:	list[oci.waas.models.WorkRequestResource]

status¶

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

time_accepted¶

[Required] Gets the time_accepted of this WorkRequestSummary. The date and time the work request was created, expressed in RFC 3339 timestamp format.

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

time_finished¶

[Required] Gets the time_finished of this WorkRequestSummary. The date and time the work request was fulfilled or terminated, in the format defined by RFC3339.

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

time_started¶

[Required] Gets the time_started of this WorkRequestSummary. 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 WorkRequestSummary.
Return type:	datetime