class Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client
Client
for the CatalogService
service.
Service
for ingesting catalog information of the customer's website.
Attributes
@private
Get the associated client for long-running operations.
@return [::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Operations]
Public Class Methods
Configure the CatalogService
Client
class.
See {::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all CatalogService clients ::Google::Cloud::RecommendationEngine::V1beta1::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/recommendation_engine/v1beta1/catalog_service/client.rb, line 56 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "RecommendationEngine", "V1beta1"] 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.rpcs.create_catalog_item.timeout = 600.0 default_config.rpcs.create_catalog_item.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.get_catalog_item.timeout = 600.0 default_config.rpcs.get_catalog_item.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.list_catalog_items.timeout = 600.0 default_config.rpcs.list_catalog_items.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.update_catalog_item.timeout = 600.0 default_config.rpcs.update_catalog_item.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.delete_catalog_item.timeout = 600.0 default_config.rpcs.delete_catalog_item.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.import_catalog_items.timeout = 600.0 default_config.rpcs.import_catalog_items.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config end yield @configure if block_given? @configure end
Create a new CatalogService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the CatalogService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb, line 139 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/recommendationengine/v1beta1/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 @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @catalog_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
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::RecommendationEngine::V1beta1::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/recommendation_engine/v1beta1/catalog_service/client.rb, line 118 def configure yield @config if block_given? @config end
Creates a catalog item.
@overload create_catalog_item
(request, options = nil)
Pass arguments to `create_catalog_item` via a request object, either of type {::Google::Cloud::RecommendationEngine::V1beta1::CreateCatalogItemRequest} or an equivalent Hash. @param request [::Google::Cloud::RecommendationEngine::V1beta1::CreateCatalogItemRequest, ::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 create_catalog_item
(parent: nil, catalog_item: nil)
Pass arguments to `create_catalog_item` 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 parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`. @param catalog_item [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem, ::Hash] Required. The catalog item to create.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb, line 221 def create_catalog_item request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::CreateCatalogItemRequest # 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.create_catalog_item.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::RecommendationEngine::V1beta1::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.create_catalog_item.timeout, metadata: metadata, retry_policy: @config.rpcs.create_catalog_item.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @catalog_service_stub.call_rpc :create_catalog_item, 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
Deletes a catalog item.
@overload delete_catalog_item
(request, options = nil)
Pass arguments to `delete_catalog_item` via a request object, either of type {::Google::Cloud::RecommendationEngine::V1beta1::DeleteCatalogItemRequest} or an equivalent Hash. @param request [::Google::Cloud::RecommendationEngine::V1beta1::DeleteCatalogItemRequest, ::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 delete_catalog_item
(name: nil)
Pass arguments to `delete_catalog_item` 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 name [::String] Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
@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/recommendation_engine/v1beta1/catalog_service/client.rb, line 512 def delete_catalog_item request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::DeleteCatalogItemRequest # 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.delete_catalog_item.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::RecommendationEngine::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.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.delete_catalog_item.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_catalog_item.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @catalog_service_stub.call_rpc :delete_catalog_item, 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
Gets a specific catalog item.
@overload get_catalog_item
(request, options = nil)
Pass arguments to `get_catalog_item` via a request object, either of type {::Google::Cloud::RecommendationEngine::V1beta1::GetCatalogItemRequest} or an equivalent Hash. @param request [::Google::Cloud::RecommendationEngine::V1beta1::GetCatalogItemRequest, ::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_catalog_item
(name: nil)
Pass arguments to `get_catalog_item` 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 name [::String] Required. Full resource name of catalog item, such as `projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb, line 290 def get_catalog_item request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::GetCatalogItemRequest # 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_catalog_item.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::RecommendationEngine::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.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.get_catalog_item.timeout, metadata: metadata, retry_policy: @config.rpcs.get_catalog_item.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @catalog_service_stub.call_rpc :get_catalog_item, 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
Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.
Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.
@overload import_catalog_items
(request, options = nil)
Pass arguments to `import_catalog_items` via a request object, either of type {::Google::Cloud::RecommendationEngine::V1beta1::ImportCatalogItemsRequest} or an equivalent Hash. @param request [::Google::Cloud::RecommendationEngine::V1beta1::ImportCatalogItemsRequest, ::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 import_catalog_items
(parent: nil, request_id: nil, input_config: nil, errors_config: nil)
Pass arguments to `import_catalog_items` 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. `projects/1234/locations/global/catalogs/default_catalog` @param request_id [::String] Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. @param input_config [::Google::Cloud::RecommendationEngine::V1beta1::InputConfig, ::Hash] Required. The desired input location of the data. @param errors_config [::Google::Cloud::RecommendationEngine::V1beta1::ImportErrorsConfig, ::Hash] Optional. The desired location of errors incurred during the Import.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb, line 594 def import_catalog_items request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::ImportCatalogItemsRequest # 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.import_catalog_items.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::RecommendationEngine::V1beta1::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.import_catalog_items.timeout, metadata: metadata, retry_policy: @config.rpcs.import_catalog_items.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @catalog_service_stub.call_rpc :import_catalog_items, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets a list of catalog items.
@overload list_catalog_items
(request, options = nil)
Pass arguments to `list_catalog_items` via a request object, either of type {::Google::Cloud::RecommendationEngine::V1beta1::ListCatalogItemsRequest} or an equivalent Hash. @param request [::Google::Cloud::RecommendationEngine::V1beta1::ListCatalogItemsRequest, ::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_catalog_items
(parent: nil, page_size: nil, page_token: nil, filter: nil)
Pass arguments to `list_catalog_items` 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 parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`. @param page_size [::Integer] Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default. @param page_token [::String] Optional. The previous ListCatalogItemsResponse.next_page_token. @param filter [::String] Optional. A filter to apply on the list results.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb, line 366 def list_catalog_items request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::ListCatalogItemsRequest # 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_catalog_items.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::RecommendationEngine::V1beta1::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_catalog_items.timeout, metadata: metadata, retry_policy: @config.rpcs.list_catalog_items.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @catalog_service_stub.call_rpc :list_catalog_items, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_catalog_items, 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
Updates a catalog item. Partial updating is supported. Non-existing items will be created.
@overload update_catalog_item
(request, options = nil)
Pass arguments to `update_catalog_item` via a request object, either of type {::Google::Cloud::RecommendationEngine::V1beta1::UpdateCatalogItemRequest} or an equivalent Hash. @param request [::Google::Cloud::RecommendationEngine::V1beta1::UpdateCatalogItemRequest, ::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_item
(name: nil, catalog_item: nil, update_mask: nil)
Pass arguments to `update_catalog_item` 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 name [::String] Required. Full resource name of catalog item, such as "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id". @param catalog_item [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem, ::Hash] Required. The catalog item to update/create. The 'catalog_item_id' field has to match that in the 'name'. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb, line 443 def update_catalog_item request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::UpdateCatalogItemRequest # 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_item.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::RecommendationEngine::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.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_item.timeout, metadata: metadata, retry_policy: @config.rpcs.update_catalog_item.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @catalog_service_stub.call_rpc :update_catalog_item, 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