Send feedback
Class GapicSpannerRpc (6.25.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 6.25.1 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, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
public List<Session> batchCreateSessions ( String databaseName , int sessionCount , Map<String , String > labels , Map<SpannerRpc . Option , ? > options )
beginTransaction(BeginTransactionRequest request, Map<SpannerRpc.Option,?> options)
public Transaction beginTransaction ( BeginTransactionRequest request , Map<SpannerRpc . Option , ? > options )
beginTransactionAsync(BeginTransactionRequest request, Map<SpannerRpc.Option,?> options)
public ApiFuture<Transaction> beginTransactionAsync ( BeginTransactionRequest request , Map<SpannerRpc . Option , ? > options )
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 )
createSession(String databaseName, Map<String,String> labels, Map<SpannerRpc.Option,?> options)
public Session createSession ( String databaseName , Map<String , String > labels , Map<SpannerRpc . Option , ? > options )
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
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)
public SpannerRpc . StreamingCall executeQuery ( ExecuteSqlRequest request , SpannerRpc . ResultStreamConsumer consumer , Map<SpannerRpc . Option , ? > options )
executeQuery(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options)
public ResultSet executeQuery ( ExecuteSqlRequest request , Map<SpannerRpc . Option , ? > options )
executeQueryAsync(ExecuteSqlRequest request, Map<SpannerRpc.Option,?> options)
public ApiFuture<ResultSet> executeQueryAsync ( ExecuteSqlRequest request , Map<SpannerRpc . Option , ? > options )
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
getDatabase(String databaseName)
public Database getDatabase ( String databaseName )
Parameter Name Description databaseNameString
getDatabaseAdminIAMPolicy(String resource)
public Policy getDatabaseAdminIAMPolicy ( String resource )
Parameter Name Description resourceString
Returns Type Description com.google.iam.v1.Policy
getDatabaseDdl(String databaseName)
public List<String> getDatabaseDdl ( String databaseName )
Parameter Name Description databaseNameString
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
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 ()
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 )
listDatabases(String instanceName, int pageSize, String pageToken)
public SpannerRpc . Paginated<Database> listDatabases ( String instanceName , int pageSize , String pageToken )
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)
public SpannerRpc . StreamingCall read ( ReadRequest request , SpannerRpc . ResultStreamConsumer consumer , Map<SpannerRpc . Option , ? > options )
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.
updateDatabaseDdl(String databaseName, Iterable<String> updateDatabaseStatements, String updateId)
public OperationFuture<Empty , UpdateDatabaseDdlMetadata > updateDatabaseDdl ( String databaseName , 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 )
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 2024-11-26 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 2024-11-26 UTC."],[],[]]
