NosqlAsync (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

NosqlAsyncClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190828")
public interface NosqlAsync
extends AutoCloseable
```
The control plane API for NoSQL Database Cloud Service HTTPS provides endpoints to perform NDCS operations, including creation and deletion of tables and indexes; population and access of data in tables; and access of table usage metrics.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<ChangeTableCompartmentResponse>`	`changeTableCompartment(ChangeTableCompartmentRequest request, AsyncHandler<ChangeTableCompartmentRequest,ChangeTableCompartmentResponse> handler)` Change a table’s compartment.
`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`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`Future<GetIndexResponse>`	`getIndex(GetIndexRequest request, AsyncHandler<GetIndexRequest,GetIndexResponse> handler)` Get information about a single index.
`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.
`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()` Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`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.
`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 realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the serice.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    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.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - changeTableCompartment
```
Future<ChangeTableCompartmentResponse> changeTableCompartment(ChangeTableCompartmentRequest request,
                                                              AsyncHandler<ChangeTableCompartmentRequest,ChangeTableCompartmentResponse> handler)
```
    Change a table’s compartment.
    
    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
```
Future<CreateIndexResponse> createIndex(CreateIndexRequest request,
                                        AsyncHandler<CreateIndexRequest,CreateIndexResponse> handler)
```
    Create a new index on the table identified by tableNameOrId.
    
    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
```
Future<CreateReplicaResponse> createReplica(CreateReplicaRequest request,
                                            AsyncHandler<CreateReplicaRequest,CreateReplicaResponse> handler)
```
    Add a replica for this table
    
    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
```
Future<CreateTableResponse> createTable(CreateTableRequest request,
                                        AsyncHandler<CreateTableRequest,CreateTableResponse> handler)
```
    Create a new table.
    
    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
```
Future<DeleteIndexResponse> deleteIndex(DeleteIndexRequest request,
                                        AsyncHandler<DeleteIndexRequest,DeleteIndexResponse> handler)
```
    Delete an index from the table identified by tableNameOrId.
    
    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
```
Future<DeleteReplicaResponse> deleteReplica(DeleteReplicaRequest request,
                                            AsyncHandler<DeleteReplicaRequest,DeleteReplicaResponse> handler)
```
    Delete the specified replica table in the remote region.
    
    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
```
Future<DeleteRowResponse> deleteRow(DeleteRowRequest request,
                                    AsyncHandler<DeleteRowRequest,DeleteRowResponse> handler)
```
    Delete a single row from the table, by primary key.
    
    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
```
Future<DeleteTableResponse> deleteTable(DeleteTableRequest request,
                                        AsyncHandler<DeleteTableRequest,DeleteTableResponse> handler)
```
    Delete a table by tableNameOrId.
    
    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
```
Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request,
                                                    AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)
```
    Cancel a work request operation with the given ID.
    
    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
```
Future<GetIndexResponse> getIndex(GetIndexRequest request,
                                  AsyncHandler<GetIndexRequest,GetIndexResponse> handler)
```
    Get information about a single index.
    
    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
```
Future<GetRowResponse> getRow(GetRowRequest request,
                              AsyncHandler<GetRowRequest,GetRowResponse> handler)
```
    Get a single row from the table by primary key.
    
    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
```
Future<GetTableResponse> getTable(GetTableRequest request,
                                  AsyncHandler<GetTableRequest,GetTableResponse> handler)
```
    Get table info by identifier.
    
    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
```
Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
```
    Get the status of the work request with the given ID.
    
    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
```
Future<ListIndexesResponse> listIndexes(ListIndexesRequest request,
                                        AsyncHandler<ListIndexesRequest,ListIndexesResponse> handler)
```
    Get a list of indexes on a table.
    
    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
```
Future<ListTableUsageResponse> listTableUsage(ListTableUsageRequest request,
                                              AsyncHandler<ListTableUsageRequest,ListTableUsageResponse> handler)
```
    Get table usage info.
    
    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
```
Future<ListTablesResponse> listTables(ListTablesRequest request,
                                      AsyncHandler<ListTablesRequest,ListTablesResponse> handler)
```
    Get a list of tables in a compartment.
    
    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
```
Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
```
    Return a (paginated) list of errors for a given work request.
    
    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
```
Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
```
    Return a (paginated) list of logs for a given work request.
    
    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
```
Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
```
    List the work requests in a compartment.
    
    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
```
Future<PrepareStatementResponse> prepareStatement(PrepareStatementRequest request,
                                                  AsyncHandler<PrepareStatementRequest,PrepareStatementResponse> handler)
```
    Prepare a SQL statement for use in a query with variable substitution.
    
    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
```
Future<QueryResponse> query(QueryRequest request,
                            AsyncHandler<QueryRequest,QueryResponse> handler)
```
    Execute a SQL query.
    
    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
```
Future<SummarizeStatementResponse> summarizeStatement(SummarizeStatementRequest request,
                                                      AsyncHandler<SummarizeStatementRequest,SummarizeStatementResponse> handler)
```
    Check the syntax and return a brief summary of a SQL statement.
    
    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
```
Future<UpdateRowResponse> updateRow(UpdateRowRequest request,
                                    AsyncHandler<UpdateRowRequest,UpdateRowResponse> handler)
```
    Write a single row into the table.
    
    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
```
Future<UpdateTableResponse> updateTable(UpdateTableRequest request,
                                        AsyncHandler<UpdateTableRequest,UpdateTableResponse> handler)
```
    Alter the table identified by tableNameOrId, changing schema, limits, or tags
    
    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.

Interface NosqlAsync

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeTableCompartment

createIndex

createReplica

createTable

deleteIndex

deleteReplica

deleteRow

deleteTable

deleteWorkRequest

getIndex

getRow

getTable

getWorkRequest

listIndexes

listTableUsage

listTables

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

prepareStatement

query

summarizeStatement

updateRow

updateTable