Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::Firestore::Client::Configuration::Rpcs (v0.9.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::Firestore::Client::Configuration::Rpcs.

Configuration RPC class for the Firestore API.

Includes fields providing the configuration for each RPC in this service. Each configuration object is of type Gapic::Config::Method and includes the following configuration fields:

  • timeout (type: Numeric) - The call timeout in seconds
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers
  • retry_policy (type:Hash`) - The retry policy. The policy fields include the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Inherits

  • Object

Methods

#batch_get_documents

def batch_get_documents() -> ::Gapic::Config::Method

RPC-specific configuration for batch_get_documents

Returns
  • (::Gapic::Config::Method)

#batch_write

def batch_write() -> ::Gapic::Config::Method

RPC-specific configuration for batch_write

Returns
  • (::Gapic::Config::Method)

#begin_transaction

def begin_transaction() -> ::Gapic::Config::Method

RPC-specific configuration for begin_transaction

Returns
  • (::Gapic::Config::Method)

#commit

def commit() -> ::Gapic::Config::Method

RPC-specific configuration for commit

Returns
  • (::Gapic::Config::Method)

#create_document

def create_document() -> ::Gapic::Config::Method

RPC-specific configuration for create_document

Returns
  • (::Gapic::Config::Method)

#delete_document

def delete_document() -> ::Gapic::Config::Method

RPC-specific configuration for delete_document

Returns
  • (::Gapic::Config::Method)

#get_document

def get_document() -> ::Gapic::Config::Method

RPC-specific configuration for get_document

Returns
  • (::Gapic::Config::Method)

#list_collection_ids

def list_collection_ids() -> ::Gapic::Config::Method

RPC-specific configuration for list_collection_ids

Returns
  • (::Gapic::Config::Method)

#list_documents

def list_documents() -> ::Gapic::Config::Method

RPC-specific configuration for list_documents

Returns
  • (::Gapic::Config::Method)

#listen

def listen() -> ::Gapic::Config::Method

RPC-specific configuration for listen

Returns
  • (::Gapic::Config::Method)

#partition_query

def partition_query() -> ::Gapic::Config::Method

RPC-specific configuration for partition_query

Returns
  • (::Gapic::Config::Method)

#rollback

def rollback() -> ::Gapic::Config::Method

RPC-specific configuration for rollback

Returns
  • (::Gapic::Config::Method)

#run_aggregation_query

def run_aggregation_query() -> ::Gapic::Config::Method

RPC-specific configuration for run_aggregation_query

Returns
  • (::Gapic::Config::Method)

#run_query

def run_query() -> ::Gapic::Config::Method

RPC-specific configuration for run_query

Returns
  • (::Gapic::Config::Method)

#update_document

def update_document() -> ::Gapic::Config::Method

RPC-specific configuration for update_document

Returns
  • (::Gapic::Config::Method)

#write

def write() -> ::Gapic::Config::Method

RPC-specific configuration for write

Returns
  • (::Gapic::Config::Method)