Send feedback
Class GapicSpannerRpc (6.71.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 6.71.0 keyboard_arrow_down
public class GapicSpannerRpc implements SpannerRpc
Implementation of Cloud Spanner remote calls using Gapic libraries.
Static Fields
DEFAULT_USER_AGENT
public static final String DEFAULT_USER_AGENT
Field Value
Type Description
String
Static Methods
create(SpannerOptions options)
public static GapicSpannerRpc create ( SpannerOptions options )
Constructors
GapicSpannerRpc(SpannerOptions options)
public GapicSpannerRpc ( SpannerOptions options )
Methods
asyncDeleteSession(String sessionName, Map<SpannerRpc.Option,?> options)
public ApiFuture<Empty> asyncDeleteSession ( String sessionName , Map<SpannerRpc . Option , ? > options )
batchCreateSessions(String databaseName, int sessionCount, String databaseRole, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
public List<Session> batchCreateSessions ( String databaseName , int sessionCount , String databaseRole , Map<String , String > labels , Map<SpannerRpc . Option , ? > options )
batchWriteAtLeastOnce(BatchWriteRequest request, Map<SpannerRpc.Option,?> options)
public ServerStream<BatchWriteResponse> batchWriteAtLeastOnce ( BatchWriteRequest request , Map<SpannerRpc . Option , ? > options )
beginTransaction(BeginTransactionRequest request, Map<SpannerRpc.Option,?> options, boolean routeToLeader)
public Transaction beginTransaction ( BeginTransactionRequest request , Map<SpannerRpc . Option , ? > options , boolean routeToLeader )
beginTransactionAsync(BeginTransactionRequest request, Map<SpannerRpc.Option,?> options, boolean routeToLeader)
public ApiFuture<Transaction> beginTransactionAsync ( BeginTransactionRequest request , Map<SpannerRpc . Option , ? > options , boolean routeToLeader )
Begins a transaction asynchronously.
cancelOperation(String name)
public void cancelOperation ( String name )
Cancels the specified long-running operation.
Parameter
Name Description
nameString
commit(CommitRequest commitRequest, Map<SpannerRpc.Option,?> options)
public CommitResponse commit ( CommitRequest commitRequest , Map<SpannerRpc . Option , ? > options )
commitAsync(CommitRequest request, Map<SpannerRpc.Option,?> options)
public ApiFuture<CommitResponse> commitAsync ( CommitRequest request , Map<SpannerRpc . Option , ? > options )
copyBackup(BackupId sourceBackupId, Backup destinationBackup)
public OperationFuture<Backup , CopyBackupMetadata > copyBackup ( BackupId sourceBackupId , Backup destinationBackup )
Creates a copy backup from the source backup specified.
Parameters
Name Description
sourceBackupIdBackupId
destinationBackupBackup
createBackup(Backup backupInfo)
public OperationFuture<Backup , CreateBackupMetadata > createBackup ( Backup backupInfo )
Parameter
Name Description
backupInfoBackup
createDatabase(String instanceName, String createDatabaseStatement, Iterable<String> additionalStatements, Database databaseInfo)
public OperationFuture<Database , CreateDatabaseMetadata > createDatabase ( String instanceName , String createDatabaseStatement , Iterable<String> additionalStatements , Database databaseInfo )
createInstance(String parent, String instanceId, Instance instance)
public OperationFuture<Instance , CreateInstanceMetadata > createInstance ( String parent , String instanceId , Instance instance )
createInstanceConfig(String parent, String instanceConfigId, InstanceConfig instanceConfig, Boolean validateOnly)
public OperationFuture<InstanceConfig , CreateInstanceConfigMetadata > createInstanceConfig ( String parent , String instanceConfigId , InstanceConfig instanceConfig , Boolean validateOnly )
createSession(String databaseName, String databaseRole, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
public Session createSession ( String databaseName , String databaseRole , Map<String , String > labels , Map<SpannerRpc . Option , ? > options )
createSession(String databaseName, String databaseRole, Map<String,String> labels, Map<SpannerRpc.Option,?> options, boolean isMultiplexed)
public Session createSession ( String databaseName , String databaseRole , Map<String , String > labels , Map<SpannerRpc . Option , ? > options , boolean isMultiplexed )
deleteBackup(String backupName)
public void deleteBackup ( String backupName )
Deletes a pending or completed backup.
Parameter
Name Description
backupNameString
deleteInstance(String instanceName)
public void deleteInstance ( String instanceName )
Parameter
Name Description
instanceNameString
deleteInstanceConfig(String instanceConfigName, String etag, Boolean validateOnly)
public void deleteInstanceConfig ( String instanceConfigName , String etag , Boolean validateOnly )
deleteSession(String sessionName, Map<SpannerRpc.Option,?> options)
public void deleteSession ( String sessionName , Map<SpannerRpc . Option , ? > options )
dropDatabase(String databaseName)
public void dropDatabase ( String databaseName )
Parameter
Name Description
databaseNameString
executeBatchDml(ExecuteBatchDmlRequest request, Map<SpannerRpc.Option,?> options)
public ExecuteBatchDmlResponse executeBatchDml ( ExecuteBatchDmlRequest request , Map<SpannerRpc . Option , ? > options )
executeBatchDmlAsync(ExecuteBatchDmlRequest request, Map<SpannerRpc.Option,?> options)
public ApiFuture<ExecuteBatchDmlResponse> executeBatchDmlAsync ( ExecuteBatchDmlRequest request , Map<SpannerRpc . Option , ? > options )
executePartitionedDml(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options)
public ResultSet executePartitionedDml ( ExecuteSqlRequest request , Map<SpannerRpc . Option , ? > options )
executeQuery(ExecuteSqlRequest request, SpannerRpc.ResultStreamConsumer consumer, Map<SpannerRpc.Option,?> options, boolean routeToLeader)
public SpannerRpc . StreamingCall executeQuery ( ExecuteSqlRequest request , SpannerRpc . ResultStreamConsumer consumer , Map<SpannerRpc . Option , ? > options , boolean routeToLeader )
Executes a query with streaming result.
executeQuery(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options, boolean routeToLeader)
public ResultSet executeQuery ( ExecuteSqlRequest request , Map<SpannerRpc . Option , ? > options , boolean routeToLeader )
executeQueryAsync(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options, boolean routeToLeader)
public ApiFuture<ResultSet> executeQueryAsync ( ExecuteSqlRequest request , Map<SpannerRpc . Option , ? > options , boolean routeToLeader )
Executes a query asynchronously.
executeStreamingPartitionedDml(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options, Duration timeout)
public ServerStream<PartialResultSet> executeStreamingPartitionedDml ( ExecuteSqlRequest request , Map<SpannerRpc . Option , ? > options , Duration timeout )
getBackup(String backupName)
public Backup getBackup ( String backupName )
Gets the backup with the specified name.
Parameter
Name Description
backupNameString
Returns
Type Description
Backup
getDatabase(String databaseName)
public Database getDatabase ( String databaseName )
Parameter
Name Description
databaseNameString
getDatabaseAdminIAMPolicy(String resource, GetPolicyOptions options)
public Policy getDatabaseAdminIAMPolicy ( String resource , GetPolicyOptions options )
Parameters
Name Description
resourceString
optionscom.google.iam.v1.GetPolicyOptions
Returns
Type Description
com.google.iam.v1.Policy
getDatabaseAdminStubSettings()
public DatabaseAdminStubSettings getDatabaseAdminStubSettings ()
Getter method to obtain the auto-generated database admin client stub settings.
getDatabaseDdl(String databaseName)
public GetDatabaseDdlResponse getDatabaseDdl ( String databaseName )
Parameter
Name Description
databaseNameString
getExecuteQueryRetrySettings()
public RetrySettings getExecuteQueryRetrySettings ()
Returns the retry settings for streaming query operations.
getExecuteQueryRetryableCodes()
public Set<StatusCode . Code > getExecuteQueryRetryableCodes ()
Returns the retryable codes for streaming query operations.
getInstance(String instanceName)
public Instance getInstance ( String instanceName )
Parameter
Name Description
instanceNameString
getInstanceAdminIAMPolicy(String resource)
public Policy getInstanceAdminIAMPolicy ( String resource )
Parameter
Name Description
resourceString
Returns
Type Description
com.google.iam.v1.Policy
getInstanceAdminStubSettings()
public InstanceAdminStubSettings getInstanceAdminStubSettings ()
Getter method to obtain the auto-generated instance admin client stub settings.
getInstanceConfig(String instanceConfigName)
public InstanceConfig getInstanceConfig ( String instanceConfigName )
Parameter
Name Description
instanceConfigNameString
getOperation(String name)
public Operation getOperation ( String name )
Retrieves a long running operation.
Parameter
Name Description
nameString
getPartitionedDmlRetrySettings()
public RetrySettings getPartitionedDmlRetrySettings ()
getReadRetrySettings()
public RetrySettings getReadRetrySettings ()
Returns the retry settings for streaming read operations.
getReadRetryableCodes()
public Set<StatusCode . Code > getReadRetryableCodes ()
Returns the retryable codes for streaming read operations.
isClosed()
public boolean isClosed ()
listBackupOperations(String instanceName, int pageSize, String filter, String pageToken)
public SpannerRpc . Paginated<Operation> listBackupOperations ( String instanceName , int pageSize , String filter , String pageToken )
List all long-running backup operations on the given instance.
listBackups(String instanceName, int pageSize, String filter, String pageToken)
public SpannerRpc . Paginated<Backup> listBackups ( String instanceName , int pageSize , String filter , String pageToken )
Lists the backups in the specified instance.
listDatabaseOperations(String instanceName, int pageSize, String filter, String pageToken)
public SpannerRpc . Paginated<Operation> listDatabaseOperations ( String instanceName , int pageSize , String filter , String pageToken )
listDatabaseRoles(String databaseName, int pageSize, String pageToken)
public SpannerRpc . Paginated<DatabaseRole> listDatabaseRoles ( String databaseName , int pageSize , String pageToken )
Parameters
Name Description
databaseNameString
pageSizeint
pageTokenString
listDatabases(String instanceName, int pageSize, String pageToken)
public SpannerRpc . Paginated<Database> listDatabases ( String instanceName , int pageSize , String pageToken )
Parameters
Name Description
instanceNameString
pageSizeint
pageTokenString
listInstanceConfigOperations(int pageSize, String filter, String pageToken)
public SpannerRpc . Paginated<Operation> listInstanceConfigOperations ( int pageSize , String filter , String pageToken )
List all long-running instance config operations on the given project.
listInstanceConfigs(int pageSize, String pageToken)
public SpannerRpc . Paginated<InstanceConfig> listInstanceConfigs ( int pageSize , String pageToken )
Parameters
Name Description
pageSizeint
pageTokenString
listInstances(int pageSize, String pageToken, String filter)
public SpannerRpc . Paginated<Instance> listInstances ( int pageSize , String pageToken , String filter )
partitionQuery(PartitionQueryRequest request, Map<SpannerRpc.Option,?> options)
public PartitionResponse partitionQuery ( PartitionQueryRequest request , Map<SpannerRpc . Option , ? > options )
partitionRead(PartitionReadRequest request, Map<SpannerRpc.Option,?> options)
public PartitionResponse partitionRead ( PartitionReadRequest request , Map<SpannerRpc . Option , ? > options )
read(ReadRequest request, SpannerRpc.ResultStreamConsumer consumer, Map<SpannerRpc.Option,?> options, boolean routeToLeader)
public SpannerRpc . StreamingCall read ( ReadRequest request , SpannerRpc . ResultStreamConsumer consumer , Map<SpannerRpc . Option , ? > options , boolean routeToLeader )
Performs a streaming read.
restoreDatabase(Restore restore)
public OperationFuture<Database , RestoreDatabaseMetadata > restoreDatabase ( Restore restore )
Restore a backup into the given database.
Parameter
Name Description
restoreRestore
rollback(RollbackRequest request, Map<SpannerRpc.Option,?> options)
public void rollback ( RollbackRequest request , Map<SpannerRpc . Option , ? > options )
rollbackAsync(RollbackRequest request, Map<SpannerRpc.Option,?> options)
public ApiFuture<Empty> rollbackAsync ( RollbackRequest request , Map<SpannerRpc . Option , ? > options )
setDatabaseAdminIAMPolicy(String resource, Policy policy)
public Policy setDatabaseAdminIAMPolicy ( String resource , Policy policy )
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.
Parameters
Name Description
resourceString
policycom.google.iam.v1.Policy
Returns
Type Description
com.google.iam.v1.Policy
setInstanceAdminIAMPolicy(String resource, Policy policy)
public Policy setInstanceAdminIAMPolicy ( String resource , Policy policy )
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.
Parameters
Name Description
resourceString
policycom.google.iam.v1.Policy
Returns
Type Description
com.google.iam.v1.Policy
shutdown()
shutdownNow()
public void shutdownNow ()
testDatabaseAdminIAMPermissions(String resource, Iterable<String> permissions)
public TestIamPermissionsResponse testDatabaseAdminIAMPermissions ( String resource , Iterable<String> permissions )
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse
testInstanceAdminIAMPermissions(String resource, Iterable<String> permissions)
public TestIamPermissionsResponse testInstanceAdminIAMPermissions ( String resource , Iterable<String> permissions )
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse
updateBackup(Backup backup, FieldMask updateMask)
public Backup updateBackup ( Backup backup , FieldMask updateMask )
Updates the specified backup. The only supported field for updates is expireTime.
Returns
Type Description
Backup
updateDatabase(Database database, FieldMask updateMask)
public OperationFuture<Database , UpdateDatabaseMetadata > updateDatabase ( Database database , FieldMask updateMask )
Updates the specified fields of a Cloud Spanner database.
updateDatabaseDdl(Database databaseInfo, Iterable<String> updateDatabaseStatements, String updateId)
public OperationFuture<Empty , UpdateDatabaseDdlMetadata > updateDatabaseDdl ( Database databaseInfo , Iterable<String> updateDatabaseStatements , String updateId )
If the update database ddl operation returns an ALREADY_EXISTS error, meaning the operation id
used is already in flight, this method will simply resume the original operation. The returned
future will be completed when the original operation finishes.
This mechanism is necessary, because the update database ddl can be retried. If a retryable
failure occurs, the backend has already started processing the update database ddl operation
with the given id and the library issues a retry, an ALREADY_EXISTS error will be returned. If
we were to bubble this error up, it would be confusing for the caller, who used originally
called the method with a new operation id.
updateInstance(Instance instance, FieldMask fieldMask)
public OperationFuture<Instance , UpdateInstanceMetadata > updateInstance ( Instance instance , FieldMask fieldMask )
updateInstanceConfig(InstanceConfig instanceConfig, Boolean validateOnly, FieldMask fieldMask)
public OperationFuture<InstanceConfig , UpdateInstanceConfigMetadata > updateInstanceConfig ( InstanceConfig instanceConfig , Boolean validateOnly , FieldMask fieldMask )
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
