com.oracle.bmc.generativeai.model

Class WorkRequest

java.lang.Object

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

com.oracle.bmc.generativeai.model.WorkRequest

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

An asynchronous work request. When you start a long-running operation, the service creates a work request. Work requests help you monitor long-running operations.

A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
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 and 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 and Description
WorkRequest(OperationType operationType, OperationStatus status, String id, String compartmentId, List<WorkRequestResource> resources, Float percentComplete, Date timeAccepted, Date timeStarted, Date timeFinished) Deprecated.

Method Summary

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.
String	getId() The OCID of the work request.
OperationType	getOperationType() The asynchronous operation tracked by this work request.
Float	getPercentComplete() Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed.
List<WorkRequestResource>	getResources() The resources that are affected by the 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 RFC 3339.
Date	getTimeFinished() The date and time the work request was finished, in the format defined by RFC 3339.
Date	getTimeStarted() The date and time the work request was started, in the 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(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)

Deprecated.

Method Detail

builder

public static WorkRequest.Builder builder()

Create a new builder.

toBuilder

public WorkRequest.Builder toBuilder()

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

getResources

public List<WorkRequestResource> getResources()

The resources that are affected by the work request.

Returns:

the value

getPercentComplete

public Float getPercentComplete()

Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed.

Returns:

the value

getTimeAccepted

public Date getTimeAccepted()

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

Returns:

the value

getTimeStarted

public Date getTimeStarted()

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

Returns:

the value

getTimeFinished

public Date getTimeFinished()

The date and time the work request was finished, in the 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