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

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

Overview

Configuration RPC class for the FirestoreAdmin 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

#create_index::Gapic::Config::Method (readonly)

RPC-specific configuration for create_index

Returns:

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


1227
1228
1229
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 1227

def create_index
  @create_index
end

#delete_index::Gapic::Config::Method (readonly)

RPC-specific configuration for delete_index

Returns:

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


1242
1243
1244
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 1242

def delete_index
  @delete_index
end

#export_documents::Gapic::Config::Method (readonly)

RPC-specific configuration for export_documents

Returns:

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


1262
1263
1264
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 1262

def export_documents
  @export_documents
end

#get_field::Gapic::Config::Method (readonly)

RPC-specific configuration for get_field

Returns:

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


1247
1248
1249
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 1247

def get_field
  @get_field
end

#get_index::Gapic::Config::Method (readonly)

RPC-specific configuration for get_index

Returns:

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


1237
1238
1239
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 1237

def get_index
  @get_index
end

#import_documents::Gapic::Config::Method (readonly)

RPC-specific configuration for import_documents

Returns:

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


1267
1268
1269
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 1267

def import_documents
  @import_documents
end

#list_fields::Gapic::Config::Method (readonly)

RPC-specific configuration for list_fields

Returns:

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


1257
1258
1259
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 1257

def list_fields
  @list_fields
end

#list_indexes::Gapic::Config::Method (readonly)

RPC-specific configuration for list_indexes

Returns:

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


1232
1233
1234
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 1232

def list_indexes
  @list_indexes
end

#update_field::Gapic::Config::Method (readonly)

RPC-specific configuration for update_field

Returns:

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


1252
1253
1254
# File 'lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb', line 1252

def update_field
  @update_field
end