Package com.oracle.bmc.nosql.requests

Class ListIndexesRequest.Builder

java.lang.Object

com.oracle.bmc.nosql.requests.ListIndexesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListIndexesRequest,Void>

Enclosing class:

ListIndexesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListIndexesRequest	build()	Build the instance of ListIndexesRequest as configured by this builder
ListIndexesRequest	buildWithoutInvocationCallback()	Build the instance of ListIndexesRequest as configured by this builder
ListIndexesRequest.Builder	compartmentId(String compartmentId)	The ID of a table’s compartment.
ListIndexesRequest.Builder	copy(ListIndexesRequest o)	Copy method to populate the builder with values from the given instance.
ListIndexesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListIndexesRequest.Builder	lifecycleState(ListIndexesRequest.LifecycleState lifecycleState)	Filter list by the lifecycle state of the item.
ListIndexesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListIndexesRequest.Builder	name(String name)	A shell-globbing-style (*?[]) filter for names.
ListIndexesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListIndexesRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListIndexesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListIndexesRequest.Builder	sortBy(ListIndexesRequest.SortBy sortBy)	The field to sort by.
ListIndexesRequest.Builder	sortOrder(ListIndexesRequest.SortOrder sortOrder)	The sort order to use, either ‘ASC’ or ‘DESC’.
ListIndexesRequest.Builder	tableNameOrId(String tableNameOrId)	A table name within the compartment, or a table OCID.

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

tableNameOrId

public ListIndexesRequest.Builder tableNameOrId(String tableNameOrId)

A table name within the compartment, or a table OCID.

Parameters:

tableNameOrId - the value to set

Returns:

this builder instance

compartmentId

public ListIndexesRequest.Builder compartmentId(String compartmentId)

The ID of a table’s compartment.

When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

name

public ListIndexesRequest.Builder name(String name)

A shell-globbing-style (*?[]) filter for names.

Parameters:

name - the value to set

Returns:

this builder instance

lifecycleState

public ListIndexesRequest.Builder lifecycleState(ListIndexesRequest.LifecycleState lifecycleState)

Filter list by the lifecycle state of the item.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

limit

public ListIndexesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListIndexesRequest.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

sortOrder

public ListIndexesRequest.Builder sortOrder(ListIndexesRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListIndexesRequest.Builder sortBy(ListIndexesRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListIndexesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListIndexesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListIndexesRequest build()

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

Returns:

instance of ListIndexesRequest

buildWithoutInvocationCallback

public ListIndexesRequest buildWithoutInvocationCallback()

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