com.oracle.bmc.nosql

Class NosqlAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.nosql.NosqlAsyncClient

All Implemented Interfaces:

NosqlAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190828")
public class NosqlAsyncClient
extends BaseAsyncClient
implements NosqlAsync

Async client implementation for Nosql service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NosqlAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Nosql.

Constructor Summary

Constructors

Constructor and Description
NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static NosqlAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeTableCompartmentResponse>	changeTableCompartment(ChangeTableCompartmentRequest request, AsyncHandler<ChangeTableCompartmentRequest,ChangeTableCompartmentResponse> handler) Change a table’s compartment.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateIndexResponse>	createIndex(CreateIndexRequest request, AsyncHandler<CreateIndexRequest,CreateIndexResponse> handler) Create a new index on the table identified by tableNameOrId.
Future<CreateReplicaResponse>	createReplica(CreateReplicaRequest request, AsyncHandler<CreateReplicaRequest,CreateReplicaResponse> handler) Add a replica for this table
Future<CreateTableResponse>	createTable(CreateTableRequest request, AsyncHandler<CreateTableRequest,CreateTableResponse> handler) Create a new table.
Future<DeleteIndexResponse>	deleteIndex(DeleteIndexRequest request, AsyncHandler<DeleteIndexRequest,DeleteIndexResponse> handler) Delete an index from the table identified by tableNameOrId.
Future<DeleteReplicaResponse>	deleteReplica(DeleteReplicaRequest request, AsyncHandler<DeleteReplicaRequest,DeleteReplicaResponse> handler) Delete the specified replica table in the remote region.
Future<DeleteRowResponse>	deleteRow(DeleteRowRequest request, AsyncHandler<DeleteRowRequest,DeleteRowResponse> handler) Delete a single row from the table, by primary key.
Future<DeleteTableResponse>	deleteTable(DeleteTableRequest request, AsyncHandler<DeleteTableRequest,DeleteTableResponse> handler) Delete a table by tableNameOrId.
Future<DeleteWorkRequestResponse>	deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler) Cancel a work request operation with the given ID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetIndexResponse>	getIndex(GetIndexRequest request, AsyncHandler<GetIndexRequest,GetIndexResponse> handler) Get information about a single index.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetRowResponse>	getRow(GetRowRequest request, AsyncHandler<GetRowRequest,GetRowResponse> handler) Get a single row from the table by primary key.
Future<GetTableResponse>	getTable(GetTableRequest request, AsyncHandler<GetTableRequest,GetTableResponse> handler) Get table info by identifier.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Get the status of the work request with the given ID.
Future<ListIndexesResponse>	listIndexes(ListIndexesRequest request, AsyncHandler<ListIndexesRequest,ListIndexesResponse> handler) Get a list of indexes on a table.
Future<ListTablesResponse>	listTables(ListTablesRequest request, AsyncHandler<ListTablesRequest,ListTablesResponse> handler) Get a list of tables in a compartment.
Future<ListTableUsageResponse>	listTableUsage(ListTableUsageRequest request, AsyncHandler<ListTableUsageRequest,ListTableUsageResponse> handler) Get table usage info.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Return a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Return a (paginated) list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) List the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
Future<PrepareStatementResponse>	prepareStatement(PrepareStatementRequest request, AsyncHandler<PrepareStatementRequest,PrepareStatementResponse> handler) Prepare a SQL statement for use in a query with variable substitution.
Future<QueryResponse>	query(QueryRequest request, AsyncHandler<QueryRequest,QueryResponse> handler) Execute a SQL query.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<SummarizeStatementResponse>	summarizeStatement(SummarizeStatementRequest request, AsyncHandler<SummarizeStatementRequest,SummarizeStatementResponse> handler) Check the syntax and return a brief summary of a SQL statement.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateRowResponse>	updateRow(UpdateRowRequest request, AsyncHandler<UpdateRowRequest,UpdateRowResponse> handler) Write a single row into the table.
Future<UpdateTableResponse>	updateTable(UpdateTableRequest request, AsyncHandler<UpdateTableRequest,UpdateTableResponse> handler) Alter the table identified by tableNameOrId, changing schema, limits, or tags
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

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.nosql.NosqlAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Nosql.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

NosqlAsyncClient

@Deprecated
public NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NosqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

NosqlAsyncClient

@Deprecated
public NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NosqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

NosqlAsyncClient

@Deprecated
public NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NosqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

NosqlAsyncClient

@Deprecated
public NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NosqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

NosqlAsyncClient

@Deprecated
public NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NosqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

NosqlAsyncClient

@Deprecated
public NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NosqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

NosqlAsyncClient

@Deprecated
public NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NosqlAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static NosqlAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: NosqlAsync

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface NosqlAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: NosqlAsync

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface NosqlAsync

Parameters:

regionId - The public region ID.

changeTableCompartment

public Future<ChangeTableCompartmentResponse> changeTableCompartment(ChangeTableCompartmentRequest request,
                                                                     AsyncHandler<ChangeTableCompartmentRequest,ChangeTableCompartmentResponse> handler)

Description copied from interface: NosqlAsync

Change a table’s compartment.

Specified by:

changeTableCompartment in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createIndex

public Future<CreateIndexResponse> createIndex(CreateIndexRequest request,
                                               AsyncHandler<CreateIndexRequest,CreateIndexResponse> handler)

Description copied from interface: NosqlAsync

