@Generated(value="OracleSDKGenerator", comments="API Version: 20190828") public class NosqlClient extends Object implements Nosql
Modifier and Type | Class and Description |
---|---|
static class |
NosqlClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Nosql.
|
Modifier | Constructor and Description |
---|---|
|
NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
NosqlClient(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.
|
|
NosqlClient(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.
|
|
NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
NosqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
NosqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
NosqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static NosqlClient.Builder |
builder()
Create a builder for this client.
|
ChangeTableCompartmentResponse |
changeTableCompartment(ChangeTableCompartmentRequest request)
Change a table’s compartment.
|
void |
close() |
CreateIndexResponse |
createIndex(CreateIndexRequest request)
Create a new index on the table identified by tableNameOrId.
|
CreateTableResponse |
createTable(CreateTableRequest request)
Create a new table.
|
DeleteIndexResponse |
deleteIndex(DeleteIndexRequest request)
Delete an index from the table identified by tableNameOrId.
|
DeleteRowResponse |
deleteRow(DeleteRowRequest request)
Delete a single row from the table, by primary key.
|
DeleteTableResponse |
deleteTable(DeleteTableRequest request)
Delete a table by tableNameOrId.
|
DeleteWorkRequestResponse |
deleteWorkRequest(DeleteWorkRequestRequest request)
Cancel a work request operation with the given ID.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetIndexResponse |
getIndex(GetIndexRequest request)
Get information about a single index.
|
NosqlPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
GetRowResponse |
getRow(GetRowRequest request)
Get a single row from the table by primary key.
|
GetTableResponse |
getTable(GetTableRequest request)
Get table info by identifier.
|
NosqlWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Get the status of the work request with the given ID.
|
ListIndexesResponse |
listIndexes(ListIndexesRequest request)
Get a list of indexes on a table.
|
ListTablesResponse |
listTables(ListTablesRequest request)
Get a list of tables in a compartment.
|
ListTableUsageResponse |
listTableUsage(ListTableUsageRequest request)
Get table usage info.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
List the work requests in a compartment.
|
PrepareStatementResponse |
prepareStatement(PrepareStatementRequest request)
Prepare a SQL statement for use in a query with variable substitution.
|
QueryResponse |
query(QueryRequest request)
Execute a SQL query.
|
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’).
|
SummarizeStatementResponse |
summarizeStatement(SummarizeStatementRequest request)
Check the syntax and return a brief summary of a SQL statement.
|
UpdateRowResponse |
updateRow(UpdateRowRequest request)
Write a single row into the table.
|
UpdateTableResponse |
updateTable(UpdateTableRequest request)
Alter the table identified by tableNameOrId,
changing schema, limits, or tags
|
public static final Service SERVICE
Service instance for Nosql.
public NosqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public NosqlClient(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 NosqlClient(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 NosqlClient(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 NosqlClient(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 NosqlClient(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 NosqlClient(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 NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
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
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, com.oracle.bmc.http.internal.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.
Use the NosqlClient.Builder
to get access to all these parameters.
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
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static NosqlClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
Nosql
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Nosql
endpoint
- The endpoint of the service.public String getEndpoint()
Nosql
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface Nosql
public void setRegion(Region region)
Nosql
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.
public void setRegion(String regionId)
Nosql
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
.
public void close()
close
in interface AutoCloseable
public ChangeTableCompartmentResponse changeTableCompartment(ChangeTableCompartmentRequest request)
Nosql
Change a table’s compartment.
changeTableCompartment
in interface Nosql
request
- The request object containing the details to sendpublic CreateIndexResponse createIndex(CreateIndexRequest request)
Nosql
Create a new index on the table identified by tableNameOrId.
createIndex
in interface Nosql
request
- The request object containing the details to sendpublic CreateTableResponse createTable(CreateTableRequest request)
Nosql
Create a new table.
createTable
in interface Nosql
request
- The request object containing the details to sendpublic DeleteIndexResponse deleteIndex(DeleteIndexRequest request)
Nosql
Delete an index from the table identified by tableNameOrId.
deleteIndex
in interface Nosql
request
- The request object containing the details to sendpublic DeleteRowResponse deleteRow(DeleteRowRequest request)
Nosql
Delete a single row from the table, by primary key.
public DeleteTableResponse deleteTable(DeleteTableRequest request)
Nosql
Delete a table by tableNameOrId.
deleteTable
in interface Nosql
request
- The request object containing the details to sendpublic DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)
Nosql
Cancel a work request operation with the given ID.
deleteWorkRequest
in interface Nosql
request
- The request object containing the details to sendpublic GetIndexResponse getIndex(GetIndexRequest request)
Nosql
Get information about a single index.
public GetRowResponse getRow(GetRowRequest request)
Nosql
Get a single row from the table by primary key.
public GetTableResponse getTable(GetTableRequest request)
Nosql
Get table info by identifier.
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Nosql
Get the status of the work request with the given ID.
getWorkRequest
in interface Nosql
request
- The request object containing the details to sendpublic ListIndexesResponse listIndexes(ListIndexesRequest request)
Nosql
Get a list of indexes on a table.
listIndexes
in interface Nosql
request
- The request object containing the details to sendpublic ListTableUsageResponse listTableUsage(ListTableUsageRequest request)
Nosql
Get table usage info.
listTableUsage
in interface Nosql
request
- The request object containing the details to sendpublic ListTablesResponse listTables(ListTablesRequest request)
Nosql
Get a list of tables in a compartment.
listTables
in interface Nosql
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Nosql
Return a (paginated) list of errors for a given work request.
listWorkRequestErrors
in interface Nosql
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Nosql
Return a (paginated) list of logs for a given work request.
listWorkRequestLogs
in interface Nosql
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Nosql
List the work requests in a compartment.
listWorkRequests
in interface Nosql
request
- The request object containing the details to sendpublic PrepareStatementResponse prepareStatement(PrepareStatementRequest request)
Nosql
Prepare a SQL statement for use in a query with variable substitution.
prepareStatement
in interface Nosql
request
- The request object containing the details to sendpublic QueryResponse query(QueryRequest request)
Nosql
Execute a SQL query.
public SummarizeStatementResponse summarizeStatement(SummarizeStatementRequest request)
Nosql
Check the syntax and return a brief summary of a SQL statement.
summarizeStatement
in interface Nosql
request
- The request object containing the details to sendpublic UpdateRowResponse updateRow(UpdateRowRequest request)
Nosql
Write a single row into the table.
public UpdateTableResponse updateTable(UpdateTableRequest request)
Nosql
Alter the table identified by tableNameOrId, changing schema, limits, or tags
updateTable
in interface Nosql
request
- The request object containing the details to sendpublic NosqlWaiters getWaiters()
Nosql
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Nosql
public NosqlPaginators getPaginators()
Nosql
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data. These paginators provide an Iterable
interface so that service responses, or
resources/records, can be iterated through without having to manually deal with pagination and page tokens.
getPaginators
in interface Nosql
Copyright © 2016–2021. All rights reserved.