google-cloud-pubsub-v1 0.1.2 → 0.6.1

data/lib/google/cloud/pubsub/v1/subscriber/client.rb

@@ -43,13 +43,12 @@ module Google
             # See {::Google::Cloud::PubSub::V1::Subscriber::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all Subscriber clients:
-            #
-            #     ::Google::Cloud::PubSub::V1::Subscriber::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all Subscriber clients
+            #   ::Google::Cloud::PubSub::V1::Subscriber::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -62,137 +61,89 @@ module Google
                 parent_config = while namespace.any?
                                   parent_name = namespace.join "::"
                                   parent_const = const_get parent_name
-                                  break parent_const.configure if parent_const&.respond_to? :configure
+                                  break parent_const.configure if parent_const.respond_to? :configure
                                   namespace.pop
                                 end
                 default_config = Client::Configuration.new parent_config
 
                 default_config.rpcs.create_subscription.timeout = 60.0
                 default_config.rpcs.create_subscription.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [2, 10, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
                 }
 
                 default_config.rpcs.get_subscription.timeout = 60.0
                 default_config.rpcs.get_subscription.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [2, 10, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
                 }
 
                 default_config.rpcs.update_subscription.timeout = 60.0
                 default_config.rpcs.update_subscription.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.list_subscriptions.timeout = 60.0
                 default_config.rpcs.list_subscriptions.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [2, 10, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
                 }
 
                 default_config.rpcs.delete_subscription.timeout = 60.0
                 default_config.rpcs.delete_subscription.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.modify_ack_deadline.timeout = 60.0
                 default_config.rpcs.modify_ack_deadline.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.acknowledge.timeout = 60.0
                 default_config.rpcs.acknowledge.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.pull.timeout = 60.0
                 default_config.rpcs.pull.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [2, 10, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
                 }
 
                 default_config.rpcs.streaming_pull.timeout = 900.0
                 default_config.rpcs.streaming_pull.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [4, 8, 10, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 8, 10, 13, 14]
                 }
 
                 default_config.rpcs.modify_push_config.timeout = 60.0
                 default_config.rpcs.modify_push_config.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.get_snapshot.timeout = 60.0
                 default_config.rpcs.get_snapshot.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [2, 10, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
                 }
 
                 default_config.rpcs.list_snapshots.timeout = 60.0
                 default_config.rpcs.list_snapshots.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [2, 10, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
                 }
 
                 default_config.rpcs.create_snapshot.timeout = 60.0
                 default_config.rpcs.create_snapshot.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.update_snapshot.timeout = 60.0
                 default_config.rpcs.update_snapshot.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.delete_snapshot.timeout = 60.0
                 default_config.rpcs.delete_snapshot.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.seek.timeout = 60.0
                 default_config.rpcs.seek.retry_policy = {
-                  initial_delay: 0.1,
-                  max_delay:     60.0,
-                  multiplier:    1.3,
-                  retry_codes:   [2, 10, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
                 }
 
                 default_config
@@ -224,19 +175,15 @@ module Google
             ##
             # Create a new Subscriber client object.
             #
-            # ## Examples
-            #
-            # To create a new Subscriber client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::PubSub::V1::Subscriber::Client.new
+            # @example
             #
-            # To create a new Subscriber client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::PubSub::V1::Subscriber::Client.new
             #
-            #     client = ::Google::Cloud::PubSub::V1::Subscriber::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::PubSub::V1::Subscriber::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Subscriber client.
             # @yieldparam config [Client::Configuration]
@@ -256,8 +203,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              credentials ||= Credentials.default scope: @config.scope
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              # Use self-signed JWT if the endpoint is unchanged from default,
+              # but only if the default endpoint does not have a region prefix.
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
+                                       !@config.endpoint.split(".").first.include?("-")
+              credentials ||= Credentials.default scope: @config.scope,
+                                                  enable_self_signed_jwt: enable_self_signed_jwt
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -342,8 +294,9 @@ module Google
             #     Indicates whether to retain acknowledged messages. If true, then
             #     messages are not expunged from the subscription's backlog, even if they are
             #     acknowledged, until they fall out of the `message_retention_duration`
-            #     window. This must be true if you would like to [Seek to a timestamp]
-            #     (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time).
+            #     window. This must be true if you would like to [`Seek` to a timestamp]
+            #     (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
+            #     the past to replay previously-acknowledged messages.
             #   @param message_retention_duration [::Google::Protobuf::Duration, ::Hash]
             #     How long to retain unacknowledged messages in the subscription's backlog,
             #     from the moment a message is published.
@@ -404,6 +357,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::Subscription.new
+            #
+            #   # Call the create_subscription method.
+            #   result = client.create_subscription request
+            #
+            #   # The returned object is of type Google::Cloud::PubSub::V1::Subscription.
+            #   p result
+            #
             def create_subscription request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -421,16 +389,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.create_subscription.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_subscription.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :create_subscription, request, options: options do |response, operation|
@@ -471,6 +443,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::GetSubscriptionRequest.new
+            #
+            #   # Call the get_subscription method.
+            #   result = client.get_subscription request
+            #
+            #   # The returned object is of type Google::Cloud::PubSub::V1::Subscription.
+            #   p result
+            #
             def get_subscription request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -488,16 +475,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "subscription" => request.subscription
-              }
+              header_params = {}
+              if request.subscription
+                header_params["subscription"] = request.subscription
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.get_subscription.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_subscription.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :get_subscription, request, options: options do |response, operation|
@@ -541,6 +532,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::UpdateSubscriptionRequest.new
+            #
+            #   # Call the update_subscription method.
+            #   result = client.update_subscription request
+            #
+            #   # The returned object is of type Google::Cloud::PubSub::V1::Subscription.
+            #   p result
+            #
             def update_subscription request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -558,16 +564,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "subscription.name" => request.subscription.name
