@Generated(value="OracleSDKGenerator", comments="API Version: 20200909") public final class WorkRequest extends ExplicitlySetBmcModel
An object representing an asynchronous work flow.
Many of the API requests you use to create and configure
service connectors 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](https://docs.cloud.oracle.com/iaas/Content/service-connector-hub/workrequests.htm).
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
ExplicitlySetBmcModel.__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take
ExplicitlySetBmcModel.__explicitlySet__
into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
WorkRequest.Builder |
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
containing the work request.
|
String |
getId()
The OCID of the work request.
|
OperationType |
getOperationType()
The type of action the work request represents.
|
Float |
getPercentComplete()
Percentage of the request completed.
|
List<WorkRequestResource> |
getResources()
The resources affected by this work request.
|
OperationStatus |
getStatus()
Status of current work request.
|
Date |
getTimeAccepted()
The date and time when the request was created.
|
Date |
getTimeFinished()
The date and time when the object finished.
|
Date |
getTimeStarted()
The date and time when the request was started.
|
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()
The type of action the work request represents.
public OperationStatus getStatus()
Status of current work request.
public String getCompartmentId()
The OCID of the compartment containing the work request.
public List<WorkRequestResource> getResources()
The resources affected by this work request.
public Float getPercentComplete()
Percentage of the request completed.
public Date getTimeAccepted()
The date and time when the request was created.
Format is defined by RFC3339.
Example: 2020-01-25T21:10:29.600Z
public Date getTimeStarted()
The date and time when the request was started.
Format is defined by RFC3339.
Example: 2020-01-25T21:10:29.600Z
public Date getTimeFinished()
The date and time when the object finished.
Format is defined by RFC3339.
Example: 2020-01-25T21:10:29.600Z
public String toString()
toString
in class 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 ExplicitlySetBmcModel
public int hashCode()
hashCode
in class ExplicitlySetBmcModel
Copyright © 2016–2022. All rights reserved.