Package com.oracle.bmc.containerengine.requests

Class ListClustersRequest.Builder

java.lang.Object

com.oracle.bmc.containerengine.requests.ListClustersRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListClustersRequest,Void>

Enclosing class:

ListClustersRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListClustersRequest	build()	Build the instance of ListClustersRequest as configured by this builder
ListClustersRequest	buildWithoutInvocationCallback()	Build the instance of ListClustersRequest as configured by this builder
ListClustersRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListClustersRequest.Builder	copy(ListClustersRequest o)	Copy method to populate the builder with values from the given instance.
ListClustersRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListClustersRequest.Builder	lifecycleState(ClusterLifecycleState singularValue)	Singular setter.
ListClustersRequest.Builder	lifecycleState(List<ClusterLifecycleState> lifecycleState)	A cluster lifecycle state to filter on.
ListClustersRequest.Builder	limit(Integer limit)	For list pagination.
ListClustersRequest.Builder	name(String name)	The name to filter on.
ListClustersRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListClustersRequest.Builder	page(String page)	For list pagination.
ListClustersRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListClustersRequest.Builder	sortBy(ListClustersRequest.SortBy sortBy)	The optional field to sort the results by.
ListClustersRequest.Builder	sortOrder(SortOrder sortOrder)	The optional order in which to sort the results.

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

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListClustersRequest.Builder lifecycleState(List<ClusterLifecycleState> lifecycleState)

A cluster lifecycle state to filter on.

Can have multiple parameters of this name. For more information, see Monitoring Clusters

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

lifecycleState

public ListClustersRequest.Builder lifecycleState(ClusterLifecycleState singularValue)

Singular setter.

A cluster lifecycle state to filter on. Can have multiple parameters of this name. For more information, see Monitoring Clusters

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

name

public ListClustersRequest.Builder name(String name)

The name to filter on.

Parameters:

name - the value to set

Returns:

this builder instance

limit

public ListClustersRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListClustersRequest.Builder page(String page)

For list pagination.

The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListClustersRequest.Builder sortOrder(SortOrder sortOrder)

The optional order in which to sort the results.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListClustersRequest.Builder sortBy(ListClustersRequest.SortBy sortBy)

The optional field to sort the results by.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListClustersRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListClustersRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListClustersRequest build()

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

Returns:

instance of ListClustersRequest

buildWithoutInvocationCallback

public ListClustersRequest buildWithoutInvocationCallback()

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