com.oracle.bmc.capacitymanagement.requests

Class ListOccAvailabilityCatalogsRequest

java.lang.Object

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

com.oracle.bmc.capacitymanagement.requests.ListOccAvailabilityCatalogsRequest

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

Example: Click here to see how to use ListOccAvailabilityCatalogsRequest.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListOccAvailabilityCatalogsRequest()

Method Summary

Modifier and Type	Method and Description
static ListOccAvailabilityCatalogsRequest.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’.
OccAvailabilityCatalog.CatalogState	getCatalogState() Filter the list of availability catalogs based on the catalog state.
String	getCompartmentId() The ocid of the compartment or tenancy in which resources are to be listed.
String	getDisplayName() A filter to return only the resources that match the entire display name.
String	getId() The OCID of the availability catalog to filter the list of availability catalogs.
Integer	getLimit() The maximum number of items to return.
Namespace	getNamespace() The namespace by which we would filter the list.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() A token representing the position at which to start retrieving results.
ListOccAvailabilityCatalogsRequest.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.
ListOccAvailabilityCatalogsRequest.Builder	toBuilder() Return an instance of ListOccAvailabilityCatalogsRequest.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

ListOccAvailabilityCatalogsRequest

public ListOccAvailabilityCatalogsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.

getNamespace

public Namespace getNamespace()

The namespace by which we would filter the list.

getId

public String getId()

The OCID of the availability catalog to filter the list of availability catalogs.

getDisplayName

public String getDisplayName()

A filter to return only the resources that match the entire display name. The match is not case sensitive.

getCatalogState

public OccAvailabilityCatalog.CatalogState getCatalogState()

Filter the list of availability catalogs based on the catalog state.

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 opc-next-page header field of a previous response.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

public ListOccAvailabilityCatalogsRequest.SortBy getSortBy()

The field to sort by. Only one sort order may be provided. The default order for displayName is ascending. The default order for timeCreated is descending.

toBuilder

public ListOccAvailabilityCatalogsRequest.Builder toBuilder()

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

Returns:

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

builder

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