Package com.oracle.bmc.databasetoolsruntime.model

Class WorkRequest

java.lang.Object

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

com.oracle.bmc.databasetoolsruntime.model.WorkRequest

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

An asynchronous 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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkRequest.Builder

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(String displayName, OperationType operationType, OperationStatus status, String id, String compartmentId, String createdByPrincipalId, String createdByPrincipalDomainId, List<WorkRequestResource> resources, Float percentComplete, Date timeAccepted, Date timeStarted, Date timeFinished, Date timeUpdated, Date timeScheduled)	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 the work request.
String	getCreatedByPrincipalDomainId()	Identity domain OCID for the user that submitted the asynchronous request.
String	getCreatedByPrincipalId()	Principal id of the user or resource that submitted the asynchrounous request.
String	getDisplayName()	A user-friendly name for the operation.
String	getId()	The OCID of the work request.
OperationType	getOperationType()	The asynchronous operation tracked by this work request.
Float	getPercentComplete()	Percentage of the request completed.
List<WorkRequestResource>	getResources()	The resources affected by this work request.
OperationStatus	getStatus()	The 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 reached a terminal state, either FAILED or SUCCEEDED.
Date	getTimeScheduled()	The date and time the work request is eligible to be launched, in the format defined by RFC3339.
Date	getTimeStarted()	The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC3339.
Date	getTimeUpdated()	The date and time the work request was last updated, in the format defined by RFC3339.
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({"displayName","operationType","status","id","compartmentId","createdByPrincipalId","createdByPrincipalDomainId","resources","percentComplete","timeAccepted","timeStarted","timeFinished","timeUpdated","timeScheduled"})
public WorkRequest(String displayName,
                   OperationType operationType,
                   OperationStatus status,
                   String id,
                   String compartmentId,
                   String createdByPrincipalId,
                   String createdByPrincipalDomainId,
                   List<WorkRequestResource> resources,
                   Float percentComplete,
                   Date timeAccepted,
                   Date timeStarted,
                   Date timeFinished,
                   Date timeUpdated,
                   Date timeScheduled)

Deprecated.

Method Detail

builder

public static WorkRequest.Builder builder()

Create a new builder.

toBuilder

public WorkRequest.Builder toBuilder()

getDisplayName

public String getDisplayName()

A user-friendly name for the operation.

If provided for an asynchronous operation, this value will be propagated to the displayName property of the resulting Work Request, allowing for easier identification and tracking of the operation’s progress and outcome. This name is purely for descriptive purposes and does not affect the functionality of the operation itself.

Returns:

the value

getOperationType

public OperationType getOperationType()

The asynchronous operation tracked by this work request.

Returns:

the value

getStatus

public OperationStatus getStatus()

The status of the work request.

Returns:

the value

getId

public String getId()

The OCID of the work request.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the work request.

Returns:

the value

getCreatedByPrincipalId

public String getCreatedByPrincipalId()

Principal id of the user or resource that submitted the asynchrounous request.

Returns:

the value

getCreatedByPrincipalDomainId

public String getCreatedByPrincipalDomainId()

Identity domain OCID for the user that submitted the asynchronous request.

Returns:

the value

getResources

public List<WorkRequestResource> getResources()

The resources affected by this work request.

Returns:

the value

getPercentComplete

public Float getPercentComplete()

Percentage of the request completed.

Returns:

the value

getTimeAccepted

public Date getTimeAccepted()

The date and time the work request was created, in the format defined by RFC3339.

Returns:

the value

getTimeStarted

public Date getTimeStarted()

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

Returns:

the value

getTimeFinished

public Date getTimeFinished()

The date and time the work request reached a terminal state, either FAILED or SUCCEEDED.

Format is defined by RFC3339.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the work request was last updated, in the format defined by RFC3339.

Returns:

the value

getTimeScheduled

public Date getTimeScheduled()

The date and time the work request is eligible to be launched, in the format defined by RFC3339.

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