class Google::Cloud::Retail::V2::CatalogService::Client

Client for the CatalogService service.

Service for managing catalog configuration.

Attributes

catalog_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the CatalogService Client class.

See {::Google::Cloud::Retail::V2::CatalogService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all CatalogService clients
::Google::Cloud::Retail::V2::CatalogService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/retail/v2/catalog_service/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Retail", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 5.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 5.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new CatalogService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Retail::V2::CatalogService::Client.new

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

@yield [config] Configure the CatalogService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/retail/v2/catalog_service/client.rb, line 114
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/retail/v2/catalog_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @catalog_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Retail::V2::CatalogService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the CatalogService 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 {::Google::Cloud::Retail::V2::CatalogService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/retail/v2/catalog_service/client.rb, line 93
def configure
  yield @config if block_given?
  @config
end
get_default_branch(request, options = nil) { |response, operation| ... } click to toggle source

Get which branch is currently default branch set by {::Google::Cloud::Retail::V2::CatalogService::Client#set_default_branch CatalogService.SetDefaultBranch} method under a specified parent catalog.

This feature is only available for users who have Retail Search enabled. Please submit a form [here](cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.

@overload get_default_branch(request, options = nil)

Pass arguments to `get_default_branch` via a request object, either of type
{::Google::Cloud::Retail::V2::GetDefaultBranchRequest} or an equivalent Hash.

@param request [::Google::Cloud::Retail::V2::GetDefaultBranchRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_default_branch(catalog: nil)

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

@param catalog [::String]
  The parent catalog resource name, such as
  `projects/*/locations/global/catalogs/default_catalog`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Retail::V2::GetDefaultBranchResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Retail::V2::GetDefaultBranchResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/retail/v2/catalog_service/client.rb, line 478
def get_default_branch request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::GetDefaultBranchRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_default_branch.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Retail::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "catalog" => request.catalog
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_default_branch.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_default_branch.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @catalog_service_stub.call_rpc :get_default_branch, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_catalogs(request, options = nil) { |response, operation| ... } click to toggle source

Lists all the {::Google::Cloud::Retail::V2::Catalog Catalog}s associated with the project.

@overload list_catalogs(request, options = nil)

Pass arguments to `list_catalogs` via a request object, either of type
{::Google::Cloud::Retail::V2::ListCatalogsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Retail::V2::ListCatalogsRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_catalogs(parent: nil, page_size: nil, page_token: nil)

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

@param parent [::String]
  Required. The account resource name with an associated location.

  If the caller does not have permission to list
  {::Google::Cloud::Retail::V2::Catalog Catalog}s under this location, regardless
  of whether or not this location exists, a PERMISSION_DENIED error is
  returned.
@param page_size [::Integer]
  Maximum number of {::Google::Cloud::Retail::V2::Catalog Catalog}s to return. If
  unspecified, defaults to 50. The maximum allowed value is 1000. Values
  above 1000 will be coerced to 1000.

  If this field is negative, an INVALID_ARGUMENT is returned.
@param page_token [::String]
  A page token
  {::Google::Cloud::Retail::V2::ListCatalogsResponse#next_page_token ListCatalogsResponse.next_page_token},
  received from a previous
  {::Google::Cloud::Retail::V2::CatalogService::Client#list_catalogs CatalogService.ListCatalogs}
  call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to
  {::Google::Cloud::Retail::V2::CatalogService::Client#list_catalogs CatalogService.ListCatalogs}
  must match the call that provided the page token. Otherwise, an
  INVALID_ARGUMENT error is returned.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Retail::V2::Catalog>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Retail::V2::Catalog>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/retail/v2/catalog_service/client.rb, line 204
def list_catalogs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::ListCatalogsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_catalogs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Retail::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_catalogs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_catalogs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @catalog_service_stub.call_rpc :list_catalogs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_catalogs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
set_default_branch(request, options = nil) { |response, operation| ... } click to toggle source

Set a specified branch id as default branch. API methods such as {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}, {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}, {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts} will treat requests using “default_branch” to the actual branch id set as default.

For example, if `projects//locations//catalogs/*/branches/1` is set as default, setting {::Google::Cloud::Retail::V2::SearchRequest#branch SearchRequest.branch} to `projects//locations//catalogs/*/branches/default_branch` is equivalent to setting {::Google::Cloud::Retail::V2::SearchRequest#branch SearchRequest.branch} to `projects//locations//catalogs/*/branches/1`.

Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using `projects//locations//catalogs/*/branches/default_branch` as {::Google::Cloud::Retail::V2::SearchRequest#branch SearchRequest.branch} to route the traffic to this staging branch.

CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.

More specifically:

  • PredictionService will only return product IDs from branch \{newBranch}.

  • SearchService will only return product IDs from branch \{newBranch} (if branch is not explicitly set).

  • UserEventService will only join events with products from branch \{newBranch}.

This feature is only available for users who have Retail Search enabled. Please submit a form [here](cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.

@overload set_default_branch(request, options = nil)

Pass arguments to `set_default_branch` via a request object, either of type
{::Google::Cloud::Retail::V2::SetDefaultBranchRequest} or an equivalent Hash.

@param request [::Google::Cloud::Retail::V2::SetDefaultBranchRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload set_default_branch(catalog: nil, branch_id: nil, note: nil)

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

@param catalog [::String]
  Full resource name of the catalog, such as
  `projects/*/locations/global/catalogs/default_catalog`.
@param branch_id [::String]
  The final component of the resource name of a branch.

  This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
  error is returned.
@param note [::String]
  Some note on this request, this can be retrieved by
  {::Google::Cloud::Retail::V2::CatalogService::Client#get_default_branch CatalogService.GetDefaultBranch}
  before next valid default branch set occurs.

  This field must be a UTF-8 encoded string with a length limit of 1,000
  characters. Otherwise, an INVALID_ARGUMENT error is returned.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Protobuf::Empty]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/retail/v2/catalog_service/client.rb, line 403
def set_default_branch request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::SetDefaultBranchRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_default_branch.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Retail::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "catalog" => request.catalog
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_default_branch.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_default_branch.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @catalog_service_stub.call_rpc :set_default_branch, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
update_catalog(request, options = nil) { |response, operation| ... } click to toggle source

Updates the {::Google::Cloud::Retail::V2::Catalog Catalog}s.

@overload update_catalog(request, options = nil)

Pass arguments to `update_catalog` via a request object, either of type
{::Google::Cloud::Retail::V2::UpdateCatalogRequest} or an equivalent Hash.

@param request [::Google::Cloud::Retail::V2::UpdateCatalogRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload update_catalog(catalog: nil, update_mask: nil)

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

@param catalog [::Google::Cloud::Retail::V2::Catalog, ::Hash]
  Required. The {::Google::Cloud::Retail::V2::Catalog Catalog} to update.

  If the caller does not have permission to update the
  {::Google::Cloud::Retail::V2::Catalog Catalog}, regardless of whether or not it
  exists, a PERMISSION_DENIED error is returned.

  If the {::Google::Cloud::Retail::V2::Catalog Catalog} to update does not exist,
  a NOT_FOUND error is returned.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Indicates which fields in the provided
  {::Google::Cloud::Retail::V2::Catalog Catalog} to update.

  If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
  is returned.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Retail::V2::Catalog] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Retail::V2::Catalog]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/retail/v2/catalog_service/client.rb, line 286
def update_catalog request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::UpdateCatalogRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_catalog.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Retail::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "catalog.name" => request.catalog.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_catalog.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_catalog.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @catalog_service_stub.call_rpc :update_catalog, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end