Package com.oracle.bmc.adm.requests

Class ListStagesRequest.Builder

java.lang.Object

com.oracle.bmc.adm.requests.ListStagesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListStagesRequest,Void>

Enclosing class:

ListStagesRequest

public static class ListStagesRequest.Builder
extends Object
implements BmcRequest.Builder<ListStagesRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListStagesRequest	build()	Build the instance of ListStagesRequest as configured by this builder
ListStagesRequest	buildWithoutInvocationCallback()	Build the instance of ListStagesRequest as configured by this builder
ListStagesRequest.Builder	copy(ListStagesRequest o)	Copy method to populate the builder with values from the given instance.
ListStagesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListStagesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListStagesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListStagesRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListStagesRequest.Builder	remediationRunId(String remediationRunId)	Unique Remediation Run identifier path parameter.
ListStagesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListStagesRequest.Builder	sortBy(ListStagesRequest.SortBy sortBy)	The field used to sort Stages.
ListStagesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘ASC’ or ‘DESC’.
ListStagesRequest.Builder	status(RemediationRunStage.Status status)	A filter to return only Stages that match the specified status.
ListStagesRequest.Builder	type(RemediationRunStageType type)	A filter to return only Stages that match the specified type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

remediationRunId

public ListStagesRequest.Builder remediationRunId(String remediationRunId)

Unique Remediation Run identifier path parameter.

Parameters:

remediationRunId - the value to set

Returns:

this builder instance

type

public ListStagesRequest.Builder type(RemediationRunStageType type)

A filter to return only Stages that match the specified type.

Parameters:

type - the value to set

Returns:

this builder instance

status

public ListStagesRequest.Builder status(RemediationRunStage.Status status)

A filter to return only Stages that match the specified status.

Parameters:

status - the value to set

Returns:

this builder instance

sortOrder

public ListStagesRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ‘ASC’ or ‘DESC’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListStagesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListStagesRequest.Builder page(String page)

A token representing the position at which to start retrieving results.

This must come from the opc-next-page header field of a previous response.

Parameters:

page - the value to set

Returns:

this builder instance

opcRequestId

public ListStagesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

sortBy

public ListStagesRequest.Builder sortBy(ListStagesRequest.SortBy sortBy)

The field used to sort Stages.

Only one sort order is allowed. Default order for status is the following sequence: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELING, and CANCELED. Default order for timeCreated is descending. Default order for timeFinished is descending. Default order for timeStarted is descending. Default order for type is the following sequence: DETECT, RECOMMEND, VERIFY, and APPLY.

Parameters:

sortBy - the value to set

Returns:

this builder instance

invocationCallback

public ListStagesRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListStagesRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListStagesRequest.Builder copy(ListStagesRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListStagesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListStagesRequest build()

Build the instance of ListStagesRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListStagesRequest,Void>

Returns:

instance of ListStagesRequest

buildWithoutInvocationCallback

public ListStagesRequest buildWithoutInvocationCallback()

Build the instance of ListStagesRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListStagesRequest