Class: Google::Cloud::PubSub::V1::Subscriber::Client::Configuration

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

Overview

Configuration class for the Subscriber API.

This class represents the configuration for Subscriber, 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_subscription to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::PubSub::V1::Subscriber::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.create_subscription.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::PubSub::V1::Subscriber::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.create_subscription.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#channel_args ⇒ ::Hash

Extra parameters passed to the gRPC channel. Note: this is ignored if a GRPC::Core::Channel object is provided as the credential.

Returns:

  • (::Hash) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_config

      yield self if block_given?
    end
  end
end

#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)
  • (GRPC::Core::Channel) a gRPC channel with included credentials
  • (GRPC::Core::ChannelCredentials) a gRPC credentails object
  • (nil) indicating no credentials

Returns:

  • (::Object) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_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) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_config

      yield self if block_given?
    end
  end
end

#interceptors ⇒ ::Array<::GRPC::ClientInterceptor>

An array of interceptors that are run before calls are executed.

Returns:

  • (::Array<::GRPC::ClientInterceptor>) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_config

      yield self if block_given?
    end
  end
end

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

Additional gRPC headers to be sent with the call.

Returns:

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


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_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) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_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) 


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
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2012

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "pubsub.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the Subscriber 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 gRPC 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_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_subscription
    ##
    # RPC-specific configuration for `get_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_subscription
    ##
    # RPC-specific configuration for `update_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_subscription
    ##
    # RPC-specific configuration for `list_subscriptions`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_subscriptions
    ##
    # RPC-specific configuration for `delete_subscription`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_subscription
    ##
    # RPC-specific configuration for `modify_ack_deadline`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_ack_deadline
    ##
    # RPC-specific configuration for `acknowledge`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :acknowledge
    ##
    # RPC-specific configuration for `pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :pull
    ##
    # RPC-specific configuration for `streaming_pull`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :streaming_pull
    ##
    # RPC-specific configuration for `modify_push_config`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :modify_push_config
    ##
    # RPC-specific configuration for `get_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_snapshot
    ##
    # RPC-specific configuration for `list_snapshots`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_snapshots
    ##
    # RPC-specific configuration for `create_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_snapshot
    ##
    # RPC-specific configuration for `update_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_snapshot
    ##
    # RPC-specific configuration for `delete_snapshot`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_snapshot
    ##
    # RPC-specific configuration for `seek`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :seek

    # @private
    def initialize parent_rpcs = nil
      create_subscription_config = parent_rpcs.create_subscription if parent_rpcs.respond_to? :create_subscription
      @create_subscription = ::Gapic::Config::Method.new create_subscription_config
      get_subscription_config = parent_rpcs.get_subscription if parent_rpcs.respond_to? :get_subscription
      @get_subscription = ::Gapic::Config::Method.new get_subscription_config
      update_subscription_config = parent_rpcs.update_subscription if parent_rpcs.respond_to? :update_subscription
      @update_subscription = ::Gapic::Config::Method.new update_subscription_config
      list_subscriptions_config = parent_rpcs.list_subscriptions if parent_rpcs.respond_to? :list_subscriptions
      @list_subscriptions = ::Gapic::Config::Method.new list_subscriptions_config
      delete_subscription_config = parent_rpcs.delete_subscription if parent_rpcs.respond_to? :delete_subscription
      @delete_subscription = ::Gapic::Config::Method.new delete_subscription_config
      modify_ack_deadline_config = parent_rpcs.modify_ack_deadline if parent_rpcs.respond_to? :modify_ack_deadline
      @modify_ack_deadline = ::Gapic::Config::Method.new modify_ack_deadline_config
      acknowledge_config = parent_rpcs.acknowledge if parent_rpcs.respond_to? :acknowledge
      @acknowledge = ::Gapic::Config::Method.new acknowledge_config
      pull_config = parent_rpcs.pull if parent_rpcs.respond_to? :pull
      @pull = ::Gapic::Config::Method.new pull_config
      streaming_pull_config = parent_rpcs.streaming_pull if parent_rpcs.respond_to? :streaming_pull
      @streaming_pull = ::Gapic::Config::Method.new streaming_pull_config
      modify_push_config_config = parent_rpcs.modify_push_config if parent_rpcs.respond_to? :modify_push_config
      @modify_push_config = ::Gapic::Config::Method.new modify_push_config_config
      get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
      @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
      list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
      @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
      create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
      @create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
      update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
      @update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
      delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
      @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
      seek_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
      @seek = ::Gapic::Config::Method.new seek_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#channel_pool ⇒ ::Gapic::ServiceStub::ChannelPool::Configuration

Configuration for the channel pool

Returns:

  • (::Gapic::ServiceStub::ChannelPool::Configuration) 


2059
2060
2061
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2059

def channel_pool
  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
end

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2047
2048
2049
2050
2051
2052
2053
 
# File 'lib/google/cloud/pubsub/v1/subscriber/client.rb', line 2047

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