Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::ServingConfigService::Rest::Client (v2.1.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::ServingConfigService::Rest::Client.

REST client for the ServingConfigService service.

Service for operations related to ServingConfig.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ServingConfigService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all ServingConfigService clients
::Google::Cloud::DiscoveryEngine::V1::ServingConfigService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ServingConfigService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new ServingConfigService REST client object.

Yields
  • (config) — Configure the ServingConfigService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::DiscoveryEngine::V1::ServingConfigService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DiscoveryEngine::V1::ServingConfigService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_serving_config

def update_serving_config(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::ServingConfig
def update_serving_config(serving_config: nil, update_mask: nil) -> ::Google::Cloud::DiscoveryEngine::V1::ServingConfig

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

Overloads 
def update_serving_config(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::ServingConfig
Pass arguments to update_serving_config via a request object, either of type UpdateServingConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::UpdateServingConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_serving_config(serving_config: nil, update_mask: nil) -> ::Google::Cloud::DiscoveryEngine::V1::ServingConfig
Pass arguments to update_serving_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DiscoveryEngine::V1::ServingConfigService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DiscoveryEngine::V1::UpdateServingConfigRequest.new

# Call the update_serving_config method.
result = client.update_serving_config request

# The returned object is of type Google::Cloud::DiscoveryEngine::V1::ServingConfig.
p result