Package com.oracle.bmc.fleetappsmanagement.requests

Class ListRunbooksRequest.Builder

java.lang.Object

com.oracle.bmc.fleetappsmanagement.requests.ListRunbooksRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListRunbooksRequest,Void>

Enclosing class:

ListRunbooksRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListRunbooksRequest	build()	Build the instance of ListRunbooksRequest as configured by this builder
ListRunbooksRequest	buildWithoutInvocationCallback()	Build the instance of ListRunbooksRequest as configured by this builder
ListRunbooksRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListRunbooksRequest.Builder	copy(ListRunbooksRequest o)	Copy method to populate the builder with values from the given instance.
ListRunbooksRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListRunbooksRequest.Builder	id(String id)	Unique identifier or OCID for listing a single Runbook by id.
ListRunbooksRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListRunbooksRequest.Builder	lifecycleState(Runbook.LifecycleState lifecycleState)	A filter to return only resources whose lifecycleState matches the given lifecycleState.
ListRunbooksRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListRunbooksRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListRunbooksRequest.Builder	operation(String operation)	A filter to return runbooks whose operation matches the given lifecycle operation.
ListRunbooksRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListRunbooksRequest.Builder	platform(String platform)	A filter to return runbooks whose platform matches the given platform.
ListRunbooksRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListRunbooksRequest.Builder	sortBy(RunbookSortBy sortBy)	The field to sort by.
ListRunbooksRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘ASC’ or ‘DESC’.
ListRunbooksRequest.Builder	type(Runbook.Type type)	A filter to return runbooks whose type matches the given 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

compartmentId

public ListRunbooksRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Empty only if the resource OCID query param is not specified.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListRunbooksRequest.Builder lifecycleState(Runbook.LifecycleState lifecycleState)

A filter to return only resources whose lifecycleState matches the given lifecycleState.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListRunbooksRequest.Builder displayName(String displayName)

A filter to return only resources that match the entire display name given.

Parameters:

displayName - the value to set

Returns:

this builder instance

id

public ListRunbooksRequest.Builder id(String id)

Unique identifier or OCID for listing a single Runbook by id.

Either compartmentId or id must be provided.

Parameters:

id - the value to set

Returns:

this builder instance

type

public ListRunbooksRequest.Builder type(Runbook.Type type)

A filter to return runbooks whose type matches the given type.

Parameters:

type - the value to set

Returns:

this builder instance

platform

public ListRunbooksRequest.Builder platform(String platform)

A filter to return runbooks whose platform matches the given platform.

Parameters:

platform - the value to set

Returns:

this builder instance

operation

public ListRunbooksRequest.Builder operation(String operation)

A filter to return runbooks whose operation matches the given lifecycle operation.

Parameters:

operation - the value to set

Returns:

this builder instance

limit

public ListRunbooksRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListRunbooksRequest.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

sortOrder

public ListRunbooksRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListRunbooksRequest.Builder sortBy(RunbookSortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListRunbooksRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListRunbooksRequest.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 ListRunbooksRequest.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 ListRunbooksRequest.Builder copy(ListRunbooksRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListRunbooksRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListRunbooksRequest build()

Build the instance of ListRunbooksRequest 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<ListRunbooksRequest,Void>

Returns:

instance of ListRunbooksRequest

buildWithoutInvocationCallback

public ListRunbooksRequest buildWithoutInvocationCallback()

Build the instance of ListRunbooksRequest 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 ListRunbooksRequest