@Generated(value="OracleSDKGenerator", comments="API Version: 20200606") 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
).
Modifier and Type | Class and Description |
---|---|
static class |
WorkRequest.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
WorkRequest(OperationType operationType,
OperationStatus status,
String id,
String compartmentId,
List<WorkRequestResource> resources,
Float percentComplete,
Date timeAccepted,
Date timeStarted,
Date timeFinished)
Deprecated.
|
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.
|
String |
getId()
The OCID of the work request.
|
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.
|
OperationStatus |
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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"operationType","status","id","compartmentId","resources","percentComplete","timeAccepted","timeStarted","timeFinished"}) public WorkRequest(OperationType operationType, OperationStatus status, String id, String compartmentId, List<WorkRequestResource> resources, Float percentComplete, Date timeAccepted, Date timeStarted, Date timeFinished)
public static WorkRequest.Builder builder()
Create a new builder.
public WorkRequest.Builder toBuilder()
public OperationType getOperationType()
An enum-like description of the type of work the work request is doing.
public OperationStatus getStatus()
The current status of the work request.
public String getId()
The OCID of the work request.
public String getCompartmentId()
The OCID of the compartment that contains the work request.
public List<WorkRequestResource> getResources()
The resources this work request affects.
public Float getPercentComplete()
How much progress the operation has made.
public Date getTimeAccepted()
Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
public Date getTimeStarted()
Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
public Date getTimeFinished()
Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.