com.oracle.bmc.identity.model

Class WorkRequest

java.lang.Object

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

com.oracle.bmc.identity.model.WorkRequest

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

The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.
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 and Description
static class	WorkRequest.Builder
static class	WorkRequest.OperationType An enum-like description of the type of work the work request is doing.
static class	WorkRequest.Status The current status 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 and Description
WorkRequest(String id, WorkRequest.OperationType operationType, String compartmentId, WorkRequest.Status status, List<WorkRequestResource> resources, List<WorkRequestError> errors, List<WorkRequestLogEntry> logs, Date timeAccepted, Date timeStarted, Date timeFinished, Float percentComplete) Deprecated.

Method Summary

Modifier and Type	Method and 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 errors for work request.
String	getId() The OCID of the work request.
List<WorkRequestLogEntry>	getLogs() The logs for work request.
WorkRequest.OperationType	getOperationType() An enum-like description of the type of work the work request is doing.
Float	getPercentComplete() How much progress the operation has made.
List<WorkRequestResource>	getResources() The resources this work request affects.
WorkRequest.Status	getStatus() The current status of the work request.
Date	getTimeAccepted() Date and time the work was accepted, in the format defined by RFC3339.
Date	getTimeFinished() Date and time the work completed, in the format defined by RFC3339.
Date	getTimeStarted() Date and time the work started, in the format defined by RFC3339.
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(value={"id","operationType","compartmentId","status","resources","errors","logs","timeAccepted","timeStarted","timeFinished","percentComplete"})
public WorkRequest(String id,
                                                                                                                                                                                                        WorkRequest.OperationType operationType,
                                                                                                                                                                                                        String compartmentId,
                                                                                                                                                                                                        WorkRequest.Status status,
                                                                                                                                                                                                        List<WorkRequestResource> resources,
                                                                                                                                                                                                        List<WorkRequestError> errors,
                                                                                                                                                                                                        List<WorkRequestLogEntry> logs,
                                                                                                                                                                                                        Date timeAccepted,
                                                                                                                                                                                                        Date timeStarted,
                                                                                                                                                                                                        Date timeFinished,
                                                                                                                                                                                                        Float percentComplete)

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 WorkRequest.OperationType getOperationType()

An enum-like description of the type of work the work request is doing.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the work request.

Returns:

the value

getStatus

public WorkRequest.Status getStatus()

The current status of the work request.

Returns:

the value

getResources

public List<WorkRequestResource> getResources()

The resources this work request affects.

Returns:

the value

getErrors

public List<WorkRequestError> getErrors()

The errors for work request.

Returns:

the value

getLogs

public List<WorkRequestLogEntry> getLogs()

The logs for work request.

Returns:

the value

getTimeAccepted

public Date getTimeAccepted()

Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getTimeStarted

public Date getTimeStarted()

Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getTimeFinished

public Date getTimeFinished()

Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getPercentComplete

public Float getPercentComplete()

How much progress the operation has made.

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