com.oracle.bmc.nosql.requests

Class GetIndexRequest.Builder

java.lang.Object

com.oracle.bmc.nosql.requests.GetIndexRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<GetIndexRequest,Void>

Enclosing class:

GetIndexRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GetIndexRequest	build() Build the instance of GetIndexRequest as configured by this builder
GetIndexRequest	buildWithoutInvocationCallback() Build the instance of GetIndexRequest as configured by this builder
GetIndexRequest.Builder	compartmentId(String compartmentId) The ID of a table’s compartment.
GetIndexRequest.Builder	copy(GetIndexRequest o) Copy method to populate the builder with values from the given instance.
GetIndexRequest.Builder	indexName(String indexName) The name of a table’s index.
GetIndexRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
GetIndexRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
GetIndexRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
GetIndexRequest.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 GetIndexRequest.Builder tableNameOrId(String tableNameOrId)

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

Parameters:

tableNameOrId - the value to set

Returns:

this builder instance

indexName

public GetIndexRequest.Builder indexName(String indexName)

The name of a table’s index.

Parameters:

indexName - the value to set

Returns:

this builder instance

compartmentId

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

opcRequestId

public GetIndexRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<GetIndexRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public GetIndexRequest build()

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

Returns:

instance of GetIndexRequest

buildWithoutInvocationCallback

public GetIndexRequest buildWithoutInvocationCallback()

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