Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::Spanner::Rest::ServiceStub (v1.19.2)

1.19.2 (latest) 1.19.1 1.18.0 1.17.1 1.16.0 1.15.0 1.14.0 1.13.0 1.12.1 1.11.1 1.10.1 1.9.1 1.8.0 1.7.1 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.2 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.2 0.21.0 0.20.1 0.19.0 0.18.0 0.17.0 0.16.0 0.15.1 0.14.1 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.1 0.7.4

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::Spanner::Rest::ServiceStub.

REST service stub for the Spanner service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

• Object

Methods

#batch_create_sessions

def batch_create_sessions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::BatchCreateSessionsResponse

Baseline implementation for the batch_create_sessions REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::BatchCreateSessionsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::BatchCreateSessionsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::BatchCreateSessionsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#batch_write

def batch_write(request_pb, options = nil) { |chunk| ... } -> ::Gapic::Rest::TransportOperation

Baseline implementation for the batch_write REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::BatchWriteRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yield Parameter

• chunk (::String) — The chunk of data received during server streaming.

Returns

• (::Gapic::Rest::TransportOperation)

Raises

• (::ArgumentError)

#begin_transaction

def begin_transaction(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::Transaction

Baseline implementation for the begin_transaction REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::BeginTransactionRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::Transaction)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::Transaction) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#commit

def commit(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::CommitResponse

Baseline implementation for the commit REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::CommitRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::CommitResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::CommitResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_session

def create_session(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::Session

Baseline implementation for the create_session REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::CreateSessionRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::Session)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::Session) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_session

def delete_session(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_session REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::DeleteSessionRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#execute_batch_dml

def execute_batch_dml(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::ExecuteBatchDmlResponse

Baseline implementation for the execute_batch_dml REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::ExecuteBatchDmlResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::ExecuteBatchDmlResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#execute_sql

def execute_sql(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::ResultSet

Baseline implementation for the execute_sql REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::ExecuteSqlRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::ResultSet)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::ResultSet) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#execute_streaming_sql

def execute_streaming_sql(request_pb, options = nil) { |chunk| ... } -> ::Gapic::Rest::TransportOperation

Baseline implementation for the execute_streaming_sql REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::ExecuteSqlRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yield Parameter

• chunk (::String) — The chunk of data received during server streaming.

Returns

• (::Gapic::Rest::TransportOperation)

Raises

• (::ArgumentError)

#fetch_cache_update

def fetch_cache_update(request_pb, options = nil) { |chunk| ... } -> ::Gapic::Rest::TransportOperation

Baseline implementation for the fetch_cache_update REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::FetchCacheUpdateRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yield Parameter

• chunk (::String) — The chunk of data received during server streaming.

Returns

• (::Gapic::Rest::TransportOperation)

Raises

• (::ArgumentError)

#get_session

def get_session(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::Session

Baseline implementation for the get_session REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::GetSessionRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::Session)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::Session) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_sessions

def list_sessions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::ListSessionsResponse

Baseline implementation for the list_sessions REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::ListSessionsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::ListSessionsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::ListSessionsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#logger

def logger(stub: false) -> Logger

The logger used for request/response debug logging.

Returns

• (Logger)

#partition_query

def partition_query(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::PartitionResponse

Baseline implementation for the partition_query REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::PartitionQueryRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::PartitionResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::PartitionResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#partition_read

def partition_read(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::PartitionResponse

Baseline implementation for the partition_read REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::PartitionReadRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::PartitionResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::PartitionResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#read

def read(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Spanner::V1::ResultSet

Baseline implementation for the read REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::ReadRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Spanner::V1::ResultSet)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Spanner::V1::ResultSet) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#rollback

def rollback(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the rollback REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::RollbackRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#streaming_read

def streaming_read(request_pb, options = nil) { |chunk| ... } -> ::Gapic::Rest::TransportOperation

Baseline implementation for the streaming_read REST call

Parameters

• request_pb (::Google::Cloud::Spanner::V1::ReadRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yield Parameter

• chunk (::String) — The chunk of data received during server streaming.

Returns

• (::Gapic::Rest::TransportOperation)

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)