Discovery Engine API - Module Google::Cloud::DiscoveryEngine (v2.0.0)

Reference documentation and code samples for the Discovery Engine API module Google::Cloud::DiscoveryEngine.

Methods

.completion_service

def self.completion_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for CompletionService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::CompletionService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the CompletionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the CompletionService service. You can determine whether the method will succeed by calling DiscoveryEngine.completion_service_available?.

About CompletionService

Service for Auto-Completion.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.completion_service_available?

def self.completion_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the CompletionService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.completion_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the CompletionService service, or if the versioned client gem needs an update to support the CompletionService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-discovery_engine library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with 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.
Yields
  • (::Google::Cloud.configure.discovery_engine)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.control_service

def self.control_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ControlService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::ControlService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ControlService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ControlService service. You can determine whether the method will succeed by calling DiscoveryEngine.control_service_available?.

About ControlService

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.control_service_available?

def self.control_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the ControlService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.control_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ControlService service, or if the versioned client gem needs an update to support the ControlService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.conversational_search_service

def self.conversational_search_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ConversationalSearchService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ConversationalSearchService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ConversationalSearchService service. You can determine whether the method will succeed by calling DiscoveryEngine.conversational_search_service_available?.

About ConversationalSearchService

Service for conversational search.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.conversational_search_service_available?

def self.conversational_search_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the ConversationalSearchService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.conversational_search_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ConversationalSearchService service, or if the versioned client gem needs an update to support the ConversationalSearchService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.data_store_service

def self.data_store_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DataStoreService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::DataStoreService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DataStoreService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DataStoreService service. You can determine whether the method will succeed by calling DiscoveryEngine.data_store_service_available?.

About DataStoreService

Service for managing DataStore configuration.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.data_store_service_available?

def self.data_store_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DataStoreService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.data_store_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DataStoreService service, or if the versioned client gem needs an update to support the DataStoreService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.document_service

def self.document_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DocumentService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::DocumentService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DocumentService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DocumentService service. You can determine whether the method will succeed by calling DiscoveryEngine.document_service_available?.

About DocumentService

Service for ingesting Document information of the customer's website.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.document_service_available?

def self.document_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DocumentService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.document_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DocumentService service, or if the versioned client gem needs an update to support the DocumentService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.engine_service

def self.engine_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for EngineService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::EngineService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the EngineService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the EngineService service. You can determine whether the method will succeed by calling DiscoveryEngine.engine_service_available?.

About EngineService

Service for managing Engine configuration.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.engine_service_available?

def self.engine_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the EngineService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.engine_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the EngineService service, or if the versioned client gem needs an update to support the EngineService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.grounded_generation_service

def self.grounded_generation_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for GroundedGenerationService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the GroundedGenerationService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the GroundedGenerationService service. You can determine whether the method will succeed by calling DiscoveryEngine.grounded_generation_service_available?.

About GroundedGenerationService

Service for grounded generation.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.grounded_generation_service_available?

def self.grounded_generation_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the GroundedGenerationService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.grounded_generation_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the GroundedGenerationService service, or if the versioned client gem needs an update to support the GroundedGenerationService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.project_service

def self.project_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ProjectService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::ProjectService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ProjectService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ProjectService service. You can determine whether the method will succeed by calling DiscoveryEngine.project_service_available?.

About ProjectService

Service for operations on the Project.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.project_service_available?

def self.project_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the ProjectService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.project_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ProjectService service, or if the versioned client gem needs an update to support the ProjectService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.rank_service

def self.rank_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for RankService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::RankService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the RankService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the RankService service. You can determine whether the method will succeed by calling DiscoveryEngine.rank_service_available?.

About RankService

Service for ranking text records.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.rank_service_available?

def self.rank_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the RankService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.rank_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the RankService service, or if the versioned client gem needs an update to support the RankService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.recommendation_service

def self.recommendation_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for RecommendationService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the RecommendationService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the RecommendationService service. You can determine whether the method will succeed by calling DiscoveryEngine.recommendation_service_available?.

About RecommendationService

Service for making recommendations.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.recommendation_service_available?

def self.recommendation_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the RecommendationService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.recommendation_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the RecommendationService service, or if the versioned client gem needs an update to support the RecommendationService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.schema_service

def self.schema_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for SchemaService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::SchemaService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the SchemaService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the SchemaService service. You can determine whether the method will succeed by calling DiscoveryEngine.schema_service_available?.

About SchemaService

Service for managing Schemas.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.schema_service_available?

def self.schema_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the SchemaService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.schema_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SchemaService service, or if the versioned client gem needs an update to support the SchemaService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.search_service

def self.search_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for SearchService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::SearchService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the SearchService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the SearchService service. You can determine whether the method will succeed by calling DiscoveryEngine.search_service_available?.

About SearchService

Service for search.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.search_service_available?

def self.search_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the SearchService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.search_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SearchService service, or if the versioned client gem needs an update to support the SearchService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.search_tuning_service

def self.search_tuning_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for SearchTuningService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::SearchTuningService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the SearchTuningService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the SearchTuningService service. You can determine whether the method will succeed by calling DiscoveryEngine.search_tuning_service_available?.

About SearchTuningService

Service for search tuning.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.search_tuning_service_available?

def self.search_tuning_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the SearchTuningService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.search_tuning_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SearchTuningService service, or if the versioned client gem needs an update to support the SearchTuningService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.site_search_engine_service

def self.site_search_engine_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for SiteSearchEngineService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the SiteSearchEngineService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the SiteSearchEngineService service. You can determine whether the method will succeed by calling DiscoveryEngine.site_search_engine_service_available?.

About SiteSearchEngineService

Service for managing site search related resources.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.site_search_engine_service_available?

def self.site_search_engine_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the SiteSearchEngineService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.site_search_engine_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SiteSearchEngineService service, or if the versioned client gem needs an update to support the SiteSearchEngineService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.user_event_service

def self.user_event_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for UserEventService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::UserEventService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the UserEventService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the UserEventService service. You can determine whether the method will succeed by calling DiscoveryEngine.user_event_service_available?.

About UserEventService

Service for ingesting end user actions on a website to Discovery Engine API.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.user_event_service_available?

def self.user_event_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the UserEventService service is supported by the current client. If true, you can retrieve a client object by calling DiscoveryEngine.user_event_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the UserEventService service, or if the versioned client gem needs an update to support the UserEventService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "2.0.0"