-              }
+              header_params = {}
+              if request.subscription&.name
+                header_params["subscription.name"] = request.subscription.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.update_subscription.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_subscription.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :update_subscription, request, options: options do |response, operation|
@@ -614,6 +624,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::ListSubscriptionsRequest.new
+            #
+            #   # Call the list_subscriptions method.
+            #   result = client.list_subscriptions request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::PubSub::V1::Subscription.
+            #     p response
+            #   end
+            #
             def list_subscriptions request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -631,16 +662,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "project" => request.project
-              }
+              header_params = {}
+              if request.project
+                header_params["project"] = request.project
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.list_subscriptions.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_subscriptions.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :list_subscriptions, request, options: options do |response, operation|
@@ -686,6 +721,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::DeleteSubscriptionRequest.new
+            #
+            #   # Call the delete_subscription method.
+            #   result = client.delete_subscription request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_subscription request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -703,16 +753,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "subscription" => request.subscription
-              }
+              header_params = {}
+              if request.subscription
+                header_params["subscription"] = request.subscription
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.delete_subscription.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_subscription.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :delete_subscription, request, options: options do |response, operation|
@@ -768,6 +822,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::ModifyAckDeadlineRequest.new
+            #
+            #   # Call the modify_ack_deadline method.
+            #   result = client.modify_ack_deadline request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def modify_ack_deadline request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -785,16 +854,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "subscription" => request.subscription
-              }
+              header_params = {}
+              if request.subscription
+                header_params["subscription"] = request.subscription
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.modify_ack_deadline.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.modify_ack_deadline.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :modify_ack_deadline, request, options: options do |response, operation|
@@ -845,6 +918,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::AcknowledgeRequest.new
+            #
+            #   # Call the acknowledge method.
+            #   result = client.acknowledge request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def acknowledge request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -862,16 +950,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "subscription" => request.subscription
-              }
+              header_params = {}
+              if request.subscription
+                header_params["subscription"] = request.subscription
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.acknowledge.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.acknowledge.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :acknowledge, request, options: options do |response, operation|
@@ -926,6 +1018,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::PullRequest.new
+            #
+            #   # Call the pull method.
+            #   result = client.pull request
+            #
+            #   # The returned object is of type Google::Cloud::PubSub::V1::PullResponse.
+            #   p result
+            #
             def pull request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -943,16 +1050,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "subscription" => request.subscription
-              }
+              header_params = {}
+              if request.subscription
+                header_params["subscription"] = request.subscription
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.pull.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.pull.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :pull, request, options: options do |response, operation|
@@ -985,6 +1096,30 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create an input stream
+            #   input = Gapic::StreamInput.new
+            #
+            #   # Call the streaming_pull method to start streaming.
+            #   output = client.streaming_pull input
+            #
+            #   # Send requests on the stream. For each request, pass in keyword
+            #   # arguments to set fields. Be sure to close the stream when done.
+            #   input << Google::Cloud::PubSub::V1::StreamingPullRequest.new
+            #   input << Google::Cloud::PubSub::V1::StreamingPullRequest.new
+            #   input.close
+            #
+            #   # Handle streamed responses. These may be interleaved with inputs.
+            #   # Each response is of type ::Google::Cloud::PubSub::V1::StreamingPullResponse.
+            #   output.each do |response|
+            #     p response
+            #   end
+            #
             def streaming_pull request, options = nil
               unless request.is_a? ::Enumerable
                 raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
