# frozen_string_literal: true # Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/retail/v2/control_service_pb" require "google/cloud/retail/v2/control_service/rest/service_stub" require "google/cloud/location/rest" module Google module Cloud module Retail module V2 module ControlService module Rest ## # REST client for the ControlService service. # # Service for modifying Control. # class Client include Paths # @private attr_reader :control_service_stub ## # Configure the ControlService Client class. # # See {::Google::Cloud::Retail::V2::ControlService::Rest::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all ControlService clients # ::Google::Cloud::Retail::V2::ControlService::Rest::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # 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 end yield @configure if block_given? @configure end ## # 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 {::Google::Cloud::Retail::V2::ControlService::Rest::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new ControlService REST client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::Retail::V2::ControlService::Rest::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::Retail::V2::ControlService::Rest::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the ControlService client. # @yieldparam config [Client::Configuration] # def initialize # 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 == Configuration::DEFAULT_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 @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @control_service_stub = ::Google::Cloud::Retail::V2::ControlService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Rest::Client] # attr_reader :location_client # Service calls ## # Creates a Control. # # If the {::Google::Cloud::Retail::V2::Control Control} to create already exists, # an ALREADY_EXISTS error is returned. # # @overload create_control(request, options = nil) # Pass arguments to `create_control` via a request object, either of type # {::Google::Cloud::Retail::V2::CreateControlRequest} or an equivalent Hash. # # @param 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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload create_control(parent: nil, control: nil, control_id: nil) # 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). # # @param parent [::String] # Required. Full resource name of parent catalog. Format: # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}` # @param control [::Google::Cloud::Retail::V2::Control, ::Hash] # Required. The Control to create. # @param 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]-_/. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::Retail::V2::Control] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Retail::V2::Control] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def create_control request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::CreateControlRequest # 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 call_metadata = @config.rpcs.create_control.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.create_control.timeout, metadata: call_metadata, retry_policy: @config.rpcs.create_control.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @control_service_stub.create_control request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes a Control. # # If the {::Google::Cloud::Retail::V2::Control Control} to delete does not exist, # a NOT_FOUND error is returned. # # @overload delete_control(request, options = nil) # Pass arguments to `delete_control` via a request object, either of type # {::Google::Cloud::Retail::V2::DeleteControlRequest} or an equivalent Hash. # # @param 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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload delete_control(name: nil) # 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). # # @param name [::String] # Required. The resource name of the Control to delete. Format: # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Protobuf::Empty] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Protobuf::Empty] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def delete_control request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::DeleteControlRequest # 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 call_metadata = @config.rpcs.delete_control.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.delete_control.timeout, metadata: call_metadata, retry_policy: @config.rpcs.delete_control.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @control_service_stub.delete_control request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates a Control. # # {::Google::Cloud::Retail::V2::Control Control} cannot be set to a different # oneof field, if so an INVALID_ARGUMENT is returned. If the # {::Google::Cloud::Retail::V2::Control Control} to update does not exist, a # NOT_FOUND error is returned. # # @overload update_control(request, options = nil) # Pass arguments to `update_control` via a request object, either of type # {::Google::Cloud::Retail::V2::UpdateControlRequest} or an equivalent Hash. # # @param 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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload update_control(control: nil, update_mask: nil) # 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). # # @param control [::Google::Cloud::Retail::V2::Control, ::Hash] # Required. The Control to update. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Indicates which fields in the provided # {::Google::Cloud::Retail::V2::Control Control} to update. The following are NOT # supported: # # * {::Google::Cloud::Retail::V2::Control#name Control.name} # # If not set or empty, all supported fields are updated. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::Retail::V2::Control] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Retail::V2::Control] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def update_control request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::UpdateControlRequest # 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 call_metadata = @config.rpcs.update_control.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.update_control.timeout, metadata: call_metadata, retry_policy: @config.rpcs.update_control.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @control_service_stub.update_control request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets a Control. # # @overload get_control(request, options = nil) # Pass arguments to `get_control` via a request object, either of type # {::Google::Cloud::Retail::V2::GetControlRequest} or an equivalent Hash. # # @param 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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload get_control(name: nil) # 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). # # @param name [::String] # Required. The resource name of the Control to get. Format: # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::Retail::V2::Control] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Retail::V2::Control] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def get_control request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::GetControlRequest # 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 call_metadata = @config.rpcs.get_control.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_control.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_control.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @control_service_stub.get_control request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists all Controls by their parent # {::Google::Cloud::Retail::V2::Catalog Catalog}. # # @overload list_controls(request, options = nil) # Pass arguments to `list_controls` via a request object, either of type # {::Google::Cloud::Retail::V2::ListControlsRequest} or an equivalent Hash. # # @param 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. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # # @overload list_controls(parent: nil, page_size: nil, page_token: nil, filter: nil) # 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). # # @param parent [::String] # Required. The catalog resource name. Format: # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}` # @param page_size [::Integer] # Optional. Maximum number of results to return. If unspecified, defaults # to 50. Max allowed value is 1000. # @param page_token [::String] # Optional. A page token, received from a previous `ListControls` call. # Provide this to retrieve the subsequent page. # @param filter [::String] # Optional. A filter to apply on the list results. Supported features: # # * List all the products under the parent branch if # {::Google::Cloud::Retail::V2::ListControlsRequest#filter filter} is unset. # * List controls that are used in a single ServingConfig: # 'serving_config = "boosted_home_page_cvr"' # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Retail::V2::Control>] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Retail::V2::Control>] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_controls request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::ListControlsRequest # 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 call_metadata = @config.rpcs.list_controls.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_controls.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_controls.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @control_service_stub.list_controls request, options do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @control_service_stub, :list_controls, "controls", request, result, options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the ControlService REST API. # # This class represents the configuration for ControlService REST, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::Retail::V2::ControlService::Rest::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # create_control to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::Retail::V2::ControlService::Rest::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.create_control.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::Retail::V2::ControlService::Rest::Client.new do |config| # config.timeout = 10.0 # config.rpcs.create_control.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"retail.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "retail.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the ControlService API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `create_control` # @return [::Gapic::Config::Method] # attr_reader :create_control ## # RPC-specific configuration for `delete_control` # @return [::Gapic::Config::Method] # attr_reader :delete_control ## # RPC-specific configuration for `update_control` # @return [::Gapic::Config::Method] # attr_reader :update_control ## # RPC-specific configuration for `get_control` # @return [::Gapic::Config::Method] # attr_reader :get_control ## # RPC-specific configuration for `list_controls` # @return [::Gapic::Config::Method] # attr_reader :list_controls # @private def initialize parent_rpcs = nil create_control_config = parent_rpcs.create_control if parent_rpcs.respond_to? :create_control @create_control = ::Gapic::Config::Method.new create_control_config delete_control_config = parent_rpcs.delete_control if parent_rpcs.respond_to? :delete_control @delete_control = ::Gapic::Config::Method.new delete_control_config update_control_config = parent_rpcs.update_control if parent_rpcs.respond_to? :update_control @update_control = ::Gapic::Config::Method.new update_control_config get_control_config = parent_rpcs.get_control if parent_rpcs.respond_to? :get_control @get_control = ::Gapic::Config::Method.new get_control_config list_controls_config = parent_rpcs.list_controls if parent_rpcs.respond_to? :list_controls @list_controls = ::Gapic::Config::Method.new list_controls_config yield self if block_given? end end end end end end end end end end