Package com.oracle.bmc.loadbalancer.model

Class WorkRequest

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.loadbalancer.model.WorkRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170115")
public final class WorkRequest
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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.
Note: Objects should always be created or deserialized using the WorkRequest.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the WorkRequest.Builder, which maintain a set of all explicitly set fields called WorkRequest.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkRequest.Builder
static class	WorkRequest.LifecycleState	The current state of the work request.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
WorkRequest(String id, String loadBalancerId, String type, String compartmentId, WorkRequest.LifecycleState lifecycleState, String message, Date timeAccepted, Date timeFinished, List<WorkRequestError> errorDetails)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static WorkRequest.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment containing the load balancer.
List<WorkRequestError>	getErrorDetails()
String	getId()	The OCID of the work request.
WorkRequest.LifecycleState	getLifecycleState()	The current state of the work request.
String	getLoadBalancerId()	The OCID of the load balancer with which the work request is associated.
String	getMessage()	A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure.
Date	getTimeAccepted()	The date and time the work request was created, in the format defined by RFC3339.
Date	getTimeFinished()	The date and time the work request was completed, in the format defined by RFC3339.
String	getType()	The type of action the work request represents.
int	hashCode()
WorkRequest.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkRequest

@Deprecated
@ConstructorProperties({"id","loadBalancerId","type","compartmentId","lifecycleState","message","timeAccepted","timeFinished","errorDetails"})
public WorkRequest(String id,
                   String loadBalancerId,
                   String type,
                   String compartmentId,
                   WorkRequest.LifecycleState lifecycleState,
                   String message,
                   Date timeAccepted,
                   Date timeFinished,
                   List<WorkRequestError> errorDetails)

Deprecated.

Method Detail

builder

public static WorkRequest.Builder builder()

Create a new builder.

toBuilder

public WorkRequest.Builder toBuilder()

getId

public String getId()

The OCID of the work request.

Returns:

the value

getLoadBalancerId

public String getLoadBalancerId()

The OCID of the load balancer with which the work request is associated.

Returns:

the value

getType

public String getType()

The type of action the work request represents.

Example: CreateListener

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the load balancer.

Returns:

the value

getLifecycleState

public WorkRequest.LifecycleState getLifecycleState()

The current state of the work request.

Returns:

the value

getMessage

public String getMessage()

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 value

getTimeAccepted

public Date getTimeAccepted()

The date and time the work request was created, in the format defined by RFC3339.

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

Returns:

the value

getTimeFinished

public Date getTimeFinished()

The date and time the work request was completed, in the format defined by RFC3339.

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

Returns:

the value

getErrorDetails

public List<WorkRequestError> getErrorDetails()

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel