Package com.oracle.bmc.clusterplacementgroups.requests

Class ListClusterPlacementGroupsRequest.Builder

java.lang.Object

com.oracle.bmc.clusterplacementgroups.requests.ListClusterPlacementGroupsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListClusterPlacementGroupsRequest,Void>

Enclosing class:

ListClusterPlacementGroupsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListClusterPlacementGroupsRequest.Builder	ad(String ad)	A filter to return only the resources that match the specified availability domain.
ListClusterPlacementGroupsRequest	build()	Build the instance of ListClusterPlacementGroupsRequest as configured by this builder
ListClusterPlacementGroupsRequest	buildWithoutInvocationCallback()	Build the instance of ListClusterPlacementGroupsRequest as configured by this builder
ListClusterPlacementGroupsRequest.Builder	compartmentId(String compartmentId)	A filter to return only the resources that match the specified compartment OCID.
ListClusterPlacementGroupsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	When set to true, cluster placement groups in all compartments under the specified compartment are returned.
ListClusterPlacementGroupsRequest.Builder	copy(ListClusterPlacementGroupsRequest o)	Copy method to populate the builder with values from the given instance.
ListClusterPlacementGroupsRequest.Builder	id(String id)	A filter to return only the resources that match the specified unique cluster placement group identifier.
ListClusterPlacementGroupsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListClusterPlacementGroupsRequest.Builder	lifecycleState(ClusterPlacementGroup.LifecycleState lifecycleState)	A filter to return only the resources that match the specified lifecycle state.
ListClusterPlacementGroupsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListClusterPlacementGroupsRequest.Builder	name(String name)	A filter to return only the resources that match the entire display name specified.
ListClusterPlacementGroupsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListClusterPlacementGroupsRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListClusterPlacementGroupsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListClusterPlacementGroupsRequest.Builder	sortBy(ListClusterPlacementGroupsRequest.SortBy sortBy)	The field to sort by.
ListClusterPlacementGroupsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘ASC’ or ‘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

compartmentId

public ListClusterPlacementGroupsRequest.Builder compartmentId(String compartmentId)

A filter to return only the resources that match the specified compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListClusterPlacementGroupsRequest.Builder lifecycleState(ClusterPlacementGroup.LifecycleState lifecycleState)

A filter to return only the resources that match the specified lifecycle state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

name

public ListClusterPlacementGroupsRequest.Builder name(String name)

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

Parameters:

name - the value to set

Returns:

this builder instance

ad

public ListClusterPlacementGroupsRequest.Builder ad(String ad)

A filter to return only the resources that match the specified availability domain.

Parameters:

ad - the value to set

Returns:

this builder instance

id

public ListClusterPlacementGroupsRequest.Builder id(String id)

A filter to return only the resources that match the specified unique cluster placement group identifier.

Parameters:

id - the value to set

Returns:

this builder instance

limit

public ListClusterPlacementGroupsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListClusterPlacementGroupsRequest.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 ListClusterPlacementGroupsRequest.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 ListClusterPlacementGroupsRequest.Builder sortBy(ListClusterPlacementGroupsRequest.SortBy sortBy)

The field to sort by.

You can specify only one sort order. The default order for timeCreated is descending. The default order for name is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListClusterPlacementGroupsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

When set to true, cluster placement groups in all compartments under the specified compartment are returned.

The default is set to false.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

opcRequestId

public ListClusterPlacementGroupsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListClusterPlacementGroupsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListClusterPlacementGroupsRequest build()

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

Returns:

instance of ListClusterPlacementGroupsRequest

buildWithoutInvocationCallback

public ListClusterPlacementGroupsRequest buildWithoutInvocationCallback()

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