@Generated(value="OracleSDKGenerator",
comments="API Version: 20210610")
public final class WorkRequest
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
An asynchronous work request. See Work
Requests.
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,
Principal createdBy,
Date timeLastUpdated,
Integer totalTaskCount,
Integer completedTaskCount)
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.
|
Integer |
getCompletedTaskCount()
The number of tasks had been executed to a terminal state.
|
Principal |
getCreatedBy() |
String |
getId()
The OCID of the
work request.
|
OperationType |
getOperationType()
The asynchronous operation tracked by this work request.
|
Float |
getPercentComplete()
The percentage complete of the operation tracked by this work request.
|
List<WorkRequestResource> |
getResources()
The resources that are affected by this work request.
|
OperationStatus |
getStatus()
The status of the work request.
|
Date |
getTimeAccepted()
The date and time the request was created (formatted according to
RFC3339).
|
Date |
getTimeFinished()
The date and time the work request reached a terminal state, either FAILED or SUCCEEDED
(formatted according to RFC3339).
|
Date |
getTimeLastUpdated()
The date and time the work request percentage was last updated.
|
Date |
getTimeStarted()
The date and time the work request transitioned from ACCEPTED to IN_PROGRESS (formatted
according to RFC3339).
|
Integer |
getTotalTaskCount()
The total number of tasks to be executed for this work request.
|
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","createdBy","timeLastUpdated","totalTaskCount","completedTaskCount"}) public WorkRequest(OperationType operationType, OperationStatus status, String id, String compartmentId, List<WorkRequestResource> resources, Float percentComplete, Date timeAccepted, Date timeStarted, Date timeFinished, Principal createdBy, Date timeLastUpdated, Integer totalTaskCount, Integer completedTaskCount)
public static WorkRequest.Builder builder()
Create a new builder.
public WorkRequest.Builder toBuilder()
public OperationType getOperationType()
The asynchronous operation tracked by this work request.
public OperationStatus getStatus()
The status of the work request.
public String getCompartmentId()
The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources aren’t in the same compartment, it’s up to the service team to pick the primary resource whose compartment should be used.
public List<WorkRequestResource> getResources()
The resources that are affected by this work request.
public Float getPercentComplete()
The percentage complete of the operation tracked by this work request.
public Date getTimeAccepted()
The date and time the request was created (formatted according to RFC3339).
public Date getTimeStarted()
The date and time the work request transitioned from ACCEPTED to IN_PROGRESS (formatted according to RFC3339).
public Date getTimeFinished()
The date and time the work request reached a terminal state, either FAILED or SUCCEEDED (formatted according to RFC3339).
public Principal getCreatedBy()
public Date getTimeLastUpdated()
The date and time the work request percentage was last updated. (formatted according to RFC3339).
public Integer getTotalTaskCount()
The total number of tasks to be executed for this work request.
public Integer getCompletedTaskCount()
The number of tasks had been executed to a terminal state.
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.