Package com.oracle.bmc.osmanagementhub.model

Class WorkRequest

java.lang.Object

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

com.oracle.bmc.osmanagementhub.model.WorkRequest

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

An object that defines a 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(WorkRequestOperationType operationType, OperationStatus status, String id, String description, String displayName, String message, String parentId, List<String> childrenId, String compartmentId, List<WorkRequestResource> resources, List<String> packageNames, List<String> windowsUpdateNames, List<ModuleSpecDetails> moduleSpecs, Float percentComplete, Date timeCreated, Date timeUpdated, Date timeStarted, Date timeFinished, String initiatorId, WorkRequestManagementStationDetails managementStation, Date timeScheduled, String contentLocation, String eventId, String contentChecksum, String retryOfId, String rerunOfId, List<Integer> retryIntervals, Boolean isManagedByAutonomousLinux, Integer rebootTimeoutInMins)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static WorkRequest.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<String>	getChildrenId()	The list of OCIDs for the child work requests.
String	getCompartmentId()	The OCID of the compartment that contains the work request.
String	getContentChecksum()	The EventFingerprint associated with the content.
String	getContentLocation()	The location of the bundle in the filesystem of the resource associated to this work request.
String	getDescription()	A short description about the work request.
String	getDisplayName()	A short display name for the work request.
String	getEventId()	The event id of the content.
String	getId()	The OCID of the work request.
String	getInitiatorId()	The OCID of the resource that initiated the work request.
Boolean	getIsManagedByAutonomousLinux()	Indicates whether this work request is managed by the Autonomous Linux service.
WorkRequestManagementStationDetails	getManagementStation()
String	getMessage()	A progress or error message, if there is any.
List<ModuleSpecDetails>	getModuleSpecs()	The list of appstream modules being operated on.
WorkRequestOperationType	getOperationType()	Type of the work request.
List<String>	getPackageNames()	A list of package names to be installed, updated, or removed.
String	getParentId()	The OCID of the parent work request, if there is any.
Float	getPercentComplete()	The percentage complete of the operation tracked by this work request.
Integer	getRebootTimeoutInMins()	The number of minutes the service waits for the reboot to complete.
String	getRerunOfId()	The OCID of the original work request that is being rerun.
List<WorkRequestResource>	getResources()	The list of OCIDs for the resources affected by the work request.
List<Integer>	getRetryIntervals()	The amount of time in minutes to wait until retrying the work request.
String	getRetryOfId()	The OCID of the original work request that is being retried.
OperationStatus	getStatus()	Status of the work request.
Date	getTimeCreated()	The date and time the work request was created (in RFC 3339 format).
Date	getTimeFinished()	The date and time the work request completed (in RFC 3339 format).
Date	getTimeScheduled()	The scheduled date and time to retry the work request (in RFC 3339 format).
Date	getTimeStarted()	The date and time the work request started (in RFC 3339 format).
Date	getTimeUpdated()	The date and time the work request started (in RFC 3339 format).
List<String>	getWindowsUpdateNames()	The UUIDs of the target Windows update (only used when operation type is INSTALL_WINDOWS_UPDATES).
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","description","displayName","message","parentId","childrenId","compartmentId","resources","packageNames","windowsUpdateNames","moduleSpecs","percentComplete","timeCreated","timeUpdated","timeStarted","timeFinished","initiatorId","managementStation","timeScheduled","contentLocation","eventId","contentChecksum","retryOfId","rerunOfId","retryIntervals","isManagedByAutonomousLinux","rebootTimeoutInMins"})
public WorkRequest(WorkRequestOperationType operationType,
                   OperationStatus status,
                   String id,
                   String description,
                   String displayName,
                   String message,
                   String parentId,
                   List<String> childrenId,
                   String compartmentId,
                   List<WorkRequestResource> resources,
                   List<String> packageNames,
                   List<String> windowsUpdateNames,
                   List<ModuleSpecDetails> moduleSpecs,
                   Float percentComplete,
                   Date timeCreated,
                   Date timeUpdated,
                   Date timeStarted,
                   Date timeFinished,
                   String initiatorId,
                   WorkRequestManagementStationDetails managementStation,
                   Date timeScheduled,
                   String contentLocation,
                   String eventId,
                   String contentChecksum,
                   String retryOfId,
                   String rerunOfId,
                   List<Integer> retryIntervals,
                   Boolean isManagedByAutonomousLinux,
                   Integer rebootTimeoutInMins)

