Package com.oracle.bmc.opensearch.requests

Class ListOpensearchClusterBackupsRequest.Builder

java.lang.Object

com.oracle.bmc.opensearch.requests.ListOpensearchClusterBackupsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListOpensearchClusterBackupsRequest,Void>

Enclosing class:

ListOpensearchClusterBackupsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListOpensearchClusterBackupsRequest	build()	Build the instance of ListOpensearchClusterBackupsRequest as configured by this builder
ListOpensearchClusterBackupsRequest	buildWithoutInvocationCallback()	Build the instance of ListOpensearchClusterBackupsRequest as configured by this builder
ListOpensearchClusterBackupsRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListOpensearchClusterBackupsRequest.Builder	copy(ListOpensearchClusterBackupsRequest o)	Copy method to populate the builder with values from the given instance.
ListOpensearchClusterBackupsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListOpensearchClusterBackupsRequest.Builder	id(String id)	unique OpensearchClusterBackup identifier
ListOpensearchClusterBackupsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListOpensearchClusterBackupsRequest.Builder	lifecycleState(OpensearchClusterBackup.LifecycleState lifecycleState)	A filter to return only resources their lifecycleState matches the given lifecycleState.
ListOpensearchClusterBackupsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListOpensearchClusterBackupsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListOpensearchClusterBackupsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListOpensearchClusterBackupsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListOpensearchClusterBackupsRequest.Builder	sortBy(ListOpensearchClusterBackupsRequest.SortBy sortBy)	The field to sort by.
ListOpensearchClusterBackupsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.
ListOpensearchClusterBackupsRequest.Builder	sourceOpensearchClusterId(String sourceOpensearchClusterId)	A filter to return only resources that match the entire source cluster id given.

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 ListOpensearchClusterBackupsRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListOpensearchClusterBackupsRequest.Builder lifecycleState(OpensearchClusterBackup.LifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

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

sourceOpensearchClusterId

public ListOpensearchClusterBackupsRequest.Builder sourceOpensearchClusterId(String sourceOpensearchClusterId)

A filter to return only resources that match the entire source cluster id given.

Parameters:

sourceOpensearchClusterId - the value to set

Returns:

this builder instance

id

public ListOpensearchClusterBackupsRequest.Builder id(String id)

unique OpensearchClusterBackup identifier

Parameters:

id - the value to set

Returns:

this builder instance

limit

public ListOpensearchClusterBackupsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListOpensearchClusterBackupsRequest.Builder page(String page)

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListOpensearchClusterBackupsRequest.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 ListOpensearchClusterBackupsRequest.Builder sortBy(ListOpensearchClusterBackupsRequest.SortBy 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. If no value is specified timeCreated is default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListOpensearchClusterBackupsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListOpensearchClusterBackupsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListOpensearchClusterBackupsRequest build()

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

Returns:

instance of ListOpensearchClusterBackupsRequest

buildWithoutInvocationCallback

public ListOpensearchClusterBackupsRequest buildWithoutInvocationCallback()

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