Package com.oracle.bmc.capacitymanagement.requests

Class ListOccAvailabilityCatalogsRequest.Builder

java.lang.Object

com.oracle.bmc.capacitymanagement.requests.ListOccAvailabilityCatalogsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListOccAvailabilityCatalogsRequest,Void>

Enclosing class:

ListOccAvailabilityCatalogsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListOccAvailabilityCatalogsRequest	build()	Build the instance of ListOccAvailabilityCatalogsRequest as configured by this builder
ListOccAvailabilityCatalogsRequest	buildWithoutInvocationCallback()	Build the instance of ListOccAvailabilityCatalogsRequest as configured by this builder
ListOccAvailabilityCatalogsRequest.Builder	catalogState(OccAvailabilityCatalog.CatalogState catalogState)	Filter the list of availability catalogs based on the catalog state.
ListOccAvailabilityCatalogsRequest.Builder	compartmentId(String compartmentId)	The ocid of the compartment or tenancy in which resources are to be listed.
ListOccAvailabilityCatalogsRequest.Builder	copy(ListOccAvailabilityCatalogsRequest o)	Copy method to populate the builder with values from the given instance.
ListOccAvailabilityCatalogsRequest.Builder	displayName(String displayName)	A filter to return only the resources that match the entire display name.
ListOccAvailabilityCatalogsRequest.Builder	id(String id)	The OCID of the availability catalog to filter the list of availability catalogs.
ListOccAvailabilityCatalogsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListOccAvailabilityCatalogsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListOccAvailabilityCatalogsRequest.Builder	namespace(Namespace namespace)	The namespace by which we would filter the list.
ListOccAvailabilityCatalogsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListOccAvailabilityCatalogsRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListOccAvailabilityCatalogsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListOccAvailabilityCatalogsRequest.Builder	sortBy(ListOccAvailabilityCatalogsRequest.SortBy sortBy)	The field to sort by.
ListOccAvailabilityCatalogsRequest.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 ListOccAvailabilityCatalogsRequest.Builder compartmentId(String compartmentId)

The ocid of the compartment or tenancy in which resources are to be listed.

This will also be used for authorization purposes.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

namespace

public ListOccAvailabilityCatalogsRequest.Builder namespace(Namespace namespace)

The namespace by which we would filter the list.

Parameters:

namespace - the value to set

Returns:

this builder instance

id

public ListOccAvailabilityCatalogsRequest.Builder id(String id)

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

Parameters:

id - the value to set

Returns:

this builder instance

displayName

public ListOccAvailabilityCatalogsRequest.Builder displayName(String displayName)

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

The match is not case sensitive.

Parameters:

displayName - the value to set

Returns:

this builder instance

catalogState

public ListOccAvailabilityCatalogsRequest.Builder catalogState(OccAvailabilityCatalog.CatalogState catalogState)

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

Parameters:

catalogState - the value to set

Returns:

this builder instance

limit

public ListOccAvailabilityCatalogsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListOccAvailabilityCatalogsRequest.Builder page(String page)

A token representing the position at which to start retrieving results.

This must come from opc-next-page header field of a previous response.

Parameters:

page - the value to set

Returns:

this builder instance

opcRequestId

public ListOccAvailabilityCatalogsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

sortOrder

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

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListOccAvailabilityCatalogsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListOccAvailabilityCatalogsRequest build()

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

Returns:

instance of ListOccAvailabilityCatalogsRequest

buildWithoutInvocationCallback

public ListOccAvailabilityCatalogsRequest buildWithoutInvocationCallback()

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