Create a new index on the table identified by tableNameOrId.

Specified by:

createIndex in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createReplica

public Future<CreateReplicaResponse> createReplica(CreateReplicaRequest request,
                                                   AsyncHandler<CreateReplicaRequest,CreateReplicaResponse> handler)

Description copied from interface: NosqlAsync

Add a replica for this table

Specified by:

createReplica in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createTable

public Future<CreateTableResponse> createTable(CreateTableRequest request,
                                               AsyncHandler<CreateTableRequest,CreateTableResponse> handler)

Description copied from interface: NosqlAsync

Create a new table.

Specified by:

createTable in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteIndex

public Future<DeleteIndexResponse> deleteIndex(DeleteIndexRequest request,
                                               AsyncHandler<DeleteIndexRequest,DeleteIndexResponse> handler)

Description copied from interface: NosqlAsync

Delete an index from the table identified by tableNameOrId.

Specified by:

deleteIndex in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteReplica

public Future<DeleteReplicaResponse> deleteReplica(DeleteReplicaRequest request,
                                                   AsyncHandler<DeleteReplicaRequest,DeleteReplicaResponse> handler)

Description copied from interface: NosqlAsync

Delete the specified replica table in the remote region.

Specified by:

deleteReplica in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteRow

public Future<DeleteRowResponse> deleteRow(DeleteRowRequest request,
                                           AsyncHandler<DeleteRowRequest,DeleteRowResponse> handler)

Description copied from interface: NosqlAsync

Delete a single row from the table, by primary key.

Specified by:

deleteRow in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteTable

public Future<DeleteTableResponse> deleteTable(DeleteTableRequest request,
                                               AsyncHandler<DeleteTableRequest,DeleteTableResponse> handler)

Description copied from interface: NosqlAsync

Delete a table by tableNameOrId.

Specified by:

deleteTable in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteWorkRequest

public Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request,
                                                           AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)

Description copied from interface: NosqlAsync

Cancel a work request operation with the given ID.

Specified by:

deleteWorkRequest in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getIndex

public Future<GetIndexResponse> getIndex(GetIndexRequest request,
                                         AsyncHandler<GetIndexRequest,GetIndexResponse> handler)

Description copied from interface: NosqlAsync

Get information about a single index.

Specified by:

getIndex in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getRow

public Future<GetRowResponse> getRow(GetRowRequest request,
                                     AsyncHandler<GetRowRequest,GetRowResponse> handler)

Description copied from interface: NosqlAsync

Get a single row from the table by primary key.

Specified by:

getRow in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getTable

public Future<GetTableResponse> getTable(GetTableRequest request,
                                         AsyncHandler<GetTableRequest,GetTableResponse> handler)

Description copied from interface: NosqlAsync

Get table info by identifier.

Specified by:

getTable in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: NosqlAsync

Get the status of the work request with the given ID.

Specified by:

getWorkRequest in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listIndexes

public Future<ListIndexesResponse> listIndexes(ListIndexesRequest request,
                                               AsyncHandler<ListIndexesRequest,ListIndexesResponse> handler)

Description copied from interface: NosqlAsync

Get a list of indexes on a table.

Specified by:

listIndexes in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listTableUsage

public Future<ListTableUsageResponse> listTableUsage(ListTableUsageRequest request,
                                                     AsyncHandler<ListTableUsageRequest,ListTableUsageResponse> handler)

Description copied from interface: NosqlAsync

Get table usage info.

Specified by:

listTableUsage in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listTables

public Future<ListTablesResponse> listTables(ListTablesRequest request,
                                             AsyncHandler<ListTablesRequest,ListTablesResponse> handler)

Description copied from interface: NosqlAsync

Get a list of tables in a compartment.

Specified by:

listTables in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: NosqlAsync

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: NosqlAsync

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: NosqlAsync

List the work requests in a compartment.

Specified by:

listWorkRequests in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

prepareStatement

public Future<PrepareStatementResponse> prepareStatement(PrepareStatementRequest request,
                                                         AsyncHandler<PrepareStatementRequest,PrepareStatementResponse> handler)

Description copied from interface: NosqlAsync

Prepare a SQL statement for use in a query with variable substitution.

Specified by:

prepareStatement in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

query

public Future<QueryResponse> query(QueryRequest request,
                                   AsyncHandler<QueryRequest,QueryResponse> handler)

Description copied from interface: NosqlAsync

Execute a SQL query.

Specified by:

query in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

summarizeStatement

public Future<SummarizeStatementResponse> summarizeStatement(SummarizeStatementRequest request,
                                                             AsyncHandler<SummarizeStatementRequest,SummarizeStatementResponse> handler)

Description copied from interface: NosqlAsync

Check the syntax and return a brief summary of a SQL statement.

Specified by:

summarizeStatement in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateRow

public Future<UpdateRowResponse> updateRow(UpdateRowRequest request,
                                           AsyncHandler<UpdateRowRequest,UpdateRowResponse> handler)

Description copied from interface: NosqlAsync

Write a single row into the table.

Specified by:

updateRow in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateTable

public Future<UpdateTableResponse> updateTable(UpdateTableRequest request,
                                               AsyncHandler<UpdateTableRequest,UpdateTableResponse> handler)

Description copied from interface: NosqlAsync

Alter the table identified by tableNameOrId, changing schema, limits, or tags

Specified by:

updateTable in interface NosqlAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)