Class: Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb

Overview

Configuration class for the CloudTasks REST API.

This class represents the configuration for CloudTasks 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
# list_queues to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.list_queues.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Tasks::V2beta3::CloudTasks::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.list_queues.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) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_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) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_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}) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_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) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_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) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1900

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "cloudtasks.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
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, 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 CloudTasks 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 `list_queues`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_queues
    ##
    # RPC-specific configuration for `get_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_queue
    ##
    # RPC-specific configuration for `create_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_queue
    ##
    # RPC-specific configuration for `update_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_queue
    ##
    # RPC-specific configuration for `delete_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_queue
    ##
    # RPC-specific configuration for `purge_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_queue
    ##
    # RPC-specific configuration for `pause_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pause_queue
    ##
    # RPC-specific configuration for `resume_queue`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :resume_queue
    ##
    # RPC-specific configuration for `get_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_iam_policy
    ##
    # RPC-specific configuration for `set_iam_policy`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_iam_policy
    ##
    # RPC-specific configuration for `test_iam_permissions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :test_iam_permissions
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `delete_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_task
    ##
    # RPC-specific configuration for `run_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :run_task

    # @private
    def initialize parent_rpcs = nil
      list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
      @list_queues = ::Gapic::Config::Method.new list_queues_config
      get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
      @get_queue = ::Gapic::Config::Method.new get_queue_config
      create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
      @create_queue = ::Gapic::Config::Method.new create_queue_config
      update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
      @update_queue = ::Gapic::Config::Method.new update_queue_config
      delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
      @delete_queue = ::Gapic::Config::Method.new delete_queue_config
      purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
      @purge_queue = ::Gapic::Config::Method.new purge_queue_config
      pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
      @pause_queue = ::Gapic::Config::Method.new pause_queue_config
      resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
      @resume_queue = ::Gapic::Config::Method.new resume_queue_config
      get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
      @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
      set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
      @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
      test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
      @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
      @delete_task = ::Gapic::Config::Method.new delete_task_config
      run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
      @run_task = ::Gapic::Config::Method.new run_task_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1939
1940
1941
1942
1943
1944
1945
 
# File 'lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb', line 1939

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