google-cloud-service_control-v1 0.4.1 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38a9cee1ca0ac64fd0b8f8522f9a2439b64cf7269a3fa63e4a9f3cdf15491a95
-  data.tar.gz: aeb22666651734eadbbfbd30a53c1ca9df8d292bda2e969346555d93678d19a4
+  metadata.gz: 44865b72852210f1be156d154d92ba6374b6e66f55811ca133e3858c41f7167f
+  data.tar.gz: 6e693e2d37fa4b9aa8129955e108f517f8106c36f64bfb4fced6006a405741cd
 SHA512:
-  metadata.gz: 91ec1c1dacdcfc01fef2ff4991310cb41a2f099aca6fcf7c2e0978dfc3728790f363c4fb74a446ba4d1c0638a746f8e324a631a76f86fd3778029c1bc6b3b4be
-  data.tar.gz: 560043fa4fc021aedce0672d5cba4e1e9f810b1fff3953a05fe1c983996230a2ee38f117cdde766da63ff9b55fe793fd8c68a29285faabc5476571f299202cda
+  metadata.gz: 1225c233c4a5493695f02573be1e9aad66491ef731e7ab8fcc380cbbd47ed22d9ad395852f49b9a4f0ce17bfae4391923d1d00c04ba1c31c0d77e097f07d7fce
+  data.tar.gz: '097cb81813729989ef6cec3d822c258394629f0142f55565a2c3dba2f992ad64a7df202496b9be5d8f916bf190c2c9c33fa789f007c4a5e4547bc5a88aad8863'

data/AUTHENTICATION.md

@@ -82,8 +82,8 @@ client = ::Google::Cloud::ServiceControl::V1::QuotaController::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/service_control/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |co
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/service_control/v1"

data/lib/google/api/servicecontrol/v1/check_error_pb.rb

@@ -1,9 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/api/servicecontrol/v1/check_error.proto
 
+require 'google/rpc/status_pb'
 require 'google/protobuf'
 
-require 'google/rpc/status_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/api/servicecontrol/v1/check_error.proto", :syntax => :proto3) do
     add_message "google.api.servicecontrol.v1.CheckError" do

data/lib/google/api/servicecontrol/v1/distribution_pb.rb

@@ -1,9 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/api/servicecontrol/v1/distribution.proto
 
+require 'google/api/distribution_pb'
 require 'google/protobuf'
 
-require 'google/api/distribution_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/api/servicecontrol/v1/distribution.proto", :syntax => :proto3) do
     add_message "google.api.servicecontrol.v1.Distribution" do

data/lib/google/api/servicecontrol/v1/http_request_pb.rb

@@ -1,9 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/api/servicecontrol/v1/http_request.proto
 
+require 'google/protobuf/duration_pb'
 require 'google/protobuf'
 
-require 'google/protobuf/duration_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/api/servicecontrol/v1/http_request.proto", :syntax => :proto3) do
     add_message "google.api.servicecontrol.v1.HttpRequest" do

data/lib/google/api/servicecontrol/v1/log_entry_pb.rb

@@ -1,13 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/api/servicecontrol/v1/log_entry.proto
 
-require 'google/protobuf'
-
 require 'google/api/servicecontrol/v1/http_request_pb'
 require 'google/logging/type/log_severity_pb'
 require 'google/protobuf/any_pb'
 require 'google/protobuf/struct_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/api/servicecontrol/v1/log_entry.proto", :syntax => :proto3) do
     add_message "google.api.servicecontrol.v1.LogEntry" do

data/lib/google/api/servicecontrol/v1/metric_value_pb.rb

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/api/servicecontrol/v1/metric_value.proto
 
-require 'google/protobuf'
-
 require 'google/api/servicecontrol/v1/distribution_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/api/servicecontrol/v1/metric_value.proto", :syntax => :proto3) do
     add_message "google.api.servicecontrol.v1.MetricValue" do

data/lib/google/api/servicecontrol/v1/operation_pb.rb

@@ -1,12 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/api/servicecontrol/v1/operation.proto
 
-require 'google/protobuf'
-
 require 'google/api/servicecontrol/v1/log_entry_pb'
 require 'google/api/servicecontrol/v1/metric_value_pb'
 require 'google/protobuf/any_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/api/servicecontrol/v1/operation.proto", :syntax => :proto3) do
     add_message "google.api.servicecontrol.v1.Operation" do

data/lib/google/api/servicecontrol/v1/quota_controller_pb.rb

@@ -1,12 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/api/servicecontrol/v1/quota_controller.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/servicecontrol/v1/metric_value_pb'
 require 'google/rpc/status_pb'
 require 'google/api/client_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/api/servicecontrol/v1/quota_controller.proto", :syntax => :proto3) do
     add_message "google.api.servicecontrol.v1.AllocateQuotaRequest" do

data/lib/google/api/servicecontrol/v1/quota_controller_services_pb.rb

@@ -30,7 +30,7 @@ module Google
           # service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/api/servicecontrol/v1/service_controller_pb.rb

@@ -1,14 +1,14 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/api/servicecontrol/v1/service_controller.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/servicecontrol/v1/check_error_pb'
 require 'google/api/servicecontrol/v1/operation_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/api/servicecontrol/v1/service_controller.proto", :syntax => :proto3) do
     add_message "google.api.servicecontrol.v1.CheckRequest" do

