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
- request_pb (::Google::Cloud::Firestore::V1::BatchGetDocumentsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- chunk (::String) — The chunk of data received during server streaming.
- (::Gapic::Rest::TransportOperation)
- (::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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::V1::BatchWriteResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::V1::BatchWriteResponse) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Firestore::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::V1::BeginTransactionResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::V1::BeginTransactionResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#commit
def commit(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::V1::CommitResponse
Baseline implementation for the commit REST call
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::V1::CommitResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::V1::CommitResponse) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Firestore::V1::CreateDocumentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::V1::Document)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::V1::Document) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_document
def delete_document(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_document REST call
- request_pb (::Google::Cloud::Firestore::V1::DeleteDocumentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_document
def get_document(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::V1::Document
Baseline implementation for the get_document REST call
- request_pb (::Google::Cloud::Firestore::V1::GetDocumentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::V1::Document)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::V1::Document) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#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
- request_pb (::Google::Cloud::Firestore::V1::ListCollectionIdsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::V1::ListCollectionIdsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::V1::ListCollectionIdsResponse) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Firestore::V1::ListDocumentsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::V1::ListDocumentsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::V1::ListDocumentsResponse) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Firestore::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::V1::PartitionQueryResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::V1::PartitionQueryResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#rollback
def rollback(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the rollback REST call
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Firestore::V1::RunAggregationQueryRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- chunk (::String) — The chunk of data received during server streaming.
- (::Gapic::Rest::TransportOperation)
- (::ArgumentError)
#run_query
def run_query(request_pb, options = nil, &block) { |chunk| ... } -> ::Gapic::Rest::TransportOperation
Baseline implementation for the run_query REST call
- 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.
- chunk (::String) — The chunk of data received during server streaming.
- (::Gapic::Rest::TransportOperation)
- (::ArgumentError)
#update_document
def update_document(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Firestore::V1::Document
Baseline implementation for the update_document REST call
- request_pb (::Google::Cloud::Firestore::V1::UpdateDocumentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Firestore::V1::Document)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Firestore::V1::Document) — A result object deserialized from the server's reply
- (::ArgumentError)