com.google.cloud.spanner.spi.v1

Class GapicSpannerRpc

java.lang.Object

com.google.cloud.spanner.spi.v1.GapicSpannerRpc

All Implemented Interfaces:

com.google.cloud.ServiceRpc, SpannerRpc

public class GapicSpannerRpc
extends Object
implements SpannerRpc

Implementation of Cloud Spanner remote calls using Gapic libraries.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.cloud.spanner.spi.v1.SpannerRpc

SpannerRpc.Option, SpannerRpc.Paginated<T>, SpannerRpc.ResultStreamConsumer, SpannerRpc.StreamingCall

Constructor Summary

Constructors

Constructor and Description
GapicSpannerRpc(SpannerOptions options)

Method Summary

Modifier and Type	Method and Description
List<Session>	batchCreateSessions(String databaseName, int sessionCount, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
Transaction	beginTransaction(BeginTransactionRequest request, Map<SpannerRpc.Option,?> options)
CommitResponse	commit(CommitRequest commitRequest, Map<SpannerRpc.Option,?> options)
static GapicSpannerRpc	create(SpannerOptions options)
com.google.api.gax.longrunning.OperationFuture<Database,CreateDatabaseMetadata>	createDatabase(String instanceName, String createDatabaseStatement, Iterable<String> additionalStatements)
com.google.api.gax.longrunning.OperationFuture<Instance,CreateInstanceMetadata>	createInstance(String parent, String instanceId, Instance instance)
Session	createSession(String databaseName, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
void	deleteInstance(String instanceName)
void	deleteSession(String sessionName, Map<SpannerRpc.Option,?> options)
void	dropDatabase(String databaseName)
ExecuteBatchDmlResponse	executeBatchDml(ExecuteBatchDmlRequest request, Map<SpannerRpc.Option,?> options)
ResultSet	executePartitionedDml(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options, org.threeten.bp.Duration timeout)
ResultSet	executeQuery(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options)
SpannerRpc.StreamingCall	executeQuery(ExecuteSqlRequest request, SpannerRpc.ResultStreamConsumer consumer, Map<SpannerRpc.Option,?> options)
Database	getDatabase(String databaseName)
com.google.iam.v1.Policy	getDatabaseAdminIAMPolicy(String resource) Gets the IAM policy for the given resource using the DatabaseAdminStub.
List<String>	getDatabaseDdl(String databaseName)
Instance	getInstance(String instanceName)
com.google.iam.v1.Policy	getInstanceAdminIAMPolicy(String resource) Gets the IAM policy for the given resource using the InstanceAdminStub.
InstanceConfig	getInstanceConfig(String instanceConfigName)
com.google.longrunning.Operation	getOperation(String name) Retrieves a long running operation.
boolean	isClosed()
SpannerRpc.Paginated<Database>	listDatabases(String instanceName, int pageSize, String pageToken)
SpannerRpc.Paginated<InstanceConfig>	listInstanceConfigs(int pageSize, String pageToken)
SpannerRpc.Paginated<Instance>	listInstances(int pageSize, String pageToken, String filter)
PartitionResponse	partitionQuery(PartitionQueryRequest request, Map<SpannerRpc.Option,?> options)
PartitionResponse	partitionRead(PartitionReadRequest request, Map<SpannerRpc.Option,?> options)
SpannerRpc.StreamingCall	read(ReadRequest request, SpannerRpc.ResultStreamConsumer consumer, Map<SpannerRpc.Option,?> options)
void	rollback(RollbackRequest request, Map<SpannerRpc.Option,?> options)
com.google.iam.v1.Policy	setDatabaseAdminIAMPolicy(String resource, com.google.iam.v1.Policy policy) Updates the IAM policy for the given resource using the DatabaseAdminStub.
com.google.iam.v1.Policy	setInstanceAdminIAMPolicy(String resource, com.google.iam.v1.Policy policy) Updates the IAM policy for the given resource using the InstanceAdminStub.
void	shutdown()
com.google.iam.v1.TestIamPermissionsResponse	testDatabaseAdminIAMPermissions(String resource, Iterable<String> permissions) Tests the IAM permissions for the given resource using the DatabaseAdminStub.
com.google.iam.v1.TestIamPermissionsResponse	testInstanceAdminIAMPermissions(String resource, Iterable<String> permissions) Tests the IAM permissions for the given resource using the InstanceAdminStub.
com.google.api.gax.longrunning.OperationFuture<Empty,UpdateDatabaseDdlMetadata>	updateDatabaseDdl(String databaseName, Iterable<String> updateDatabaseStatements, String updateId)
com.google.api.gax.longrunning.OperationFuture<Instance,UpdateInstanceMetadata>	updateInstance(Instance instance, FieldMask fieldMask)

Methods inherited from class java.lang.Object

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

Constructor Detail

GapicSpannerRpc

public GapicSpannerRpc(SpannerOptions options)

Method Detail

create

public static GapicSpannerRpc create(SpannerOptions options)

listInstanceConfigs

public SpannerRpc.Paginated<InstanceConfig> listInstanceConfigs(int pageSize,
                                                                @Nullable
                                                                String pageToken)
                                                         throws SpannerException

Specified by:

listInstanceConfigs in interface SpannerRpc

Throws:

SpannerException

getInstanceConfig

public InstanceConfig getInstanceConfig(String instanceConfigName)
                                 throws SpannerException

Specified by:

getInstanceConfig in interface SpannerRpc

Throws:

SpannerException

listInstances

public SpannerRpc.Paginated<Instance> listInstances(int pageSize,
                                                    @Nullable
                                                    String pageToken,
                                                    @Nullable
                                                    String filter)
                                             throws SpannerException

Specified by:

listInstances in interface SpannerRpc

Throws:

SpannerException

createInstance

public com.google.api.gax.longrunning.OperationFuture<Instance,CreateInstanceMetadata> createInstance(String parent,
                                                                                                      String instanceId,
                                                                                                      Instance instance)
                                                                                               throws SpannerException

Specified by:

createInstance in interface SpannerRpc

Throws:

SpannerException

updateInstance

public com.google.api.gax.longrunning.OperationFuture<Instance,UpdateInstanceMetadata> updateInstance(Instance instance,
                                                                                                      FieldMask fieldMask)
                                                                                               throws SpannerException

Specified by:

updateInstance in interface SpannerRpc

Throws:

SpannerException

getInstance

public Instance getInstance(String instanceName)
                     throws SpannerException

Specified by:

getInstance in interface SpannerRpc

Throws:

SpannerException

deleteInstance

public void deleteInstance(String instanceName)
                    throws SpannerException

Specified by:

deleteInstance in interface SpannerRpc

Throws:

SpannerException

listDatabases

public SpannerRpc.Paginated<Database> listDatabases(String instanceName,
                                                    int pageSize,
                                                    @Nullable
                                                    String pageToken)
                                             throws SpannerException

Specified by:

listDatabases in interface SpannerRpc

Throws:

SpannerException

createDatabase

public com.google.api.gax.longrunning.OperationFuture<Database,CreateDatabaseMetadata> createDatabase(String instanceName,
                                                                                                      String createDatabaseStatement,
                                                                                                      Iterable<String> additionalStatements)
                                                                                               throws SpannerException

Specified by:

createDatabase in interface SpannerRpc

Throws:

SpannerException

updateDatabaseDdl

public com.google.api.gax.longrunning.OperationFuture<Empty,UpdateDatabaseDdlMetadata> updateDatabaseDdl(String databaseName,
                                                                                                         Iterable<String> updateDatabaseStatements,
                                                                                                         @Nullable
                                                                                                         String updateId)
                                                                                                  throws SpannerException

Specified by:

updateDatabaseDdl in interface SpannerRpc

Throws:

SpannerException

dropDatabase

public void dropDatabase(String databaseName)
                  throws SpannerException

Specified by:

dropDatabase in interface SpannerRpc

Throws:

SpannerException

getDatabase

public Database getDatabase(String databaseName)
                     throws SpannerException

Specified by:

getDatabase in interface SpannerRpc

Throws:

SpannerException

getDatabaseDdl

public List<String> getDatabaseDdl(String databaseName)
                            throws SpannerException

Specified by:

getDatabaseDdl in interface SpannerRpc

Throws:

SpannerException

getOperation

public com.google.longrunning.Operation getOperation(String name)
                                              throws SpannerException

Description copied from interface: SpannerRpc

Retrieves a long running operation.

Specified by:

getOperation in interface SpannerRpc

Throws:

SpannerException

batchCreateSessions

public List<Session> batchCreateSessions(String databaseName,
                                         int sessionCount,
                                         @Nullable
                                         Map<String,String> labels,
                                         @Nullable
                                         Map<SpannerRpc.Option,?> options)
                                  throws SpannerException

Specified by:

batchCreateSessions in interface SpannerRpc

Throws:

SpannerException

createSession

public Session createSession(String databaseName,
                             @Nullable
                             Map<String,String> labels,
                             @Nullable
                             Map<SpannerRpc.Option,?> options)
                      throws SpannerException

Specified by:

createSession in interface SpannerRpc

Throws:

SpannerException

deleteSession

public void deleteSession(String sessionName,
                          @Nullable
                          Map<SpannerRpc.Option,?> options)
                   throws SpannerException

Specified by:

deleteSession in interface SpannerRpc

Throws:

SpannerException

read

public SpannerRpc.StreamingCall read(ReadRequest request,
                                     SpannerRpc.ResultStreamConsumer consumer,
                                     @Nullable
                                     Map<SpannerRpc.Option,?> options)

Specified by:

read in interface SpannerRpc

executeQuery

public ResultSet executeQuery(ExecuteSqlRequest request,
                              @Nullable
                              Map<SpannerRpc.Option,?> options)

Specified by:

executeQuery in interface SpannerRpc

executePartitionedDml

public ResultSet executePartitionedDml(ExecuteSqlRequest request,
                                       @Nullable
                                       Map<SpannerRpc.Option,?> options,
                                       org.threeten.bp.Duration timeout)

Specified by:

executePartitionedDml in interface SpannerRpc

executeQuery

public SpannerRpc.StreamingCall executeQuery(ExecuteSqlRequest request,
                                             SpannerRpc.ResultStreamConsumer consumer,
                                             @Nullable
                                             Map<SpannerRpc.Option,?> options)

Specified by:

executeQuery in interface SpannerRpc

executeBatchDml

public ExecuteBatchDmlResponse executeBatchDml(ExecuteBatchDmlRequest request,
                                               @Nullable
                                               Map<SpannerRpc.Option,?> options)

Specified by:

executeBatchDml in interface SpannerRpc

beginTransaction

public Transaction beginTransaction(BeginTransactionRequest request,
                                    @Nullable
                                    Map<SpannerRpc.Option,?> options)
                             throws SpannerException

Specified by:

beginTransaction in interface SpannerRpc

Throws:

SpannerException

commit

public CommitResponse commit(CommitRequest commitRequest,
                             @Nullable
                             Map<SpannerRpc.Option,?> options)
                      throws SpannerException

Specified by:

commit in interface SpannerRpc

Throws:

SpannerException

rollback

public void rollback(RollbackRequest request,
                     @Nullable
                     Map<SpannerRpc.Option,?> options)
              throws SpannerException

Specified by:

rollback in interface SpannerRpc

Throws:

SpannerException

partitionQuery

public PartitionResponse partitionQuery(PartitionQueryRequest request,
                                        @Nullable
                                        Map<SpannerRpc.Option,?> options)
                                 throws SpannerException

Specified by:

partitionQuery in interface SpannerRpc

Throws:

SpannerException

partitionRead

public PartitionResponse partitionRead(PartitionReadRequest request,
                                       @Nullable
                                       Map<SpannerRpc.Option,?> options)
                                throws SpannerException

Specified by:

partitionRead in interface SpannerRpc

Throws:

SpannerException

getDatabaseAdminIAMPolicy

public com.google.iam.v1.Policy getDatabaseAdminIAMPolicy(String resource)

Description copied from interface: SpannerRpc

Gets the IAM policy for the given resource using the DatabaseAdminStub.

Specified by:

getDatabaseAdminIAMPolicy in interface SpannerRpc

setDatabaseAdminIAMPolicy

public com.google.iam.v1.Policy setDatabaseAdminIAMPolicy(String resource,
                                                          com.google.iam.v1.Policy policy)

Description copied from interface: SpannerRpc

Updates the IAM policy for the given resource using the DatabaseAdminStub. It is highly recommended to first get the current policy and base the updated policy on the returned policy. See Policy.Builder#setEtag(com.google.protobuf.ByteString) for information on the recommended read-modify-write cycle.

Specified by:

setDatabaseAdminIAMPolicy in interface SpannerRpc

testDatabaseAdminIAMPermissions

public com.google.iam.v1.TestIamPermissionsResponse testDatabaseAdminIAMPermissions(String resource,
                                                                                    Iterable<String> permissions)

Description copied from interface: SpannerRpc

Tests the IAM permissions for the given resource using the DatabaseAdminStub.

Specified by:

testDatabaseAdminIAMPermissions in interface SpannerRpc

getInstanceAdminIAMPolicy

public com.google.iam.v1.Policy getInstanceAdminIAMPolicy(String resource)

Description copied from interface: SpannerRpc

Gets the IAM policy for the given resource using the InstanceAdminStub.

Specified by:

getInstanceAdminIAMPolicy in interface SpannerRpc

setInstanceAdminIAMPolicy

public com.google.iam.v1.Policy setInstanceAdminIAMPolicy(String resource,
                                                          com.google.iam.v1.Policy policy)

Description copied from interface: SpannerRpc

Updates the IAM policy for the given resource using the InstanceAdminStub. It is highly recommended to first get the current policy and base the updated policy on the returned policy. See Policy.Builder#setEtag(com.google.protobuf.ByteString) for information on the recommended read-modify-write cycle.

Specified by:

setInstanceAdminIAMPolicy in interface SpannerRpc

testInstanceAdminIAMPermissions

public com.google.iam.v1.TestIamPermissionsResponse testInstanceAdminIAMPermissions(String resource,
                                                                                    Iterable<String> permissions)

Description copied from interface: SpannerRpc

Tests the IAM permissions for the given resource using the InstanceAdminStub.

Specified by:

testInstanceAdminIAMPermissions in interface SpannerRpc

shutdown

public void shutdown()

Specified by:

shutdown in interface SpannerRpc

isClosed

public boolean isClosed()

Specified by:

isClosed in interface SpannerRpc