Class: Google::Cloud::DiscoveryEngine::V1::DocumentService::Rest::Client::Configuration::Rpcs

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

Overview

Configuration RPC class for the DocumentService 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 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.
    • :jitter (type: Numeric) - The jitter in seconds. Default: 1.0.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Instance Attribute Summary collapse

Instance Attribute Details

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

RPC-specific configuration for batch_get_documents_metadata

Returns:

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


1298
1299
1300
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1298

def batch_get_documents_metadata
  @batch_get_documents_metadata
end

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

RPC-specific configuration for create_document

Returns:

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


1273
1274
1275
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1273

def create_document
  @create_document
end

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

RPC-specific configuration for delete_document

Returns:

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


1283
1284
1285
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1283

def delete_document
  @delete_document
end

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

RPC-specific configuration for get_document

Returns:

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


1263
1264
1265
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1263

def get_document
  @get_document
end

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

RPC-specific configuration for import_documents

Returns:

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


1288
1289
1290
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1288

def import_documents
  @import_documents
end

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

RPC-specific configuration for list_documents

Returns:

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


1268
1269
1270
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1268

def list_documents
  @list_documents
end

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

RPC-specific configuration for purge_documents

Returns:

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


1293
1294
1295
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1293

def purge_documents
  @purge_documents
end

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

RPC-specific configuration for update_document

Returns:

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


1278
1279
1280
 
# File 'lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb', line 1278

def update_document
  @update_document
end