Class: Google::Cloud::DiscoveryEngine::V1::ControlService::Rest::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb

Overview

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 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.

Examples:


# Modify the global config, setting the timeout for
# create_control to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::DiscoveryEngine::V1::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::DiscoveryEngine::V1::ControlService::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.create_control.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#credentials ⇒ ::Object

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)
  • (Signet::OAuth2::Client) A signet oauth2 client object (see the signet docs)
  • (nil) indicating no credentials

Returns:

  • (::Object) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

#endpoint ⇒ ::String?

A custom service endpoint, as a hostname or hostname:port. The default is nil, indicating to use the default endpoint in the current universe domain.

Returns:

  • (::String, nil) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

#metadata ⇒ ::Hash{::Symbol=>::String}

Additional headers to be sent with the call.

Returns:

  • (::Hash{::Symbol=>::String}) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

#retry_policy ⇒ ::Hash

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<String>) - The error codes that should trigger a retry.

Returns:

  • (::Hash) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

#universe_domain ⇒ ::String?

The universe domain within which to make requests. This determines the default endpoint URL. The default value of nil uses the environment universe (usually the default "googleapis.com" universe).

Returns:

  • (::String, nil) 


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 707

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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<String>`) - 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

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



739
740
741
742
743
744
745
 
# File 'lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb', line 739

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