Package com.oracle.bmc.opensearch.requests

Class ListOpensearchClustersRequest

java.lang.Object

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

com.oracle.bmc.opensearch.requests.ListOpensearchClustersRequest

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

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ListOpensearchClustersRequest()

Method Summary

Modifier and Type	Method	Description
static ListOpensearchClustersRequest.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	getCompartmentId()	The ID of the compartment in which to list resources.
String	getDisplayName()	A filter to return only resources that match the entire display name given.
String	getId()	unique OpensearchCluster identifier
OpensearchCluster.LifecycleState	getLifecycleState()	A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState.
Integer	getLimit()	The maximum number of items to return.
String	getOpcRequestId()	The client request ID for tracing.
String	getPage()	The page token representing the page at which to start retrieving results.
ListOpensearchClustersRequest.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.
ListOpensearchClustersRequest.Builder	toBuilder()	Return an instance of ListOpensearchClustersRequest.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

ListOpensearchClustersRequest

public ListOpensearchClustersRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The ID of the compartment in which to list resources.

getLifecycleState

public OpensearchCluster.LifecycleState getLifecycleState()

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

getDisplayName

public String getDisplayName()

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

getId

public String getId()

unique OpensearchCluster identifier

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

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

This is usually retrieved from a previous list call.

getSortOrder

public SortOrder getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’.

getSortBy

public ListOpensearchClustersRequest.SortBy getSortBy()

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.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListOpensearchClustersRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListOpensearchClustersRequest.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>