@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
WorkRequest.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and 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.
|
| 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 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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"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)
public static WorkRequest.Builder builder()
Create a new builder.
public WorkRequest.Builder toBuilder()
public WorkRequestOperationTypes getOperationType()
A description of the operation requested by the work request.
public WorkRequestStatusValues getStatus()
The current status of the work request.
public String getCompartmentId()
The OCID of the compartment that contains the work request.
public List<WorkRequestResource> getResources()
The resources being used to complete the work request operation.
public Integer getPercentComplete()
The percentage of work completed by the work request.
public List<WorkRequestLogEntry> getLogs()
The list of log entries from the work request workflow.
public List<WorkRequestError> getErrors()
The list of errors that occurred while fulfilling the work request.
public Date getTimeAccepted()
The date and time the work request was created, in the format defined by RFC3339.
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.
public Date getTimeFinished()
The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic 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.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.