Package com.oracle.bmc.oda.model

Class WorkRequest

java.lang.Object

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

com.oracle.bmc.oda.model.WorkRequest

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

The description of work request, including its status.
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.RequestAction	The type of the operation that’s associated with the work request.
static class	WorkRequest.Status	The status of current 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 compartmentId, String odaInstanceId, String resourceId, WorkRequest.RequestAction requestAction, WorkRequest.Status status, String statusMessage, List<WorkRequestResource> resources, Float percentComplete, 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 identifier of the compartment that contains the work request.
String	getId()	The identifier of the work request.
String	getOdaInstanceId()	The identifier of the Digital Assistant instance to which this work request pertains.
Float	getPercentComplete()	Percentage of the request completed.
WorkRequest.RequestAction	getRequestAction()	The type of the operation that’s associated with the work request.
String	getResourceId()	The identifier of the resource to which this work request pertains.
List<WorkRequestResource>	getResources()	The resources that this work request affects.
WorkRequest.Status	getStatus()	The status of current work request.
String	getStatusMessage()	A short message that provides more detail about the current status.
Date	getTimeAccepted()	The date and time that the request was created, as described in RFC 3339, section 14.29.
Date	getTimeFinished()	The date and time that the object finished, as described in RFC 3339.
Date	getTimeStarted()	The date and time that the request was started, as described in RFC 3339, CKQ section 14.29.
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","compartmentId","odaInstanceId","resourceId","requestAction","status","statusMessage","resources","percentComplete","timeAccepted","timeStarted","timeFinished"})
public WorkRequest(String id,
                   String compartmentId,
                   String odaInstanceId,
                   String resourceId,
                   WorkRequest.RequestAction requestAction,
                   WorkRequest.Status status,
                   String statusMessage,
                   List<WorkRequestResource> resources,
                   Float percentComplete,
                   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 identifier of the work request.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The identifier of the compartment that contains the work request.

Returns:

the value

getOdaInstanceId

public String getOdaInstanceId()

The identifier of the Digital Assistant instance to which this work request pertains.

Returns:

the value

getResourceId

public String getResourceId()

The identifier of the resource to which this work request pertains.

Returns:

the value

getRequestAction

public WorkRequest.RequestAction getRequestAction()

The type of the operation that’s associated with the work request.

Returns:

the value

getStatus

public WorkRequest.Status getStatus()

The status of current work request.

Returns:

the value

getStatusMessage

public String getStatusMessage()

A short message that provides more detail about the current status.

For example, if a work request fails, then this may include information about why it failed.

Returns:

the value

getResources

public List<WorkRequestResource> getResources()

The resources that this work request affects.

Returns:

the value

getPercentComplete

public Float getPercentComplete()

Percentage of the request completed.

Returns:

the value

getTimeAccepted

public Date getTimeAccepted()

The date and time that the request was created, as described in RFC 3339, section 14.29.

Returns:

the value

getTimeStarted

public Date getTimeStarted()

The date and time that the request was started, as described in RFC 3339, CKQ section 14.29.

Returns:

the value

getTimeFinished

public Date getTimeFinished()

The date and time that the object finished, as described in RFC 3339.

CKQ

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