Retail V2 API - Class Google::Cloud::Retail::V2::ServingConfigService::Client (v0.21.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::ServingConfigService::Client.

Client for the ServingConfigService service.

Service for modifying 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::Retail::V2::ServingConfigService::Client.configure do |config|
  config.timeout = 10.0
end

#add_control

def add_control(request, options = nil) -> ::Google::Cloud::Retail::V2::ServingConfig
def add_control(serving_config: nil, control_id: nil) -> ::Google::Cloud::Retail::V2::ServingConfig

Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

Overloads 
def add_control(request, options = nil) -> ::Google::Cloud::Retail::V2::ServingConfig
Pass arguments to add_control via a request object, either of type AddControlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::AddControlRequest, ::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 add_control(serving_config: nil, control_id: nil) -> ::Google::Cloud::Retail::V2::ServingConfig
Pass arguments to add_control 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 (::String) — Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
  • control_id (::String) — Required. The id of the control to apply. Assumed to be in the same catalog as the serving config - if id is not found a NOT_FOUND error is returned.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/retail/v2"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Retail::V2::AddControlRequest.new

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

# The returned object is of type Google::Cloud::Retail::V2::ServingConfig.
p result

#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

#create_serving_config

def create_serving_config(request, options = nil) -> ::Google::Cloud::Retail::V2::ServingConfig
def create_serving_config(parent: nil, serving_config: nil, serving_config_id: nil) -> ::Google::Cloud::Retail::V2::ServingConfig

Creates a ServingConfig.

A maximum of 100 {::Google::Cloud::Retail::V2::ServingConfig ServingConfig}s are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.

Overloads 
def create_serving_config(request, options = nil) -> ::Google::Cloud::Retail::V2::ServingConfig
Pass arguments to create_serving_config via a request object, either of type CreateServingConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::CreateServingConfigRequest, ::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 create_serving_config(parent: nil, serving_config: nil, serving_config_id: nil) -> ::Google::Cloud::Retail::V2::ServingConfig
Pass arguments to create_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
  • parent (::String) — Required. Full resource name of parent. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
  • serving_config (::Google::Cloud::Retail::V2::ServingConfig, ::Hash) — Required. The ServingConfig to create.
  • serving_config_id (::String) — Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/retail/v2"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Retail::V2::CreateServingConfigRequest.new

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

# The returned object is of type Google::Cloud::Retail::V2::ServingConfig.
p result

#delete_serving_config

def delete_serving_config(request, options = nil) -> ::Google::Protobuf::Empty
def delete_serving_config(name: nil) -> ::Google::Protobuf::Empty

Deletes a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Overloads 
def delete_serving_config(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_serving_config via a request object, either of type DeleteServingConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::DeleteServingConfigRequest, ::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 delete_serving_config(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_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 delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/retail/v2"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Retail::V2::DeleteServingConfigRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

#get_serving_config

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

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Overloads 
def get_serving_config(request, options = nil) -> ::Google::Cloud::Retail::V2::ServingConfig
Pass arguments to get_serving_config via a request object, either of type GetServingConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::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::Retail::V2::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_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/retail/v2"

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

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

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

# The returned object is of type Google::Cloud::Retail::V2::ServingConfig.
p result

#initialize

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

Create a new ServingConfigService 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::Retail::V2::ServingConfigService::Client.new

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

#list_serving_configs

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

Lists all ServingConfigs linked to this catalog.

Overloads 
def list_serving_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Retail::V2::ServingConfig>
Pass arguments to list_serving_configs via a request object, either of type ListServingConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::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::Retail::V2::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. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
  • 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
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/retail/v2"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Retail::V2::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::Retail::V2::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)

#remove_control

def remove_control(request, options = nil) -> ::Google::Cloud::Retail::V2::ServingConfig
def remove_control(serving_config: nil, control_id: nil) -> ::Google::Cloud::Retail::V2::ServingConfig

Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

Overloads 
def remove_control(request, options = nil) -> ::Google::Cloud::Retail::V2::ServingConfig
Pass arguments to remove_control via a request object, either of type RemoveControlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::RemoveControlRequest, ::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 remove_control(serving_config: nil, control_id: nil) -> ::Google::Cloud::Retail::V2::ServingConfig
Pass arguments to remove_control 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 (::String) — Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
  • control_id (::String) — Required. The id of the control to apply. Assumed to be in the same catalog as the serving config.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/retail/v2"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Retail::V2::RemoveControlRequest.new

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

# The returned object is of type Google::Cloud::Retail::V2::ServingConfig.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_serving_config

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

Updates a ServingConfig.

Overloads 
def update_serving_config(request, options = nil) -> ::Google::Cloud::Retail::V2::ServingConfig
Pass arguments to update_serving_config via a request object, either of type UpdateServingConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::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::Retail::V2::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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/retail/v2"

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

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

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

# The returned object is of type Google::Cloud::Retail::V2::ServingConfig.
p result