Deprecated.

Method Detail

builder

public static WorkRequest.Builder builder()

Create a new builder.

toBuilder

public WorkRequest.Builder toBuilder()

getOperationType

public WorkRequestOperationType getOperationType()

Type of the work request.

Returns:

the value

getStatus

public OperationStatus getStatus()

Status of the work request.

Returns:

the value

getId

public String getId()

The OCID of the work request.

Returns:

the value

getDescription

public String getDescription()

A short description about the work request.

Returns:

the value

getDisplayName

public String getDisplayName()

A short display name for the work request.

Returns:

the value

getMessage

public String getMessage()

A progress or error message, if there is any.

Returns:

the value

getParentId

public String getParentId()

The OCID of the parent work request, if there is any.

Returns:

the value

getChildrenId

public List<String> getChildrenId()

The list of OCIDs for the child work requests.

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 it affects. If the work request affects multiple resources the different compartments, the services selects the compartment of the primary resource.

Returns:

the value

getResources

public List<WorkRequestResource> getResources()

The list of OCIDs for the resources affected by the work request.

Returns:

the value

getPackageNames

public List<String> getPackageNames()

A list of package names to be installed, updated, or removed.

Returns:

the value

getWindowsUpdateNames

public List<String> getWindowsUpdateNames()

The UUIDs of the target Windows update (only used when operation type is INSTALL_WINDOWS_UPDATES).

Returns:

the value

getModuleSpecs

public List<ModuleSpecDetails> getModuleSpecs()

The list of appstream modules being operated on.

Returns:

the value

getPercentComplete

public Float getPercentComplete()

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

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the work request was created (in RFC 3339 format).

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the work request started (in RFC 3339 format).

Returns:

the value

getTimeStarted

public Date getTimeStarted()

The date and time the work request started (in RFC 3339 format).

Returns:

the value

getTimeFinished

public Date getTimeFinished()

The date and time the work request completed (in RFC 3339 format).

Returns:

the value

getInitiatorId

public String getInitiatorId()

The OCID of the resource that initiated the work request.

Returns:

the value

getManagementStation

public WorkRequestManagementStationDetails getManagementStation()

getTimeScheduled

public Date getTimeScheduled()

The scheduled date and time to retry the work request (in RFC 3339 format).

Returns:

the value

getContentLocation

public String getContentLocation()

The location of the bundle in the filesystem of the resource associated to this work request.

Returns:

the value

getEventId

public String getEventId()

The event id of the content.

This property is required when the work request type is IMPORT_CONTENT or REMOVE_CONTENT.

Returns:

the value

getContentChecksum

public String getContentChecksum()

The EventFingerprint associated with the content.

This property is required when the work request type is IMPORT_CONTENT or REMOVE_CONTENT.

Returns:

the value

getRetryOfId

public String getRetryOfId()

The OCID of the original work request that is being retried.

Returns:

the value

getRerunOfId

public String getRerunOfId()

The OCID of the original work request that is being rerun.

Returns:

the value

getRetryIntervals

public List<Integer> getRetryIntervals()

The amount of time in minutes to wait until retrying the work request.

If set, the service will automatically retry a failed work request after the interval. For example, An interval set to [2,5,10]. If the initial execution of the work request fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.

Returns:

the value

getIsManagedByAutonomousLinux

public Boolean getIsManagedByAutonomousLinux()

Indicates whether this work request is managed by the Autonomous Linux service.

Returns:

the value

getRebootTimeoutInMins

public Integer getRebootTimeoutInMins()

The number of minutes the service waits for the reboot to complete.

If the managed instance doesn’t reboot within the timeout, the service marks the reboot job as failed.

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