Retail V2 API - Class Google::Cloud::Retail::V2::ControlService::Client (v0.11.0)

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

Client for the ControlService service.

Service for modifying Control.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the ControlService 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 ControlService clients
::Google::Cloud::Retail::V2::ControlService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the ControlService 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_control

def create_control(request, options = nil) -> ::Google::Cloud::Retail::V2::Control
def create_control(parent: nil, control: nil, control_id: nil) -> ::Google::Cloud::Retail::V2::Control

Creates a Control.

If the Control to create already exists, an ALREADY_EXISTS error is returned.

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

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

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

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

#delete_control

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

Deletes a Control.

If the Control to delete does not exist, a NOT_FOUND error is returned.

Overloads 
def delete_control(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_control via a request object, either of type DeleteControlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::DeleteControlRequest, ::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_control(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_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).
Parameter
  • name (::String) — Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_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::ControlService::Client.new

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

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

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

#get_control

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

Gets a Control.

Overloads 
def get_control(request, options = nil) -> ::Google::Cloud::Retail::V2::Control
Pass arguments to get_control via a request object, either of type GetControlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::GetControlRequest, ::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_control(name: nil) -> ::Google::Cloud::Retail::V2::Control
Pass arguments to get_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).
Parameter
  • name (::String) — Required. The resource name of the Control to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_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::ControlService::Client.new

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

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

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

#initialize

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

Create a new ControlService client object.

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

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

#list_controls

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

Lists all Controls by their parent Catalog.

Overloads 
def list_controls(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Retail::V2::Control>
Pass arguments to list_controls via a request object, either of type ListControlsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::ListControlsRequest, ::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_controls(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Retail::V2::Control>
Pass arguments to list_controls 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 50. Max allowed value is 1000.
  • page_token (::String) — Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.
  • filter (::String) —

    Optional. A filter to apply on the list results. Supported features:

    • List all the products under the parent branch if filter is unset.
    • List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
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::ControlService::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Retail::V2::Control.
  p response
end

#update_control

def update_control(request, options = nil) -> ::Google::Cloud::Retail::V2::Control
def update_control(control: nil, update_mask: nil) -> ::Google::Cloud::Retail::V2::Control

Updates a Control.

Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.

Overloads 
def update_control(request, options = nil) -> ::Google::Cloud::Retail::V2::Control
Pass arguments to update_control via a request object, either of type UpdateControlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Retail::V2::UpdateControlRequest, ::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_control(control: nil, update_mask: nil) -> ::Google::Cloud::Retail::V2::Control
Pass arguments to update_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
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::ControlService::Client.new

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

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

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