Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::ServingConfigService::Client (v0.11.0)

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

Client for the ServingConfigService service.

Service for operations related to ServingConfig.

Inherits

Object

Includes

Google::Cloud::DiscoveryEngine::V1beta::ServingConfigService::Paths

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

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all ServingConfigService clients
::Google::Cloud::DiscoveryEngine::V1beta::ServingConfigService::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

config (Client::Configuration)

Returns

(Client::Configuration)

#get_serving_config

def get_serving_config(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig
def get_serving_config(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Overloads

def get_serving_config(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig

Pass arguments to get_serving_config via a request object, either of type GetServingConfigRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::DiscoveryEngine::V1beta::GetServingConfigRequest, ::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 get_serving_config(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig

Pass arguments to get_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).

Parameter

name (::String) — Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/discovery_engine/v1beta"

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

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

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

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

#initialize

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

Create a new ServingConfigService client object.

Yields

(config) — Configure the ServingConfigService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfigService::Client.new

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

#list_serving_configs

def list_serving_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig>
def list_serving_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig>

Lists all ServingConfigs linked to this dataStore.

Overloads

def list_serving_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig>

Pass arguments to list_serving_configs via a request object, either of type ListServingConfigsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::DiscoveryEngine::V1beta::ListServingConfigsRequest, ::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 list_serving_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig>

Pass arguments to list_serving_configs 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

parent (::String) — Required. Full resource name of the parent resource. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}
page_size (::Integer) — Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
page_token (::String) — Optional. A page token, received from a previous ListServingConfigs call. Provide this to retrieve the subsequent page.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/discovery_engine/v1beta"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig.
  p item
end

#location_client

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

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

Returns

(Google::Cloud::Location::Locations::Client)

#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::V1beta::ServingConfig
def update_serving_config(serving_config: nil, update_mask: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::ServingConfig

Pass arguments to update_serving_config via a request object, either of type UpdateServingConfigRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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

serving_config (::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig, ::Hash) — Required. The ServingConfig to update.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Indicates which fields in the provided ServingConfig to update. The following are NOT supported:
- ServingConfig.name
If not set, all supported fields are updated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/discovery_engine/v1beta"

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

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

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

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