data/lib/google/api/servicecontrol/v1/service_controller_services_pb.rb

@@ -30,7 +30,7 @@ module Google
           # service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/service_control/v1/quota_controller/client.rb

@@ -42,13 +42,12 @@ module Google
             # See {::Google::Cloud::ServiceControl::V1::QuotaController::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all QuotaController clients:
-            #
-            #     ::Google::Cloud::ServiceControl::V1::QuotaController::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all QuotaController clients
+            #   ::Google::Cloud::ServiceControl::V1::QuotaController::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -95,19 +94,15 @@ module Google
             ##
             # Create a new QuotaController client object.
             #
-            # ## Examples
-            #
-            # To create a new QuotaController client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new
             #
-            # To create a new QuotaController client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the QuotaController client.
             # @yieldparam config [Client::Configuration]
@@ -127,10 +122,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
@@ -199,6 +193,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/service_control/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::ServiceControl::V1::QuotaController::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ServiceControl::V1::AllocateQuotaRequest.new
+            #
+            #   # Call the allocate_quota method.
+            #   result = client.allocate_quota request
+            #
+            #   # The returned object is of type Google::Cloud::ServiceControl::V1::AllocateQuotaResponse.
+            #   p result
+            #
             def allocate_quota request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -216,16 +225,20 @@ module Google
                 gapic_version: ::Google::Cloud::ServiceControl::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "service_name" => request.service_name
-              }
+              header_params = {}
+              if request.service_name
+                header_params["service_name"] = request.service_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.allocate_quota.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.allocate_quota.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @quota_controller_stub.call_rpc :allocate_quota, request, options: options do |response, operation|
@@ -249,22 +262,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 allocate_quota
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::ServiceControl::V1::QuotaController::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.allocate_quota.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.allocate_quota.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # allocate_quota to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::ServiceControl::V1::QuotaController::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.allocate_quota.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::ServiceControl::V1::QuotaController::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.allocate_quota.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/service_control/v1/service_controller/client.rb

@@ -42,13 +42,12 @@ module Google
             # See {::Google::Cloud::ServiceControl::V1::ServiceController::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all ServiceController clients:
-            #
-            #     ::Google::Cloud::ServiceControl::V1::ServiceController::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all ServiceController clients
+            #   ::Google::Cloud::ServiceControl::V1::ServiceController::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -102,19 +101,15 @@ module Google
             ##
             # Create a new ServiceController client object.
             #
-            # ## Examples
-            #
-            # To create a new ServiceController client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new
+            # @example
             #
-            # To create a new ServiceController client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new
             #
-            #     client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the ServiceController client.
             # @yieldparam config [Client::Configuration]
@@ -134,10 +129,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
@@ -216,6 +210,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/service_control/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::ServiceControl::V1::ServiceController::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ServiceControl::V1::CheckRequest.new
+            #
+            #   # Call the check method.
+            #   result = client.check request
+            #
+            #   # The returned object is of type Google::Cloud::ServiceControl::V1::CheckResponse.
+            #   p result
+            #
             def check request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -233,16 +242,20 @@ module Google
                 gapic_version: ::Google::Cloud::ServiceControl::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "service_name" => request.service_name
-              }
+              header_params = {}
+              if request.service_name
+                header_params["service_name"] = request.service_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.check.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.check.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @service_controller_stub.call_rpc :check, request, options: options do |response, operation|
@@ -319,6 +332,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/service_control/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::ServiceControl::V1::ServiceController::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ServiceControl::V1::ReportRequest.new
+            #
+            #   # Call the report method.
+            #   result = client.report request
+            #
+            #   # The returned object is of type Google::Cloud::ServiceControl::V1::ReportResponse.
+            #   p result
+            #
             def report request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -336,16 +364,20 @@ module Google
                 gapic_version: ::Google::Cloud::ServiceControl::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "service_name" => request.service_name
-              }
+              header_params = {}
+              if request.service_name
+                header_params["service_name"] = request.service_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.report.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.report.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @service_controller_stub.call_rpc :report, request, options: options do |response, operation|
@@ -369,22 +401,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 check
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::ServiceControl::V1::ServiceController::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.check.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.check.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # check to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::ServiceControl::V1::ServiceController::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.check.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::ServiceControl::V1::ServiceController::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.check.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/service_control/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module ServiceControl
       module V1
-        VERSION = "0.4.1"
+        VERSION = "0.4.5"
       end
     end
   end

data/proto_docs/google/api/servicecontrol/v1/distribution.rb

@@ -25,10 +25,10 @@ module Google
         # points. It contains the size of the population of sample points plus
         # additional optional information:
         #
-        #   - the arithmetic mean of the samples
-        #   - the minimum and maximum of the samples
-        #   - the sum-squared-deviation of the samples, used to compute variance
-        #   - a histogram of the values of the sample points
+        # * the arithmetic mean of the samples
+        # * the minimum and maximum of the samples
+        # * the sum-squared-deviation of the samples, used to compute variance
+        # * a histogram of the values of the sample points
         # @!attribute [rw] count
         #   @return [::Integer]
         #     The total number of samples in the distribution. Must be >= 0.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-service_control-v1
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.5
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a