Class: Google::Cloud::Firestore::V1::Firestore::Client::Configuration::Rpcs

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1/firestore/client.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#batch_get_documents ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for batch_get_documents

Returns:

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


2039
2040
2041
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2039

def batch_get_documents
  @batch_get_documents
end

#batch_write ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for batch_write

Returns:

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


2089
2090
2091
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2089

def batch_write
  @batch_write
end

#begin_transaction ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for begin_transaction

Returns:

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


2044
2045
2046
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2044

def begin_transaction
  @begin_transaction
end

#commit ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for commit

Returns:

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


2049
2050
2051
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2049

def commit
  @commit
end

#create_document ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for create_document

Returns:

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


2094
2095
2096
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2094

def create_document
  @create_document
end

#delete_document ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for delete_document

Returns:

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


2034
2035
2036
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2034

def delete_document
  @delete_document
end

#get_document ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for get_document

Returns:

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


2019
2020
2021
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2019

def get_document
  @get_document
end

#list_collection_ids ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for list_collection_ids

Returns:

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


2084
2085
2086
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2084

def list_collection_ids
  @list_collection_ids
end

#list_documents ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for list_documents

Returns:

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


2024
2025
2026
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2024

def list_documents
  @list_documents
end

#listen ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for listen

Returns:

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


2079
2080
2081
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2079

def listen
  @listen
end

#partition_query ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for partition_query

Returns:

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


2069
2070
2071
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2069

def partition_query
  @partition_query
end

#rollback ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for rollback

Returns:

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


2054
2055
2056
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2054

def rollback
  @rollback
end

#run_aggregation_query ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for run_aggregation_query

Returns:

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


2064
2065
2066
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2064

def run_aggregation_query
  @run_aggregation_query
end

#run_query ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for run_query

Returns:

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


2059
2060
2061
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2059

def run_query
  @run_query
end

#update_document ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for update_document

Returns:

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


2029
2030
2031
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2029

def update_document
  @update_document
end

#write ⇒ ::Gapic::Config::Method (readonly)

RPC-specific configuration for write

Returns:

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


2074
2075
2076
 
# File 'lib/google/cloud/firestore/v1/firestore/client.rb', line 2074

def write
  @write
end