Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::Firestore::Rest::ServiceStub (v0.12.0)

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

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

Inherits

  • Object

Methods

#batch_get_documents

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

Baseline implementation for the batch_get_documents REST call

Parameters
Yield Parameter
  • chunk (::String) — The chunk of data received during server streaming.
Returns
  • (::Gapic::Rest::TransportOperation)
Raises
  • (::ArgumentError)

#batch_write

def batch_write(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::V1::BatchWriteResponse

Baseline implementation for the batch_write REST call

Parameters
  • request_pb (::Google::Cloud::Firestore::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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#begin_transaction

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

Baseline implementation for the begin_transaction REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#commit

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

Baseline implementation for the commit REST call

Parameters
  • request_pb (::Google::Cloud::Firestore::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
Returns
Raises
  • (::ArgumentError)

#create_document

def create_document(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::V1::Document

Baseline implementation for the create_document REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_document

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

Baseline implementation for the delete_document REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_document

def get_document(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::V1::Document

Baseline implementation for the get_document REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#list_collection_ids

def list_collection_ids(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::V1::ListCollectionIdsResponse

Baseline implementation for the list_collection_ids REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_documents

def list_documents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::V1::ListDocumentsResponse

Baseline implementation for the list_documents REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#partition_query

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

Baseline implementation for the partition_query REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
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::Firestore::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
Returns
Raises
  • (::ArgumentError)

#run_aggregation_query

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

Baseline implementation for the run_aggregation_query REST call

Parameters
Yield Parameter
  • chunk (::String) — The chunk of data received during server streaming.
Returns
  • (::Gapic::Rest::TransportOperation)
Raises
  • (::ArgumentError)

#run_query

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

Baseline implementation for the run_query REST call

Parameters
  • request_pb (::Google::Cloud::Firestore::V1::RunQueryRequest) — 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)

#update_document

def update_document(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::V1::Document

Baseline implementation for the update_document REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)