Class: Google::Apis::SpannerV1::SpannerService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/spanner_v1/service.rb

Overview

Cloud Spanner API

Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.

Examples:

require 'google/apis/spanner_v1'

Spanner = Google::Apis::SpannerV1 # Alias the module
service = Spanner::SpannerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ SpannerService

Returns a new instance of SpannerService



46
47
48
49
 
# File 'generated/google/apis/spanner_v1/service.rb', line 46

def initialize
  super('https://spanner.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
 
# File 'generated/google/apis/spanner_v1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
 
# File 'generated/google/apis/spanner_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#begin_session_transaction(session, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Transaction

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

Parameters:

  • session (String) —

    Required. The session in which the transaction runs.

  • begin_transaction_request_object (Google::Apis::SpannerV1::BeginTransactionRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1000

def begin_session_transaction(session, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+session}:beginTransaction', options)
  command.request_representation = Google::Apis::SpannerV1::BeginTransactionRequest::Representation
  command.request_object = begin_transaction_request_object
  command.response_representation = Google::Apis::SpannerV1::Transaction::Representation
  command.response_class = Google::Apis::SpannerV1::Transaction
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



854
855
856
857
858
859
860
861
862
 
# File 'generated/google/apis/spanner_v1/service.rb', line 854

def cancel_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::SpannerV1::Empty::Representation
  command.response_class = Google::Apis::SpannerV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_instance_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1515

def cancel_project_instance_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::SpannerV1::Empty::Representation
  command.response_class = Google::Apis::SpannerV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#commit_session(session, commit_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::CommitResponse

Commits a transaction. The request includes the mutations to be applied to rows in the database. Commit might return an ABORTED error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If Commit returns ABORTED, the caller should re-attempt the transaction from the beginning, re-using the same session.

Parameters:

  • session (String) —

    Required. The session in which the transaction to be committed is running.

  • commit_request_object (Google::Apis::SpannerV1::CommitRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1039

def commit_session(session, commit_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+session}:commit', options)
  command.request_representation = Google::Apis::SpannerV1::CommitRequest::Representation
  command.request_object = commit_request_object
  command.response_representation = Google::Apis::SpannerV1::CommitResponse::Representation
  command.response_class = Google::Apis::SpannerV1::CommitResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_database(parent, create_database_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

Parameters:

  • parent (String) —

    Required. The name of the instance that will serve the new database. Values are of the form projects/<project>/instances/<instance>.

  • create_database_request_object (Google::Apis::SpannerV1::CreateDatabaseRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



523
524
525
526
527
528
529
530
531
532
533
 
# File 'generated/google/apis/spanner_v1/service.rb', line 523

def create_database(parent, create_database_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}/databases', options)
  command.request_representation = Google::Apis::SpannerV1::CreateDatabaseRequest::Representation
  command.request_object = create_database_request_object
  command.response_representation = Google::Apis::SpannerV1::Operation::Representation
  command.response_class = Google::Apis::SpannerV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_instance(parent, create_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation

Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, CreateInstance returns ALREADY_EXISTS. Immediately upon completion of this request:

  • The instance is readable via the API, with all requested attributes but no allocated resources. Its state is CREATING. Until completion of the returned operation:
  • Cancelling the operation renders the instance immediately unreadable via the API.
  • The instance can be deleted.
  • All other attempts to modify the instance are rejected. Upon completion of the returned operation:
  • Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
  • Databases can be created in the instance.
  • The instance's allocated resource levels are readable via the API.
  • The instance's state becomes READY. The returned long-running operation will have a name of the format <instance_name>/operations/<operation_id> and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.

Parameters:

  • parent (String) —

    Required. The name of the project in which to create the instance. Values are of the form projects/<project>.

  • create_instance_request_object (Google::Apis::SpannerV1::CreateInstanceRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



171
172
173
174
175
176
177
178
179
180
181
 
# File 'generated/google/apis/spanner_v1/service.rb', line 171

def create_instance(parent, create_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}/instances', options)
  command.request_representation = Google::Apis::SpannerV1::CreateInstanceRequest::Representation
  command.request_object = create_instance_request_object
  command.response_representation = Google::Apis::SpannerV1::Operation::Representation
  command.response_class = Google::Apis::SpannerV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_instance_database_session(database, create_session_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Session

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Cloud Spanner limits the number of sessions that can exist at any given time; thus, it is a good idea to delete idle and/or unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return NOT_FOUND. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

Parameters:

  • database (String) —

    Required. The database in which the new session is created.

  • create_session_request_object (Google::Apis::SpannerV1::CreateSessionRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1087

def create_project_instance_database_session(database, create_session_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+database}/sessions', options)
  command.request_representation = Google::Apis::SpannerV1::CreateSessionRequest::Representation
  command.request_object = create_session_request_object
  command.response_representation = Google::Apis::SpannerV1::Session::Representation
  command.response_class = Google::Apis::SpannerV1::Session
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty

Deletes an instance. Immediately upon completion of the request:

  • Billing ceases for all of the instance's reserved resources. Soon afterward:
  • The instance and all of its databases immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.

Parameters:

  • name (String) —

    Required. The name of the instance to be deleted. Values are of the form projects/<project>/instances/<instance>

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



210
211
212
213
214
215
216
217
218
 
# File 'generated/google/apis/spanner_v1/service.rb', line 210

def delete_project_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::Empty::Representation
  command.response_class = Google::Apis::SpannerV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



887
888
889
890
891
892
893
894
895
 
# File 'generated/google/apis/spanner_v1/service.rb', line 887

def delete_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::Empty::Representation
  command.response_class = Google::Apis::SpannerV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty

Ends a session, releasing server resources associated with it.

Parameters:

  • name (String) —

    Required. The name of the session to delete.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1119
1120
1121
1122
1123
1124
1125
1126
1127
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1119

def delete_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::Empty::Representation
  command.response_class = Google::Apis::SpannerV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_instance_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1548
1549
1550
1551
1552
1553
1554
1555
1556
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1548

def delete_project_instance_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::Empty::Representation
  command.response_class = Google::Apis::SpannerV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#drop_project_instance_database_database(database, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty

Drops (aka deletes) a Cloud Spanner database.

Parameters:

  • database (String) —

    Required. The database to be dropped.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



555
556
557
558
559
560
561
562
563
 
# File 'generated/google/apis/spanner_v1/service.rb', line 555

def drop_project_instance_database_database(database, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+database}', options)
  command.response_representation = Google::Apis::SpannerV1::Empty::Representation
  command.response_class = Google::Apis::SpannerV1::Empty
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_project_instance_database_session_streaming_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartialResultSet

Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

Parameters:

  • session (String) —

    Required. The session in which the SQL query should be performed.

  • execute_sql_request_object (Google::Apis::SpannerV1::ExecuteSqlRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1195

def execute_project_instance_database_session_streaming_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+session}:executeStreamingSql', options)
  command.request_representation = Google::Apis::SpannerV1::ExecuteSqlRequest::Representation
  command.request_object = execute_sql_request_object
  command.response_representation = Google::Apis::SpannerV1::PartialResultSet::Representation
  command.response_class = Google::Apis::SpannerV1::PartialResultSet
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_session_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ResultSet

Executes an SQL query, returning all rows in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a FAILED_PRECONDITION error. Queries inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

Parameters:

  • session (String) —

    Required. The session in which the SQL query should be performed.

  • execute_sql_request_object (Google::Apis::SpannerV1::ExecuteSqlRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1158

def execute_session_sql(session, execute_sql_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+session}:executeSql', options)
  command.request_representation = Google::Apis::SpannerV1::ExecuteSqlRequest::Representation
  command.request_object = execute_sql_request_object
  command.response_representation = Google::Apis::SpannerV1::ResultSet::Representation
  command.response_class = Google::Apis::SpannerV1::ResultSet
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_database_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy

Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires spanner.databases.getIamPolicy permission on resource.

Parameters:

  • resource (String) —

    REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is projects/<project ID>/instances/<instance ID> for instance resources and projects/<project ID>/instances/<instance ID>/databases/< database ID> for database resources.

  • get_iam_policy_request_object (Google::Apis::SpannerV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



655
656
657
658
659
660
661
662
663
664
665
 
# File 'generated/google/apis/spanner_v1/service.rb', line 655

def get_database_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::SpannerV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::SpannerV1::Policy::Representation
  command.response_class = Google::Apis::SpannerV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_instance_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy

Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. Authorization requires spanner.instances.getIamPolicy on resource.

Parameters:

  • resource (String) —

    REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is projects/<project ID>/instances/<instance ID> for instance resources and projects/<project ID>/instances/<instance ID>/databases/< database ID> for database resources.

  • get_iam_policy_request_object (Google::Apis::SpannerV1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



278
279
280
281
282
283
284
285
286
287
288
 
# File 'generated/google/apis/spanner_v1/service.rb', line 278

def get_instance_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::SpannerV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::SpannerV1::Policy::Representation
  command.response_class = Google::Apis::SpannerV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Instance

Gets information about a particular instance.

Parameters:

  • name (String) —

    Required. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



241
242
243
244
245
246
247
248
249
 
# File 'generated/google/apis/spanner_v1/service.rb', line 241

def get_project_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::Instance::Representation
  command.response_class = Google::Apis::SpannerV1::Instance
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_instance_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::InstanceConfig

Gets information about a particular instance configuration.

Parameters:

  • name (String) —

    Required. The name of the requested instance configuration. Values are of the form projects/<project>/instanceConfigs/<config>.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



72
73
74
75
76
77
78
79
80
 
# File 'generated/google/apis/spanner_v1/service.rb', line 72

def get_project_instance_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::InstanceConfig::Representation
  command.response_class = Google::Apis::SpannerV1::InstanceConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_instance_database(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Database

Gets the state of a Cloud Spanner database.

Parameters:

  • name (String) —

    Required. The name of the requested database. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



586
587
588
589
590
591
592
593
594
 
# File 'generated/google/apis/spanner_v1/service.rb', line 586

def get_project_instance_database(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::Database::Representation
  command.response_class = Google::Apis::SpannerV1::Database
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_instance_database_ddl(database, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::GetDatabaseDdlResponse

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API.

Parameters:

  • database (String) —

    Required. The database whose schema we wish to get.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



618
619
620
621
622
623
624
625
626
 
# File 'generated/google/apis/spanner_v1/service.rb', line 618

def get_project_instance_database_ddl(database, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+database}/ddl', options)
  command.response_representation = Google::Apis::SpannerV1::GetDatabaseDdlResponse::Representation
  command.response_class = Google::Apis::SpannerV1::GetDatabaseDdlResponse
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



919
920
921
922
923
924
925
926
927
 
# File 'generated/google/apis/spanner_v1/service.rb', line 919

def get_project_instance_database_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::Operation::Representation
  command.response_class = Google::Apis::SpannerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Session

Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive.

Parameters:

  • name (String) —

    Required. The name of the session to retrieve.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1229

def get_project_instance_database_session(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::Session::Representation
  command.response_class = Google::Apis::SpannerV1::Session
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_instance_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1580
1581
1582
1583
1584
1585
1586
1587
1588
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1580

def get_project_instance_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::Operation::Representation
  command.response_class = Google::Apis::SpannerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_instance_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListInstanceConfigsResponse

Lists the supported instance configurations for a given project.

Parameters:

  • parent (String) —

    Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form projects/<project>.

  • page_size (Fixnum) —

    Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

  • page_token (String) —

    If non-empty, page_token should contain a next_page_token from a previous ListInstanceConfigsResponse.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



111
112
113
114
115
116
117
118
119
120
121
 
# File 'generated/google/apis/spanner_v1/service.rb', line 111

def list_project_instance_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/instanceConfigs', options)
  command.response_representation = Google::Apis::SpannerV1::ListInstanceConfigsResponse::Representation
  command.response_class = Google::Apis::SpannerV1::ListInstanceConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_instance_database_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) —

    The standard list filter.

  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'generated/google/apis/spanner_v1/service.rb', line 963

def list_project_instance_database_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::SpannerV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_instance_database_sessions(database, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListSessionsResponse

Lists all sessions in a given database.

Parameters:

  • database (String) —

    Required. The database in which to list sessions.

  • filter (String) —

    An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

    • labels.key where key is the name of a label Some examples of using filters are:
    • labels.env:* --> The session has the label "env".
    • labels.env:dev --> The session has the label "env" and the value of the label contains the string "dev".
  • page_size (Fixnum) —

    Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

  • page_token (String) —

    If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1274

def list_project_instance_database_sessions(database, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+database}/sessions', options)
  command.response_representation = Google::Apis::SpannerV1::ListSessionsResponse::Representation
  command.response_class = Google::Apis::SpannerV1::ListSessionsResponse
  command.params['database'] = database unless database.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_instance_databases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListDatabasesResponse

Lists Cloud Spanner databases.

Parameters:

  • parent (String) —

    Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>.

  • page_size (Fixnum) —

    Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

  • page_token (String) —

    If non-empty, page_token should contain a next_page_token from a previous ListDatabasesResponse.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



695
696
697
698
699
700
701
702
703
704
705
 
# File 'generated/google/apis/spanner_v1/service.rb', line 695

def list_project_instance_databases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/databases', options)
  command.response_representation = Google::Apis::SpannerV1::ListDatabasesResponse::Representation
  command.response_class = Google::Apis::SpannerV1::ListDatabasesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_instance_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) —

    The standard list filter.

  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1624

def list_project_instance_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::SpannerV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::SpannerV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_instances(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ListInstancesResponse

Lists all instances in the given project.

Parameters:

  • parent (String) —

    Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

  • filter (String) —

    An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

    • name
    • display_name
    • labels.key where key is the name of a label Some examples of using filters are:
    • name:* --> The instance has a name.
    • name:Howl --> The instance's name contains the string "howl".
    • name:HOWL --> Equivalent to above.
    • NAME:howl --> Equivalent to above.
    • labels.env:* --> The instance has the label "env".
    • labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
    • name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".
  • page_size (Fixnum) —

    Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

  • page_token (String) —

    If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'generated/google/apis/spanner_v1/service.rb', line 335

def list_project_instances(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/instances', options)
  command.response_representation = Google::Apis::SpannerV1::ListInstancesResponse::Representation
  command.response_class = Google::Apis::SpannerV1::ListInstancesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#partition_session_query(session, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartitionResponse

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted or begins a new transaction.

Parameters:

  • session (String) —

    Required. The session used to create the partitions.

  • partition_query_request_object (Google::Apis::SpannerV1::PartitionQueryRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1315

def partition_session_query(session, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+session}:partitionQuery', options)
  command.request_representation = Google::Apis::SpannerV1::PartitionQueryRequest::Representation
  command.request_object = partition_query_request_object
  command.response_representation = Google::Apis::SpannerV1::PartitionResponse::Representation
  command.response_class = Google::Apis::SpannerV1::PartitionResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#partition_session_read(session, partition_read_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartitionResponse

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted or begins a new transaction.

Parameters:

  • session (String) —

    Required. The session used to create the partitions.

  • partition_read_request_object (Google::Apis::SpannerV1::PartitionReadRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1355

def partition_session_read(session, partition_read_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+session}:partitionRead', options)
  command.request_representation = Google::Apis::SpannerV1::PartitionReadRequest::Representation
  command.request_object = partition_read_request_object
  command.response_representation = Google::Apis::SpannerV1::PartitionResponse::Representation
  command.response_class = Google::Apis::SpannerV1::PartitionResponse
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_instance(name, update_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation

Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns NOT_FOUND. Immediately upon completion of this request:

  • For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation:
  • Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a CANCELLED status.
  • All other attempts to modify the instance are rejected.
  • Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation:
  • Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
  • All newly-reserved resources are available for serving the instance's tables.
  • The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format <instance_name>/operations/<operation_id> and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires spanner.instances.update permission on resource name.

Parameters:

  • name (String) —

    Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects/<project>/instances/a-z*[a-z0-9]. The final segment of the name must be between 6 and 30 characters in length.

  • update_instance_request_object (Google::Apis::SpannerV1::UpdateInstanceRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



403
404
405
406
407
408
409
410
411
412
413
 
# File 'generated/google/apis/spanner_v1/service.rb', line 403

def patch_project_instance(name, update_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::SpannerV1::UpdateInstanceRequest::Representation
  command.request_object = update_instance_request_object
  command.response_representation = Google::Apis::SpannerV1::Operation::Representation
  command.response_class = Google::Apis::SpannerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_session(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::ResultSet

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a FAILED_PRECONDITION error. Reads inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

Parameters:

  • session (String) —

    Required. The session in which the read should be performed.

  • read_request_object (Google::Apis::SpannerV1::ReadRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1398

def read_session(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+session}:read', options)
  command.request_representation = Google::Apis::SpannerV1::ReadRequest::Representation
  command.request_object = read_request_object
  command.response_representation = Google::Apis::SpannerV1::ResultSet::Representation
  command.response_class = Google::Apis::SpannerV1::ResultSet
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rollback_session(session, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Empty

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. Rollback never returns ABORTED.

Parameters:

  • session (String) —

    Required. The session in which the transaction to roll back is running.

  • rollback_request_object (Google::Apis::SpannerV1::RollbackRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1437

def rollback_session(session, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+session}:rollback', options)
  command.request_representation = Google::Apis::SpannerV1::RollbackRequest::Representation
  command.request_object = rollback_request_object
  command.response_representation = Google::Apis::SpannerV1::Empty::Representation
  command.response_class = Google::Apis::SpannerV1::Empty
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_database_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy

Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires spanner.databases.setIamPolicy permission on resource.

Parameters:

  • resource (String) —

    REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is projects/<project ID>/instances/<instance ID> for instance resources and projects/<project ID>/instances/<instance ID>/databases/< database ID> for databases resources.

  • set_iam_policy_request_object (Google::Apis::SpannerV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



734
735
736
737
738
739
740
741
742
743
744
 
# File 'generated/google/apis/spanner_v1/service.rb', line 734

def set_database_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::SpannerV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::SpannerV1::Policy::Representation
  command.response_class = Google::Apis::SpannerV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Policy

Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires spanner.instances.setIamPolicy on resource.

Parameters:

  • resource (String) —

    REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is projects/<project ID>/instances/<instance ID> for instance resources and projects/<project ID>/instances/<instance ID>/databases/< database ID> for databases resources.

  • set_iam_policy_request_object (Google::Apis::SpannerV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



442
443
444
445
446
447
448
449
450
451
452
 
# File 'generated/google/apis/spanner_v1/service.rb', line 442

def set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::SpannerV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::SpannerV1::Policy::Representation
  command.response_class = Google::Apis::SpannerV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#streaming_project_instance_database_session_read(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::PartialResultSet

Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

Parameters:

  • session (String) —

    Required. The session in which the read should be performed.

  • read_request_object (Google::Apis::SpannerV1::ReadRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'generated/google/apis/spanner_v1/service.rb', line 1474

def streaming_project_instance_database_session_read(session, read_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+session}:streamingRead', options)
  command.request_representation = Google::Apis::SpannerV1::ReadRequest::Representation
  command.request_object = read_request_object
  command.response_representation = Google::Apis::SpannerV1::PartialResultSet::Representation
  command.response_class = Google::Apis::SpannerV1::PartialResultSet
  command.params['session'] = session unless session.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_database_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::TestIamPermissionsResponse

Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has spanner.databases.list permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions.

Parameters:

  • resource (String) —

    REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is projects/<project ID>/instances/<instance ID> for instance resources and projects/<project ID>/instances/<instance ID>/databases/< database ID> for database resources.

  • test_iam_permissions_request_object (Google::Apis::SpannerV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



774
775
776
777
778
779
780
781
782
783
784
 
# File 'generated/google/apis/spanner_v1/service.rb', line 774

def test_database_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::SpannerV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::SpannerV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::SpannerV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::TestIamPermissionsResponse

Returns permissions that the caller has on the specified instance resource. Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has spanner.instances.list permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

Parameters:

  • resource (String) —

    REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is projects/<project ID>/instances/<instance ID> for instance resources and projects/<project ID>/instances/<instance ID>/databases/< database ID> for database resources.

  • test_iam_permissions_request_object (Google::Apis::SpannerV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



482
483
484
485
486
487
488
489
490
491
492
 
# File 'generated/google/apis/spanner_v1/service.rb', line 482

def test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::SpannerV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::SpannerV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::SpannerV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_instance_database_ddl(database, update_database_ddl_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpannerV1::Operation

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format <database_name>/operations/<operation_id> and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.

Parameters:

  • database (String) —

    Required. The database to update.

  • update_database_ddl_request_object (Google::Apis::SpannerV1::UpdateDatabaseDdlRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



813
814
815
816
817
818
819
820
821
822
823
 
# File 'generated/google/apis/spanner_v1/service.rb', line 813

def update_project_instance_database_ddl(database, update_database_ddl_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/{+database}/ddl', options)
  command.request_representation = Google::Apis::SpannerV1::UpdateDatabaseDdlRequest::Representation
  command.request_object = update_database_ddl_request_object
  command.response_representation = Google::Apis::SpannerV1::Operation::Representation
  command.response_class = Google::Apis::SpannerV1::Operation
  command.params['database'] = database unless database.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end