com.oracle.bmc.nosql.Nosql Maven / Gradle / Ivy
Show all versions of oci-java-sdk-nosql Show documentation
/**
* Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.nosql;
import com.oracle.bmc.nosql.requests.*;
import com.oracle.bmc.nosql.responses.*;
@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190828")
public interface Nosql extends AutoCloseable {
/**
* Sets the endpoint to call (ex, https://www.example.com).
* @param endpoint The endpoint of the service.
*/
void setEndpoint(String endpoint);
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
* Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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
* {@link #setRegion(Region) setRegion}.
*
* If no known Region could be determined, it will create an endpoint based on the
* default endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* Change a table's compartment.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
ChangeTableCompartmentResponse changeTableCompartment(ChangeTableCompartmentRequest request);
/**
* Create a new index on the table identified by tableNameOrId.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
CreateIndexResponse createIndex(CreateIndexRequest request);
/**
* Create a new table.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
CreateTableResponse createTable(CreateTableRequest request);
/**
* Delete an index from the table identified by tableNameOrId.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
DeleteIndexResponse deleteIndex(DeleteIndexRequest request);
/**
* Delete a single row from the table, by primary key.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
DeleteRowResponse deleteRow(DeleteRowRequest request);
/**
* Delete a table by tableNameOrId.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
DeleteTableResponse deleteTable(DeleteTableRequest request);
/**
* Cancel a work request operation with the given ID.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request);
/**
* Get information about a single index.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
GetIndexResponse getIndex(GetIndexRequest request);
/**
* Get a single row from the table by primary key.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
GetRowResponse getRow(GetRowRequest request);
/**
* Get table info by identifier.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
GetTableResponse getTable(GetTableRequest request);
/**
* Get the status of the work request with the given ID.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request);
/**
* Get a list of indexes on a table.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
ListIndexesResponse listIndexes(ListIndexesRequest request);
/**
* Get table usage info.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
ListTableUsageResponse listTableUsage(ListTableUsageRequest request);
/**
* Get a list of tables in a compartment.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
ListTablesResponse listTables(ListTablesRequest request);
/**
* Return a (paginated) list of errors for a given work request.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request);
/**
* Return a (paginated) list of logs for a given work request.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request);
/**
* List the work requests in a compartment.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request);
/**
* Prepare a SQL statement for use in a query with variable substitution.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
PrepareStatementResponse prepareStatement(PrepareStatementRequest request);
/**
* Execute a SQL query.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
QueryResponse query(QueryRequest request);
/**
* Check the syntax and return a brief summary of a SQL statement.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
SummarizeStatementResponse summarizeStatement(SummarizeStatementRequest request);
/**
* Write a single row into the table.
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
UpdateRowResponse updateRow(UpdateRowRequest request);
/**
* Alter the table identified by tableNameOrId,
* changing schema, limits, or tags
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs.
*/
UpdateTableResponse updateTable(UpdateTableRequest request);
/**
* Gets the pre-configured waiters available for resources for this service.
*
* @return The service waiters.
*/
NosqlWaiters getWaiters();
/**
* Gets the pre-configured paginators available for list operations in this service which may return multiple
* pages of data. These paginators provide an {@link java.lang.Iterable} interface so that service responses, or
* resources/records, can be iterated through without having to manually deal with pagination and page tokens.
*
* @return The service paginators.
*/
NosqlPaginators getPaginators();
}