google-cloud-pubsub-v1 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f7d1c69dbbebade711c381290821b22d0e8205d613b3b615e2fc1ce1de949ff
-  data.tar.gz: 0700d32c025dc6a8a872cdf95183e72f69480a926cd1a47e4c4e3c38cf6ba209
+  metadata.gz: d56cc17594032fd9f7922440bb1e361788d9fb761af4f97818b094715bf2e75a
+  data.tar.gz: f112e0ff2369f89d662c02b1cebc913b9096c88ddb5c13df3c1c19d7d71e6c0c
 SHA512:
-  metadata.gz: f808f020eea3ffdbd6274b0748ed72bd59c9c7cf2e1fcdb85534088a60fc81fe3e45c891c94443a8472b5b33c0ec465818c346382e18dc7e8cffe1f8a52a8970
-  data.tar.gz: 2b8d9fb7e95d30951805c13df5e42ada749733ef334acadfda225246fcfc1a0ba5e1d693c7abd1bd80dfb25a3782ee192dcf6f4f74ea48939647cb715b9183d2
+  metadata.gz: 3b72839c23b21ae5b20db0abecf75199238ce0e2808fe75774fe3199ab65e08243e32dae9698a02f9da531f6204f72d67afd781ac05d5209cab35673e3df6a8d
+  data.tar.gz: 3bd6d52b3e4cd305275056d9ddcdb9710d9a56e957da8e030e1d1b7d8eede13cff168537e1cfdcc84bfd8d8ac9e69cdb7fc62c148e31e985f304522a62ebe26b

data/AUTHENTICATION.md

@@ -82,8 +82,8 @@ client = ::Google::Cloud::PubSub::V1::SchemaService::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/pubsub/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::PubSub::V1::SchemaService::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/pubsub/v1"

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

@@ -63,13 +63,12 @@ module Google
             # See {::Google::Cloud::PubSub::V1::IAMPolicy::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all IAMPolicy clients:
-            #
-            #     ::Google::Cloud::PubSub::V1::IAMPolicy::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all IAMPolicy clients
+            #   ::Google::Cloud::PubSub::V1::IAMPolicy::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -116,19 +115,15 @@ module Google
             ##
             # Create a new IAMPolicy client object.
             #
-            # ## Examples
-            #
-            # To create a new IAMPolicy client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::PubSub::V1::IAMPolicy::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::PubSub::V1::IAMPolicy::Client.new
             #
-            # To create a new IAMPolicy client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::PubSub::V1::IAMPolicy::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::PubSub::V1::IAMPolicy::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the IAMPolicy client.
             # @yieldparam config [Client::Configuration]
@@ -148,10 +143,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # 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.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              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
@@ -208,6 +202,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/iam/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::IAMPolicy::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Iam::V1::SetIamPolicyRequest.new
+            #
+            #   # Call the set_iam_policy method.
+            #   result = client.set_iam_policy request
+            #
+            #   # The returned object is of type Google::Iam::V1::Policy.
+            #   p result
+            #
             def set_iam_policy request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -225,16 +234,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "resource" => request.resource
-              }
+              header_params = {}
+              if request.resource
+                header_params["resource"] = request.resource
+              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.set_iam_policy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.set_iam_policy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @iam_policy_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
@@ -280,6 +293,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/iam/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::IAMPolicy::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Iam::V1::GetIamPolicyRequest.new
+            #
+            #   # Call the get_iam_policy method.
+            #   result = client.get_iam_policy request
+            #
+            #   # The returned object is of type Google::Iam::V1::Policy.
+            #   p result
+            #
             def get_iam_policy request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -297,16 +325,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "resource" => request.resource
-              }
+              header_params = {}
+              if request.resource
+                header_params["resource"] = request.resource
+              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_iam_policy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_iam_policy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @iam_policy_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
@@ -358,6 +390,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/iam/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::PubSub::V1::IAMPolicy::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Iam::V1::TestIamPermissionsRequest.new
+            #
+            #   # Call the test_iam_permissions method.
+            #   result = client.test_iam_permissions request
+            #
+            #   # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
+            #   p result
+            #
             def test_iam_permissions request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -375,16 +422,20 @@ module Google
                 gapic_version: ::Google::Cloud::PubSub::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "resource" => request.resource
-              }
+              header_params = {}
+              if request.resource
+                header_params["resource"] = request.resource
+              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.test_iam_permissions.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.test_iam_permissions.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @iam_policy_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
@@ -408,22 +459,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 set_iam_policy
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::PubSub::V1::IAMPolicy::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.set_iam_policy.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::PubSub::V1::IAMPolicy::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.set_iam_policy.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # set_iam_policy to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::PubSub::V1::IAMPolicy::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.set_iam_policy.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::PubSub::V1::IAMPolicy::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.set_iam_policy.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.