Package com.oracle.bmc.waas.model

Class WorkRequest

java.lang.Object

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

com.oracle.bmc.waas.model.WorkRequest

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

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.
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

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, WorkRequestOperationTypes operationType, WorkRequestStatusValues status, String compartmentId, List<WorkRequestResource> resources, Integer percentComplete, List<WorkRequestLogEntry> logs, List<WorkRequestError> errors, Date timeAccepted, Date timeStarted, Date timeFinished)	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 that contains the work request.
List<WorkRequestError>	getErrors()	The list of errors that occurred while fulfilling the work request.
String	getId()	The OCID of the work request.
List<WorkRequestLogEntry>	getLogs()	The list of log entries from the work request workflow.
WorkRequestOperationTypes	getOperationType()	A description of the operation requested by the work request.
Integer	getPercentComplete()	The percentage of work completed by the work request.
List<WorkRequestResource>	getResources()	The resources being used to complete the work request operation.
WorkRequestStatusValues	getStatus()	The current status of the work request.
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 fulfilled or terminated, expressed in RFC 3339 timestamp format.
Date	getTimeStarted()	The date and time the work request moved from the ACCEPTED state to the IN_PROGRESS state, expressed in RFC 3339 timestamp format.
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","operationType","status","compartmentId","resources","percentComplete","logs","errors","timeAccepted","timeStarted","timeFinished"})
public WorkRequest(String id,
                   WorkRequestOperationTypes operationType,
                   WorkRequestStatusValues status,
                   String compartmentId,
                   List<WorkRequestResource> resources,
                   Integer percentComplete,
                   List<WorkRequestLogEntry> logs,
                   List<WorkRequestError> errors,
                   Date timeAccepted,
                   Date timeStarted,
                   Date timeFinished)

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

getOperationType

public WorkRequestOperationTypes getOperationType()

A description of the operation requested by the work request.

Returns:

the value

getStatus

public WorkRequestStatusValues getStatus()

The current status of the work request.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the work request.

Returns:

the value

getResources

public List<WorkRequestResource> getResources()

The resources being used to complete the work request operation.

Returns:

the value

getPercentComplete

public Integer getPercentComplete()

The percentage of work completed by the work request.

Returns:

the value

getLogs

public List<WorkRequestLogEntry> getLogs()

The list of log entries from the work request workflow.

Returns:

the value

getErrors

public List<WorkRequestError> getErrors()

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

Returns:

the value

getTimeAccepted

public Date getTimeAccepted()

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

Returns:

the value

getTimeStarted

public Date getTimeStarted()

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 value

getTimeFinished

public Date getTimeFinished()

The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format.

Returns:

the value

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