com.oracle.bmc.ocvp.requests

Class ListClustersRequest.Builder

java.lang.Object

com.oracle.bmc.ocvp.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 and Description
Builder()

Method Summary

Modifier and Type	Method and 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 as optional parameter.
ListClustersRequest.Builder	copy(ListClustersRequest o) Copy method to populate the builder with values from the given instance.
ListClustersRequest.Builder	displayName(String displayName) A filter to return only resources that match the given display name exactly.
ListClustersRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListClustersRequest.Builder	lifecycleState(LifecycleStates lifecycleState) The lifecycle state of the resource.
ListClustersRequest.Builder	limit(Integer limit) For list pagination.
ListClustersRequest.Builder	opcRequestId(String opcRequestId) Unique 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	sddcId(String sddcId) The OCID of the SDDC.
ListClustersRequest.Builder	sortBy(ListClustersRequest.SortBy sortBy) The field to sort by.
ListClustersRequest.Builder	sortOrder(SortOrders sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).

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

sddcId

public ListClustersRequest.Builder sddcId(String sddcId)

The OCID of the SDDC.

Parameters:

sddcId - the value to set

Returns:

this builder instance

displayName

public ListClustersRequest.Builder displayName(String displayName)

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

Parameters:

displayName - 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. 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(SortOrders sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListClustersRequest.Builder sortBy(ListClustersRequest.SortBy sortBy)

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

*Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListClustersRequest.Builder opcRequestId(String opcRequestId)

Unique 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

lifecycleState

public ListClustersRequest.Builder lifecycleState(LifecycleStates lifecycleState)

The lifecycle state of the resource.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

compartmentId

public ListClustersRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment as optional parameter.

Parameters:

compartmentId - 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