Package com.oracle.bmc.jms.model

Class WorkRequest.Builder

java.lang.Object

com.oracle.bmc.jms.model.WorkRequest.Builder

Enclosing class:

WorkRequest

public static class WorkRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WorkRequest	build()
WorkRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment that contains the work request.
WorkRequest.Builder	completedTaskCount(Integer completedTaskCount)	The number of tasks had been executed to a terminal state.
WorkRequest.Builder	copy(WorkRequest model)
WorkRequest.Builder	createdBy(Principal createdBy)
WorkRequest.Builder	id(String id)	The OCID of the work request.
WorkRequest.Builder	operationType(OperationType operationType)	The asynchronous operation tracked by this work request.
WorkRequest.Builder	percentComplete(Float percentComplete)	The percentage complete of the operation tracked by this work request.
WorkRequest.Builder	resources(List<WorkRequestResource> resources)	The resources that are affected by this work request.
WorkRequest.Builder	status(OperationStatus status)	The status of the work request.
WorkRequest.Builder	timeAccepted(Date timeAccepted)	The date and time the request was created (formatted according to RFC3339).
WorkRequest.Builder	timeFinished(Date timeFinished)	The date and time the work request reached a terminal state, either FAILED or SUCCEEDED (formatted according to RFC3339).
WorkRequest.Builder	timeLastUpdated(Date timeLastUpdated)	The date and time the work request percentage was last updated.
WorkRequest.Builder	timeStarted(Date timeStarted)	The date and time the work request transitioned from ACCEPTED to IN_PROGRESS (formatted according to RFC3339).
WorkRequest.Builder	totalTaskCount(Integer totalTaskCount)	The total number of tasks to be executed for this work request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

operationType

public WorkRequest.Builder operationType(OperationType operationType)

The asynchronous operation tracked by this work request.

Parameters:

operationType - the value to set

Returns:

this builder

status

public WorkRequest.Builder status(OperationStatus status)

The status of the work request.

Parameters:

status - the value to set

Returns:

this builder

id

public WorkRequest.Builder id(String id)

The OCID of the work request.

Parameters:

id - the value to set

Returns:

this builder

compartmentId

public WorkRequest.Builder compartmentId(String compartmentId)

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 aren’t in the same compartment, it’s up to the service team to pick the primary resource whose compartment should be used.

Parameters:

compartmentId - the value to set

Returns:

this builder

resources

public WorkRequest.Builder resources(List<WorkRequestResource> resources)

The resources that are affected by this work request.

Parameters:

resources - the value to set

Returns:

this builder

percentComplete

public WorkRequest.Builder percentComplete(Float percentComplete)

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

Parameters:

percentComplete - the value to set

Returns:

this builder

timeAccepted

public WorkRequest.Builder timeAccepted(Date timeAccepted)

The date and time the request was created (formatted according to RFC3339).

Parameters:

timeAccepted - the value to set

Returns:

this builder

timeStarted

public WorkRequest.Builder timeStarted(Date timeStarted)

The date and time the work request transitioned from ACCEPTED to IN_PROGRESS (formatted according to RFC3339).

Parameters:

timeStarted - the value to set

Returns:

this builder

timeFinished

public WorkRequest.Builder timeFinished(Date timeFinished)

The date and time the work request reached a terminal state, either FAILED or SUCCEEDED (formatted according to RFC3339).

Parameters:

timeFinished - the value to set

Returns:

this builder

createdBy

public WorkRequest.Builder createdBy(Principal createdBy)

timeLastUpdated

public WorkRequest.Builder timeLastUpdated(Date timeLastUpdated)

The date and time the work request percentage was last updated.

(formatted according to RFC3339).

Parameters:

timeLastUpdated - the value to set

Returns:

this builder

totalTaskCount

public WorkRequest.Builder totalTaskCount(Integer totalTaskCount)

The total number of tasks to be executed for this work request.

Parameters:

totalTaskCount - the value to set

Returns:

this builder

completedTaskCount

public WorkRequest.Builder completedTaskCount(Integer completedTaskCount)

The number of tasks had been executed to a terminal state.

Parameters:

completedTaskCount - the value to set

Returns:

this builder

build

public WorkRequest build()

copy

public WorkRequest.Builder copy(WorkRequest model)