Package com.oracle.bmc.datacatalog.requests

Class ListCatalogsRequest.Builder

java.lang.Object

com.oracle.bmc.datacatalog.requests.ListCatalogsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCatalogsRequest,Void>

Enclosing class:

ListCatalogsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListCatalogsRequest	build()	Build the instance of ListCatalogsRequest as configured by this builder
ListCatalogsRequest	buildWithoutInvocationCallback()	Build the instance of ListCatalogsRequest as configured by this builder
ListCatalogsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment where you want to list resources.
ListCatalogsRequest.Builder	copy(ListCatalogsRequest o)	Copy method to populate the builder with values from the given instance.
ListCatalogsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListCatalogsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListCatalogsRequest.Builder	lifecycleState(LifecycleState lifecycleState)	A filter to return only resources that match the specified lifecycle state.
ListCatalogsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListCatalogsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListCatalogsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListCatalogsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListCatalogsRequest.Builder	sortBy(ListCatalogsRequest.SortBy sortBy)	The field to sort by.
ListCatalogsRequest.Builder	sortOrder(ListCatalogsRequest.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 ListCatalogsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment where you want to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

displayName

public ListCatalogsRequest.Builder displayName(String displayName)

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

The match is not case sensitive.

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListCatalogsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListCatalogsRequest.Builder page(String page)

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

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

lifecycleState

public ListCatalogsRequest.Builder lifecycleState(LifecycleState lifecycleState)

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

The value is case insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

sortOrder

public ListCatalogsRequest.Builder sortOrder(ListCatalogsRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListCatalogsRequest.Builder sortBy(ListCatalogsRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListCatalogsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListCatalogsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCatalogsRequest build()

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

Returns:

instance of ListCatalogsRequest

buildWithoutInvocationCallback

public ListCatalogsRequest buildWithoutInvocationCallback()

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