WorkRequest¶

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

Bases: object

Many of the API requests you use to create and configure load balancing 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.

Attributes

`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a WorkRequest.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a WorkRequest.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a WorkRequest.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a WorkRequest.
`compartment_id`	Gets the compartment_id of this WorkRequest.
`error_details`	[Required] Gets the error_details of this WorkRequest.
`id`	[Required] Gets the id of this WorkRequest.
`lifecycle_state`	[Required] Gets the lifecycle_state of this WorkRequest.
`load_balancer_id`	[Required] Gets the load_balancer_id of this WorkRequest.
`message`	[Required] Gets the message of this WorkRequest.
`time_accepted`	[Required] Gets the time_accepted of this WorkRequest.
`time_finished`	Gets the time_finished of this WorkRequest.
`type`	[Required] Gets the type of this WorkRequest.

Methods

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

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a WorkRequest. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a WorkRequest. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a WorkRequest. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state 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.
load_balancer_id (str) – The value to assign to the load_balancer_id property of this WorkRequest.
type (str) – The value to assign to the type property of this WorkRequest.
compartment_id (str) – The value to assign to the compartment_id property of this WorkRequest.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this WorkRequest. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
message (str) – The value to assign to the message property of this WorkRequest.
time_accepted (datetime) – The value to assign to the time_accepted property of this WorkRequest.
time_finished (datetime) – The value to assign to the time_finished property of this WorkRequest.
error_details (list[oci.load_balancer.models.WorkRequestError]) – The value to assign to the error_details property of this WorkRequest.

compartment_id¶

Gets the compartment_id of this WorkRequest. The OCID of the compartment containing the load balancer.

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

error_details¶

[Required] Gets the error_details of this WorkRequest.

Returns:	The error_details of this WorkRequest.
Return type:	list[oci.load_balancer.models.WorkRequestError]

id¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this WorkRequest. The current state of the work request.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

load_balancer_id¶

[Required] Gets the load_balancer_id of this WorkRequest. The OCID of the load balancer with which the work request is associated.

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

message¶

[Required] Gets the message of this WorkRequest. A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure. Possible data elements include:

workflow name
event ID
work request ID
load balancer ID
workflow completion message

Returns:	The message 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.

Example: 2016-08-25T21:10:29.600Z

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

time_finished¶

Gets the time_finished of this WorkRequest. The date and time the work request was completed, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

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

type¶

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

Example: CreateListener

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