Package com.oracle.bmc.osmanagement.model

Class WorkRequest

java.lang.Object

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

com.oracle.bmc.osmanagement.model.WorkRequest

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

A description of workrequest status
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(OperationTypes operationType, OperationStatus status, String id, String compartmentId, String description, String message, Id managedInstanceId, List<WorkRequestResource> resources, Float percentComplete, Date timeAccepted, Date timeStarted, Date timeFinished, OsFamilies osFamily, String parentId, List<String> childrenIds)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static WorkRequest.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<String>	getChildrenIds()	A list of the IDs of any children of this work request
String	getCompartmentId()	The ocid of the compartment that contains the work request.
String	getDescription()	Description of the type of work.
String	getId()	The id of the work request.
Id	getManagedInstanceId()
String	getMessage()	A progress or error message, if there is any.
OperationTypes	getOperationType()	the type of operation this Work Request performs
OsFamilies	getOsFamily()	The Operating System type of the managed instance.
String	getParentId()	The parent of this work request, if one exists.
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 the request was created, as described in RFC 3339, section 14.29.
Date	getTimeFinished()	The date and time the object was finished, as described in RFC 3339.
Date	getTimeStarted()	The date and time the request was started, as described in RFC 3339, section 14.29.
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","description","message","managedInstanceId","resources","percentComplete","timeAccepted","timeStarted","timeFinished","osFamily","parentId","childrenIds"})
public WorkRequest(OperationTypes operationType,
                   OperationStatus status,
                   String id,
                   String compartmentId,
                   String description,
                   String message,
                   Id managedInstanceId,
                   List<WorkRequestResource> resources,
                   Float percentComplete,
                   Date timeAccepted,
                   Date timeStarted,
                   Date timeFinished,
                   OsFamilies osFamily,
                   String parentId,
                   List<String> childrenIds)

Deprecated.

Method Detail

builder

public static WorkRequest.Builder builder()

Create a new builder.

toBuilder

public WorkRequest.Builder toBuilder()

getOperationType

public OperationTypes getOperationType()

the type of operation this Work Request performs

Returns:

the value

getStatus

public OperationStatus getStatus()

status of current 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 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 are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

Returns:

the value

getDescription

public String getDescription()

Description of the type of work.

Returns:

the value

getMessage

public String getMessage()

A progress or error message, if there is any.

Returns:

the value

getManagedInstanceId

public Id getManagedInstanceId()

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 request was created, as described in RFC 3339, section 14.29.

Returns:

the value

getTimeStarted

public Date getTimeStarted()

The date and time the request was started, as described in RFC 3339, section 14.29.

Returns:

the value

getTimeFinished

public Date getTimeFinished()

The date and time the object was finished, as described in RFC 3339.

Returns:

the value

getOsFamily

public OsFamilies getOsFamily()

The Operating System type of the managed instance.

Returns:

the value

getParentId

public String getParentId()

The parent of this work request, if one exists.

Returns:

the value

getChildrenIds

public List<String> getChildrenIds()

A list of the IDs of any children of this work request

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