classes.rb in google-api-client-0.28.6

- old
+ new

@@ -961,13 +961,13 @@
         attr_accessor :description
       
         # The selector is a comma-separated list of patterns. Each pattern is a
         # qualified name of the element which may end in "*", indicating a wildcard.
         # Wildcards are only allowed at the end and for a whole component of the
-        # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
-        # specify a default for all applicable elements, the whole pattern "*"
-        # is used.
+        # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A
+        # wildcard will match one or more components. To specify a default for all
+        # applicable elements, the whole pattern "*" is used.
         # Corresponds to the JSON property `selector`
         # @return [String]
         attr_accessor :selector
       
         def initialize(**args)
@@ -2557,11 +2557,50 @@
           @name = args[:name] if args.key?(:name)
           @subpages = args[:subpages] if args.key?(:subpages)
         end
       end
       
-      # 
+      # Quota configuration helps to achieve fairness and budgeting in service
+      # usage.
+      # The metric based quota configuration works this way:
+      # - The service configuration defines a set of metrics.
+      # - For API calls, the quota.metric_rules maps methods to metrics with
+      # corresponding costs.
+      # - The quota.limits defines limits on the metrics, which will be used for
+      # quota checks at runtime.
+      # An example quota configuration in yaml format:
+      # quota:
+      # limits:
+      # - name: apiWriteQpsPerProject
+      # metric: library.googleapis.com/write_calls
+      # unit: "1/min/`project`"  # rate limit for consumer projects
+      # values:
+      # STANDARD: 10000
+      # # The metric rules bind all methods to the read_calls metric,
+      # # except for the UpdateBook and DeleteBook methods. These two methods
+      # # are mapped to the write_calls metric, with the UpdateBook method
+      # # consuming at twice rate as the DeleteBook method.
+      # metric_rules:
+      # - selector: "*"
+      # metric_costs:
+      # library.googleapis.com/read_calls: 1
+      # - selector: google.example.library.v1.LibraryService.UpdateBook
+      # metric_costs:
+      # library.googleapis.com/write_calls: 2
+      # - selector: google.example.library.v1.LibraryService.DeleteBook
+      # metric_costs:
+      # library.googleapis.com/write_calls: 1
+      # Corresponding Metric definition:
+      # metrics:
+      # - name: library.googleapis.com/read_calls
+      # display_name: Read requests
+      # metric_kind: DELTA
+      # value_type: INT64
+      # - name: library.googleapis.com/write_calls
+      # display_name: Write requests
+      # metric_kind: DELTA
+      # value_type: INT64
       class Quota
         include Google::Apis::Core::Hashable
       
         # List of `QuotaLimit` definitions for the service.
         # Corresponds to the JSON property `limits`
@@ -3087,10 +3126,49 @@
         # The Google project that owns this service.
         # Corresponds to the JSON property `producerProjectId`
         # @return [String]
         attr_accessor :producer_project_id
       
-        # Quota configuration.
+        # Quota configuration helps to achieve fairness and budgeting in service
+        # usage.
+        # The metric based quota configuration works this way:
+        # - The service configuration defines a set of metrics.
+        # - For API calls, the quota.metric_rules maps methods to metrics with
+        # corresponding costs.
+        # - The quota.limits defines limits on the metrics, which will be used for
+        # quota checks at runtime.
+        # An example quota configuration in yaml format:
+        # quota:
+        # limits:
+        # - name: apiWriteQpsPerProject
+        # metric: library.googleapis.com/write_calls
+        # unit: "1/min/`project`"  # rate limit for consumer projects
+        # values:
+        # STANDARD: 10000
+        # # The metric rules bind all methods to the read_calls metric,
+        # # except for the UpdateBook and DeleteBook methods. These two methods
+        # # are mapped to the write_calls metric, with the UpdateBook method
+        # # consuming at twice rate as the DeleteBook method.
+        # metric_rules:
+        # - selector: "*"
+        # metric_costs:
+        # library.googleapis.com/read_calls: 1
+        # - selector: google.example.library.v1.LibraryService.UpdateBook
+        # metric_costs:
+        # library.googleapis.com/write_calls: 2
+        # - selector: google.example.library.v1.LibraryService.DeleteBook
+        # metric_costs:
+        # library.googleapis.com/write_calls: 1
+        # Corresponding Metric definition:
+        # metrics:
+        # - name: library.googleapis.com/read_calls
+        # display_name: Read requests
+        # metric_kind: DELTA
+        # value_type: INT64
+        # - name: library.googleapis.com/write_calls
+        # display_name: Write requests
+        # metric_kind: DELTA
+        # value_type: INT64
         # Corresponds to the JSON property `quota`
         # @return [Google::Apis::ServicenetworkingV1::Quota]
         attr_accessor :quota
       
         # Source information used to create a Service Config