@@ -1010,7 +1145,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.streaming_pull.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.streaming_pull.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :streaming_pull, request, options: options do |response, operation|
@@ -1063,6 +1200,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::ModifyPushConfigRequest.new
+            #
+            #   # Call the modify_push_config method.
+            #   result = client.modify_push_config request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def modify_push_config request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1080,16 +1232,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "subscription" => request.subscription
-              }
+              header_params = {}
+              if request.subscription
+                header_params["subscription"] = request.subscription
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.modify_push_config.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.modify_push_config.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :modify_push_config, request, options: options do |response, operation|
@@ -1134,6 +1290,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::GetSnapshotRequest.new
+            #
+            #   # Call the get_snapshot method.
+            #   result = client.get_snapshot request
+            #
+            #   # The returned object is of type Google::Cloud::PubSub::V1::Snapshot.
+            #   p result
+            #
             def get_snapshot request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1151,16 +1322,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "snapshot" => request.snapshot
-              }
+              header_params = {}
+              if request.snapshot
+                header_params["snapshot"] = request.snapshot
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.get_snapshot.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_snapshot.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :get_snapshot, request, options: options do |response, operation|
@@ -1211,6 +1386,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::ListSnapshotsRequest.new
+            #
+            #   # Call the list_snapshots method.
+            #   result = client.list_snapshots request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::PubSub::V1::Snapshot.
+            #     p response
+            #   end
+            #
             def list_snapshots request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1228,16 +1424,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "project" => request.project
-              }
+              header_params = {}
+              if request.project
+                header_params["project"] = request.project
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.list_snapshots.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_snapshots.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :list_snapshots, request, options: options do |response, operation|
@@ -1311,6 +1511,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::CreateSnapshotRequest.new
+            #
+            #   # Call the create_snapshot method.
+            #   result = client.create_snapshot request
+            #
+            #   # The returned object is of type Google::Cloud::PubSub::V1::Snapshot.
+            #   p result
+            #
             def create_snapshot request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1328,16 +1543,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.create_snapshot.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_snapshot.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :create_snapshot, request, options: options do |response, operation|
@@ -1385,6 +1604,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::UpdateSnapshotRequest.new
+            #
+            #   # Call the update_snapshot method.
+            #   result = client.update_snapshot request
+            #
+            #   # The returned object is of type Google::Cloud::PubSub::V1::Snapshot.
+            #   p result
+            #
             def update_snapshot request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1402,16 +1636,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "snapshot.name" => request.snapshot.name
-              }
+              header_params = {}
+              if request.snapshot&.name
+                header_params["snapshot.name"] = request.snapshot.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.update_snapshot.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_snapshot.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :update_snapshot, request, options: options do |response, operation|
@@ -1460,6 +1698,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::DeleteSnapshotRequest.new
+            #
+            #   # Call the delete_snapshot method.
+            #   result = client.delete_snapshot request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_snapshot request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1477,16 +1730,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "snapshot" => request.snapshot
-              }
+              header_params = {}
+              if request.snapshot
+                header_params["snapshot"] = request.snapshot
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.delete_snapshot.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_snapshot.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :delete_snapshot, request, options: options do |response, operation|
@@ -1499,8 +1756,8 @@ module Google
 
             ##
             # Seeks an existing subscription to a point in time or to a given snapshot,
-            # whichever is provided in the request. Snapshots are used in [Seek](
-            # https://cloud.google.com/pubsub/docs/replay-overview) operations, which
+            # whichever is provided in the request. Snapshots are used in [Seek]
+            # (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
             # allow you to manage message acknowledgments in bulk. That is, you can set
             # the acknowledgment state of messages in an existing subscription to the
             # state captured by a snapshot. Note that both the subscription and the
@@ -1548,6 +1805,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/pubsub/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::Subscriber::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::PubSub::V1::SeekRequest.new
+            #
+            #   # Call the seek method.
+            #   result = client.seek request
+            #
+            #   # The returned object is of type Google::Cloud::PubSub::V1::SeekResponse.
+            #   p result
+            #
             def seek request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1565,16 +1837,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "subscription" => request.subscription
-              }
+              header_params = {}
+              if request.subscription
+                header_params["subscription"] = request.subscription
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.seek.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.seek.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @subscriber_stub.call_rpc :seek, request, options: options do |response, operation|
@@ -1598,22 +1874,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To 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
+            # @example
             #
-            # To apply the above configuration only to a new client:
+            #   # 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
             #
-            #     client = ::Google::Cloud::PubSub::V1::Subscriber::Client.new 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
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.
@@ -1677,7 +1952,7 @@ module Google
               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(: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
@@ -1698,7 +1973,7 @@ module Google
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
-                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                   Rpcs.new parent_rpcs
                 end
               end
@@ -1710,7 +1985,7 @@ module Google
               # Each configuration object is of type `Gapic::Config::Method` and includes
               # the following configuration fields:
               #
-              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `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:
@@ -1804,37 +2079,37 @@ module Google
 
                 # @private
                 def initialize parent_rpcs = nil
-                  create_subscription_config = parent_rpcs&.create_subscription if parent_rpcs&.respond_to? :create_subscription
+                  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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_config = parent_rpcs.seek if parent_rpcs.respond_to? :seek
                   @seek = ::Gapic::Config::Method.new seek_config
 
                   yield self if block_given?