Package com.oracle.bmc.nosql

Class NosqlClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.nosql.NosqlClient

All Implemented Interfaces:

Nosql, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190828")
public class NosqlClient
extends BaseSyncClient
implements Nosql

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	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	Description
NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
NosqlClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
NosqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
NosqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
NosqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	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.
CreateReplicaResponse	createReplica(CreateReplicaRequest request)	Add a replica for this table
CreateTableResponse	createTable(CreateTableRequest request)	Create a new table.
DeleteIndexResponse	deleteIndex(DeleteIndexRequest request)	Delete an index from the table identified by tableNameOrId.
DeleteReplicaResponse	deleteReplica(DeleteReplicaRequest request)	Delete the specified replica table in the remote region.
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetIndexResponse	getIndex(GetIndexRequest request)	Get information about a single index.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
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	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’).
SummarizeStatementResponse	summarizeStatement(SummarizeStatementRequest request)	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.
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
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.nosql.Nosql

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

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

NosqlClient

@Deprecated
public NosqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

NosqlClient

@Deprecated
public NosqlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

NosqlClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

NosqlClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

NosqlClient

@Deprecated
public NosqlClient(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 NosqlClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

NosqlClient

@Deprecated
public NosqlClient(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 NosqlClient.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)

NosqlClient

@Deprecated
public NosqlClient(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 NosqlClient.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

NosqlClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NosqlClient.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

executorService - NosqlClient.Builder.executorService

Method Detail

builder

public static NosqlClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: 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.

Specified by:

setRegion in interface Nosql

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: 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.

Specified by:

setRegion in interface Nosql

Parameters:

regionId - The public region ID.

changeTableCompartment

public ChangeTableCompartmentResponse changeTableCompartment(ChangeTableCompartmentRequest request)

Description copied from interface: Nosql

Change a table’s compartment.

Specified by:

changeTableCompartment in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createIndex

public CreateIndexResponse createIndex(CreateIndexRequest request)

Description copied from interface: Nosql

Create a new index on the table identified by tableNameOrId.

Specified by:

createIndex in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createReplica

public CreateReplicaResponse createReplica(CreateReplicaRequest request)

Description copied from interface: Nosql

Add a replica for this table

Specified by:

createReplica in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createTable

public CreateTableResponse createTable(CreateTableRequest request)

Description copied from interface: Nosql

Create a new table.

Specified by:

createTable in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteIndex

public DeleteIndexResponse deleteIndex(DeleteIndexRequest request)

Description copied from interface: Nosql

Delete an index from the table identified by tableNameOrId.

Specified by:

deleteIndex in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteReplica

public DeleteReplicaResponse deleteReplica(DeleteReplicaRequest request)

Description copied from interface: Nosql

Delete the specified replica table in the remote region.

Specified by:

deleteReplica in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRow

public DeleteRowResponse deleteRow(DeleteRowRequest request)

Description copied from interface: Nosql

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

Specified by:

deleteRow in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteTable

public DeleteTableResponse deleteTable(DeleteTableRequest request)

Description copied from interface: Nosql

Delete a table by tableNameOrId.

Specified by:

deleteTable in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteWorkRequest

public DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)

Description copied from interface: Nosql

Cancel a work request operation with the given ID.

Specified by:

deleteWorkRequest in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getIndex

public GetIndexResponse getIndex(GetIndexRequest request)

Description copied from interface: Nosql

Get information about a single index.

Specified by:

getIndex in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRow

public GetRowResponse getRow(GetRowRequest request)

Description copied from interface: Nosql

Get a single row from the table by primary key.

Specified by:

getRow in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTable

public GetTableResponse getTable(GetTableRequest request)

Description copied from interface: Nosql

Get table info by identifier.

Specified by:

getTable in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: Nosql

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

Specified by:

getWorkRequest in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listIndexes

public ListIndexesResponse listIndexes(ListIndexesRequest request)

Description copied from interface: Nosql

Get a list of indexes on a table.

Specified by:

listIndexes in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTableUsage

public ListTableUsageResponse listTableUsage(ListTableUsageRequest request)

Description copied from interface: Nosql

Get table usage info.

Specified by:

listTableUsage in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTables

public ListTablesResponse listTables(ListTablesRequest request)

Description copied from interface: Nosql

Get a list of tables in a compartment.

Specified by:

listTables in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: Nosql

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

Specified by:

listWorkRequestErrors in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: Nosql

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

Specified by:

listWorkRequestLogs in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: Nosql

List the work requests in a compartment.

Specified by:

listWorkRequests in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

prepareStatement

public PrepareStatementResponse prepareStatement(PrepareStatementRequest request)

Description copied from interface: Nosql

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

Specified by:

prepareStatement in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

query

public QueryResponse query(QueryRequest request)

Description copied from interface: Nosql

Execute a SQL query.

Specified by:

query in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeStatement

public SummarizeStatementResponse summarizeStatement(SummarizeStatementRequest request)

Description copied from interface: Nosql

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

Specified by:

summarizeStatement in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRow

public UpdateRowResponse updateRow(UpdateRowRequest request)

Description copied from interface: Nosql

Write a single row into the table.

Specified by:

updateRow in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateTable

public UpdateTableResponse updateTable(UpdateTableRequest request)

Description copied from interface: Nosql

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

Specified by:

updateTable in interface Nosql

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public NosqlWaiters getWaiters()

Description copied from interface: Nosql

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface Nosql

Returns:

The service waiters.

getPaginators

public NosqlPaginators getPaginators()

Description copied from interface: 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.

Specified by:

getPaginators in interface Nosql

Returns:

The service paginators.

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()