@Generated(value="OracleSDKGenerator", comments="API Version: 20190828") public class NosqlAsyncClient extends Object implements NosqlAsync
Async client implementation for Nosql service.
There are two ways to use async client:
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. Modifier and Type | Class and Description |
---|---|
static class |
NosqlAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Nosql.
|
Constructor and Description |
---|
NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for Nosql.
public NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public NosqlAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public NosqlAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)restClientFactoryBuilder
- the builder for the RestClientFactory
public static NosqlAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
NosqlAsync
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface NosqlAsync
endpoint
- The endpoint of the serice.public String getEndpoint()
NosqlAsync
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface NosqlAsync
public void setRegion(Region region)
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.
setRegion
in interface NosqlAsync
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface NosqlAsync
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public Future<ChangeTableCompartmentResponse> changeTableCompartment(ChangeTableCompartmentRequest request, AsyncHandler<ChangeTableCompartmentRequest,ChangeTableCompartmentResponse> handler)
NosqlAsync
Change a table’s compartment.
changeTableCompartment
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateIndexResponse> createIndex(CreateIndexRequest request, AsyncHandler<CreateIndexRequest,CreateIndexResponse> handler)
NosqlAsync
Create a new index on the table identified by tableNameOrId.
createIndex
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateTableResponse> createTable(CreateTableRequest request, AsyncHandler<CreateTableRequest,CreateTableResponse> handler)
NosqlAsync
Create a new table.
createTable
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteIndexResponse> deleteIndex(DeleteIndexRequest request, AsyncHandler<DeleteIndexRequest,DeleteIndexResponse> handler)
NosqlAsync
Delete an index from the table identified by tableNameOrId.
deleteIndex
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteRowResponse> deleteRow(DeleteRowRequest request, AsyncHandler<DeleteRowRequest,DeleteRowResponse> handler)
NosqlAsync
Delete a single row from the table, by primary key.
deleteRow
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteTableResponse> deleteTable(DeleteTableRequest request, AsyncHandler<DeleteTableRequest,DeleteTableResponse> handler)
NosqlAsync
Delete a table by tableNameOrId.
deleteTable
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)
NosqlAsync
Cancel a work request operation with the given ID.
deleteWorkRequest
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetIndexResponse> getIndex(GetIndexRequest request, AsyncHandler<GetIndexRequest,GetIndexResponse> handler)
NosqlAsync
Get information about a single index.
getIndex
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetRowResponse> getRow(GetRowRequest request, AsyncHandler<GetRowRequest,GetRowResponse> handler)
NosqlAsync
Get a single row from the table by primary key.
getRow
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetTableResponse> getTable(GetTableRequest request, AsyncHandler<GetTableRequest,GetTableResponse> handler)
NosqlAsync
Get table info by identifier.
getTable
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
NosqlAsync
Get the status of the work request with the given ID.
getWorkRequest
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListIndexesResponse> listIndexes(ListIndexesRequest request, AsyncHandler<ListIndexesRequest,ListIndexesResponse> handler)
NosqlAsync
Get a list of indexes on a table.
listIndexes
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTableUsageResponse> listTableUsage(ListTableUsageRequest request, AsyncHandler<ListTableUsageRequest,ListTableUsageResponse> handler)
NosqlAsync
Get table usage info.
listTableUsage
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTablesResponse> listTables(ListTablesRequest request, AsyncHandler<ListTablesRequest,ListTablesResponse> handler)
NosqlAsync
Get a list of tables in a compartment.
listTables
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
NosqlAsync
Return a (paginated) list of errors for a given work request.
listWorkRequestErrors
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
NosqlAsync
Return a (paginated) list of logs for a given work request.
listWorkRequestLogs
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
NosqlAsync
List the work requests in a compartment.
listWorkRequests
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<PrepareStatementResponse> prepareStatement(PrepareStatementRequest request, AsyncHandler<PrepareStatementRequest,PrepareStatementResponse> handler)
NosqlAsync
Prepare a SQL statement for use in a query with variable substitution.
prepareStatement
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<QueryResponse> query(QueryRequest request, AsyncHandler<QueryRequest,QueryResponse> handler)
NosqlAsync
Execute a SQL query.
query
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<SummarizeStatementResponse> summarizeStatement(SummarizeStatementRequest request, AsyncHandler<SummarizeStatementRequest,SummarizeStatementResponse> handler)
NosqlAsync
Check the syntax and return a brief summary of a SQL statement.
summarizeStatement
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateRowResponse> updateRow(UpdateRowRequest request, AsyncHandler<UpdateRowRequest,UpdateRowResponse> handler)
NosqlAsync
Write a single row into the table.
updateRow
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateTableResponse> updateTable(UpdateTableRequest request, AsyncHandler<UpdateTableRequest,UpdateTableResponse> handler)
NosqlAsync
Alter the table identified by tableNameOrId, changing schema, limits, or tags
updateTable
in interface NosqlAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.