Package com.oracle.bmc.dataintegration.model

Class WorkRequest

java.lang.Object

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

com.oracle.bmc.dataintegration.model.WorkRequest

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

The API operations used to create and configure Data Integration resources do not take effect immediately.

In these cases, the operation spawns an asynchronous workflow to fulfill the request. Work requests provide visibility into the status of these in-progress, long-running asynchronous 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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkRequest.Builder
static class	WorkRequest.OperationType	The asynchronous operation tracked by this work request.
static class	WorkRequest.Status	The status of this 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(WorkRequest.OperationType operationType, WorkRequest.Status status, String id, String compartmentId, 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 OCID of the compartment that contains this work request.
String	getId()	The ID of the work request.
WorkRequest.OperationType	getOperationType()	The asynchronous operation tracked by this work request.
Float	getPercentComplete()	The completed percentage of the operation tracked by this work request.
List<WorkRequestResource>	getResources()	The resources affected by this work request.
WorkRequest.Status	getStatus()	The status of this work request.
Date	getTimeAccepted()	The date and time this work request was accepted, in the timestamp format defined by RFC 3339.
Date	getTimeFinished()	The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the timestamp format defined by RFC 3339.
Date	getTimeStarted()	The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the timestamp format defined by RFC 3339.
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({"operationType","status","id","compartmentId","resources","percentComplete","timeAccepted","timeStarted","timeFinished"})
public WorkRequest(WorkRequest.OperationType operationType,
                   WorkRequest.Status status,
                   String id,
                   String compartmentId,
                   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()

getOperationType

public WorkRequest.OperationType getOperationType()

The asynchronous operation tracked by this work request.

Returns:

the value

getStatus

public WorkRequest.Status getStatus()

The status of this work request.

Returns:

the value

getId

public String getId()

The ID of the work request.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains this 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 that are not in the same compartment, then the system picks a primary resource whose compartment should be used.

Returns:

the value

getResources

public List<WorkRequestResource> getResources()

The resources affected by this work request.

Returns:

the value

getPercentComplete

public Float getPercentComplete()

The completed percentage of the operation tracked by this work request.

Returns:

the value

getTimeAccepted

public Date getTimeAccepted()

The date and time this work request was accepted, in the timestamp format defined by RFC 3339.

Returns:

the value

getTimeStarted

public Date getTimeStarted()

The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the timestamp format defined by RFC 3339.

Returns:

the value

getTimeFinished

public Date getTimeFinished()

The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the timestamp format defined by RFC 3339.

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