Class: Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig::AlloyDbConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb

Overview

Stores information for connecting to AlloyDB.

Defined Under Namespace

Classes: AlloyDbAiNaturalLanguageConfig, AlloyDbConnectionConfig

Instance Attribute Summary collapse

Instance Attribute Details

#alloydb_ai_nl_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig::AlloyDbConfig::AlloyDbAiNaturalLanguageConfig

Returns Optional. Configuration for Magic.

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 235

class AlloyDbConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for connecting to AlloyDB.
  # @!attribute [rw] instance
  #   @return [::String]
  #     Required. The AlloyDB instance to connect to.
  # @!attribute [rw] database
  #   @return [::String]
  #     Required. The AlloyDB database to connect to.
  # @!attribute [rw] user
  #   @return [::String]
  #     Required. Database user.
  #
  #     If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
  #     the user will be inferred on the AlloyDB side, based on the
  #     authenticated user.
  # @!attribute [rw] password
  #   @return [::String]
  #     Required. Database password.
  #
  #     If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
  #     the password will be inferred on the AlloyDB side, based on the
  #     authenticated user.
  # @!attribute [rw] auth_mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig::AlloyDbConfig::AlloyDbConnectionConfig::AuthMode]
  #     Optional. Auth mode.
  # @!attribute [rw] enable_psvs
  #   @return [::Boolean]
  #     Optional. If true, enable PSVS for AlloyDB.
  class AlloyDbConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Auth mode.
    module AuthMode
      AUTH_MODE_UNSPECIFIED = 0

      # Uses P4SA when VAIS talks to AlloyDB.
      AUTH_MODE_SERVICE_ACCOUNT = 1

      # Uses EUC when VAIS talks to AlloyDB.
      AUTH_MODE_END_USER_ACCOUNT = 2
    end
  end

  # Configuration for AlloyDB AI Natural Language.
  # @!attribute [rw] nl_config_id
  #   @return [::String]
  #     Optional. AlloyDb AI NL config id, i.e. the value that was used for
  #     calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be
  #     empty.
  class AlloyDbAiNaturalLanguageConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#alloydb_connection_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig::AlloyDbConfig::AlloyDbConnectionConfig

Returns Required. Configuration for connecting to AlloyDB.

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 235

class AlloyDbConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for connecting to AlloyDB.
  # @!attribute [rw] instance
  #   @return [::String]
  #     Required. The AlloyDB instance to connect to.
  # @!attribute [rw] database
  #   @return [::String]
  #     Required. The AlloyDB database to connect to.
  # @!attribute [rw] user
  #   @return [::String]
  #     Required. Database user.
  #
  #     If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
  #     the user will be inferred on the AlloyDB side, based on the
  #     authenticated user.
  # @!attribute [rw] password
  #   @return [::String]
  #     Required. Database password.
  #
  #     If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
  #     the password will be inferred on the AlloyDB side, based on the
  #     authenticated user.
  # @!attribute [rw] auth_mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig::AlloyDbConfig::AlloyDbConnectionConfig::AuthMode]
  #     Optional. Auth mode.
  # @!attribute [rw] enable_psvs
  #   @return [::Boolean]
  #     Optional. If true, enable PSVS for AlloyDB.
  class AlloyDbConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Auth mode.
    module AuthMode
      AUTH_MODE_UNSPECIFIED = 0

      # Uses P4SA when VAIS talks to AlloyDB.
      AUTH_MODE_SERVICE_ACCOUNT = 1

      # Uses EUC when VAIS talks to AlloyDB.
      AUTH_MODE_END_USER_ACCOUNT = 2
    end
  end

  # Configuration for AlloyDB AI Natural Language.
  # @!attribute [rw] nl_config_id
  #   @return [::String]
  #     Optional. AlloyDb AI NL config id, i.e. the value that was used for
  #     calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be
  #     empty.
  class AlloyDbAiNaturalLanguageConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#returned_fields ⇒ ::Array<::String>

Returns Optional. Fields to be returned in the search results. If empty, all fields will be returned.

Returns:

  • (::Array<::String>) —

    Optional. Fields to be returned in the search results. If empty, all fields will be returned.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb', line 235

class AlloyDbConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for connecting to AlloyDB.
  # @!attribute [rw] instance
  #   @return [::String]
  #     Required. The AlloyDB instance to connect to.
  # @!attribute [rw] database
  #   @return [::String]
  #     Required. The AlloyDB database to connect to.
  # @!attribute [rw] user
  #   @return [::String]
  #     Required. Database user.
  #
  #     If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
  #     the user will be inferred on the AlloyDB side, based on the
  #     authenticated user.
  # @!attribute [rw] password
  #   @return [::String]
  #     Required. Database password.
  #
  #     If auth_mode = END_USER_ACCOUNT, it can be unset. In that case,
  #     the password will be inferred on the AlloyDB side, based on the
  #     authenticated user.
  # @!attribute [rw] auth_mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DataStore::FederatedSearchConfig::AlloyDbConfig::AlloyDbConnectionConfig::AuthMode]
  #     Optional. Auth mode.
  # @!attribute [rw] enable_psvs
  #   @return [::Boolean]
  #     Optional. If true, enable PSVS for AlloyDB.
  class AlloyDbConnectionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Auth mode.
    module AuthMode
      AUTH_MODE_UNSPECIFIED = 0

      # Uses P4SA when VAIS talks to AlloyDB.
      AUTH_MODE_SERVICE_ACCOUNT = 1

      # Uses EUC when VAIS talks to AlloyDB.
      AUTH_MODE_END_USER_ACCOUNT = 2
    end
  end

  # Configuration for AlloyDB AI Natural Language.
  # @!attribute [rw] nl_config_id
  #   @return [::String]
  #     Optional. AlloyDb AI NL config id, i.e. the value that was used for
  #     calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be
  #     empty.
  class AlloyDbAiNaturalLanguageConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end