Package com.oracle.bmc.clusterplacementgroups.requests

Class ListClusterPlacementGroupsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.clusterplacementgroups.requests.ListClusterPlacementGroupsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230801")
public class ListClusterPlacementGroupsRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/clusterplacementgroups/ListClusterPlacementGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListClusterPlacementGroupsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListClusterPlacementGroupsRequest.Builder
static class	ListClusterPlacementGroupsRequest.SortBy	The field to sort by.

Constructor Summary

Constructors

Constructor	Description
ListClusterPlacementGroupsRequest()

Method Summary

Modifier and Type	Method	Description
static ListClusterPlacementGroupsRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getAd()	A filter to return only the resources that match the specified availability domain.
String	getCompartmentId()	A filter to return only the resources that match the specified compartment OCID.
Boolean	getCompartmentIdInSubtree()	When set to true, cluster placement groups in all compartments under the specified compartment are returned.
String	getId()	A filter to return only the resources that match the specified unique cluster placement group identifier.
ClusterPlacementGroup.LifecycleState	getLifecycleState()	A filter to return only the resources that match the specified lifecycle state.
Integer	getLimit()	The maximum number of items to return.
String	getName()	A filter to return only the resources that match the entire display name specified.
String	getOpcRequestId()	The client request ID for tracing.
String	getPage()	A token representing the position at which to start retrieving results.
ListClusterPlacementGroupsRequest.SortBy	getSortBy()	The field to sort by.
SortOrder	getSortOrder()	The sort order to use, either ‘ASC’ or ‘DESC’.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListClusterPlacementGroupsRequest.Builder	toBuilder()	Return an instance of ListClusterPlacementGroupsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListClusterPlacementGroupsRequest

public ListClusterPlacementGroupsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

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

getLifecycleState

public ClusterPlacementGroup.LifecycleState getLifecycleState()

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

getName

public String getName()

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

getAd

public String getAd()

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

getId

public String getId()

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

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

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.

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

public ListClusterPlacementGroupsRequest.SortBy getSortBy()

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.

getCompartmentIdInSubtree

public Boolean getCompartmentIdInSubtree()

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

The default is set to false.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListClusterPlacementGroupsRequest.Builder toBuilder()

Return an instance of ListClusterPlacementGroupsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListClusterPlacementGroupsRequest.Builder that allows you to modify request properties.

builder

public static ListClusterPlacementGroupsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>