google-cloud-service_management-v1 0.3.0 → 0.3.4

data/proto_docs/google/api/context.rb

@@ -36,6 +36,25 @@ module Google
     #
     # Available context types are defined in package
     # `google.rpc.context`.
+    #
+    # This also provides mechanism to allowlist any protobuf message extension that
+    # can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
+    # “x-goog-ext-<extension_id>-jspb” format. For example, list any service
+    # specific protobuf types that can appear in grpc metadata as follows in your
+    # yaml file:
+    #
+    # Example:
+    #
+    #     context:
+    #       rules:
+    #        - selector: "google.example.library.v1.LibraryService.CreateBook"
+    #          allowed_request_extensions:
+    #          - google.foo.v1.NewExtension
+    #          allowed_response_extensions:
+    #          - google.foo.v1.NewExtension
+    #
+    # You can also specify extension ID instead of fully qualified extension name
+    # here.
     # @!attribute [rw] rules
     #   @return [::Array<::Google::Api::ContextRule>]
     #     A list of RPC context rules that apply to individual API methods.
@@ -59,6 +78,14 @@ module Google
     # @!attribute [rw] provided
     #   @return [::Array<::String>]
     #     A list of full type names of provided contexts.
+    # @!attribute [rw] allowed_request_extensions
+    #   @return [::Array<::String>]
+    #     A list of full type names or extension IDs of extensions allowed in grpc
+    #     side channel from client to backend.
+    # @!attribute [rw] allowed_response_extensions
+    #   @return [::Array<::String>]
+    #     A list of full type names or extension IDs of extensions allowed in grpc
+    #     side channel from backend to client.
     class ContextRule
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/api/documentation.rb

@@ -89,6 +89,12 @@ module Google
     # @!attribute [rw] documentation_root_url
     #   @return [::String]
     #     The URL to the root of documentation.
+    # @!attribute [rw] service_root_url
+    #   @return [::String]
+    #     Specifies the service root url if the default one (the service name
+    #     from the yaml file) is not suitable. This can be seen in any fully
+    #     specified service urls as well as sections that show a base that other
+    #     urls are relative to.
     # @!attribute [rw] overview
     #   @return [::String]
     #     Declares a single overview page. For example:
@@ -115,16 +121,16 @@ module Google
     #     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.
     # @!attribute [rw] description
     #   @return [::String]
     #     Description of the selected API(s).
     # @!attribute [rw] deprecation_description
     #   @return [::String]
-    #     Deprecation description of the selected element(s). It can be provided if an
-    #     element is marked as `deprecated`.
+    #     Deprecation description of the selected element(s). It can be provided if
+    #     an element is marked as `deprecated`.
     class DocumentationRule
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -150,8 +156,8 @@ module Google
     #     `[Java][Tutorial.Java]`.
     # @!attribute [rw] content
     #   @return [::String]
-    #     The Markdown content of the page. You can use <code>&#40;== include \\{path} ==&#41;</code>
-    #     to include content from a Markdown file.
+    #     The Markdown content of the page. You can use <code>&#40;== include \\{path}
+    #     ==&#41;</code> to include content from a Markdown file.
     # @!attribute [rw] subpages
     #   @return [::Array<::Google::Api::Page>]
     #     Subpages of this page. The order of subpages specified here will be

data/proto_docs/google/api/endpoint.rb

@@ -19,10 +19,10 @@
 
 module Google
   module Api
-    # `Endpoint` describes a network endpoint that serves a set of APIs.
-    # A service may expose any number of endpoints, and all endpoints share the
-    # same service configuration, such as quota configuration and monitoring
-    # configuration.
+    # `Endpoint` describes a network endpoint of a service that serves a set of
+    # APIs. It is commonly known as a service endpoint. A service may expose
+    # any number of service endpoints, and all service endpoints share the same
+    # service definition, such as quota limits and monitoring metrics.
     #
     # Example service configuration:
     #
@@ -40,20 +40,20 @@ module Google
     #     The canonical name of this endpoint.
     # @!attribute [rw] aliases
     #   @return [::Array<::String>]
+    #     Unimplemented. Dot not use.
+    #
     #     DEPRECATED: This field is no longer supported. Instead of using aliases,
     #     please specify multiple {::Google::Api::Endpoint google.api.Endpoint} for each of the intended
     #     aliases.
     #
     #     Additional names that this endpoint will be hosted on.
-    # @!attribute [rw] features
-    #   @return [::Array<::String>]
-    #     The list of features enabled on this endpoint.
     # @!attribute [rw] target
     #   @return [::String]
     #     The specification of an Internet routable address of API frontend that will
-    #     handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).
-    #     It should be either a valid IPv4 address or a fully-qualified domain name.
-    #     For example, "8.8.8.8" or "myservice.appspot.com".
+    #     handle requests to this [API
+    #     Endpoint](https://cloud.google.com/apis/design/glossary). It should be
+    #     either a valid IPv4 address or a fully-qualified domain name. For example,
+    #     "8.8.8.8" or "myservice.appspot.com".
     # @!attribute [rw] allow_cors
     #   @return [::Boolean]
     #     Allowing

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

data/proto_docs/google/api/launch_stage.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # The launch stage as defined by [Google Cloud Platform
+    # Launch Stages](http://cloud.google.com/terms/launch-stages).
+    module LaunchStage
+      # Do not use this default value.
+      LAUNCH_STAGE_UNSPECIFIED = 0
+
+      # The feature is not yet implemented. Users can not use it.
+      UNIMPLEMENTED = 6
+
+      # Prelaunch features are hidden from users and are only visible internally.
+      PRELAUNCH = 7
+
+      # Early Access features are limited to a closed group of testers. To use
+      # these features, you must sign up in advance and sign a Trusted Tester
+      # agreement (which includes confidentiality provisions). These features may
+      # be unstable, changed in backward-incompatible ways, and are not
+      # guaranteed to be released.
+      EARLY_ACCESS = 1
+
+      # Alpha is a limited availability test for releases before they are cleared
+      # for widespread use. By Alpha, all significant design issues are resolved
+      # and we are in the process of verifying functionality. Alpha customers
+      # need to apply for access, agree to applicable terms, and have their
+      # projects allowlisted. Alpha releases don’t have to be feature complete,
+      # no SLAs are provided, and there are no technical support obligations, but
+      # they will be far enough along that customers can actually use them in
+      # test environments or for limited-use tests -- just like they would in
+      # normal production cases.
+      ALPHA = 2
+
+      # Beta is the point at which we are ready to open a release for any
+      # customer to use. There are no SLA or technical support obligations in a
+      # Beta release. Products will be complete from a feature perspective, but
+      # may have some open outstanding issues. Beta releases are suitable for
+      # limited production use cases.
+      BETA = 3
+
+      # GA features are open to all developers and are considered stable and
+      # fully qualified for production use.
+      GA = 4
+
+      # Deprecated features are scheduled to be shut down and removed. For more
+      # information, see the “Deprecation Policy” section of our [Terms of
+      # Service](https://cloud.google.com/terms/)
+      # and the [Google Cloud Platform Subject to the Deprecation
+      # Policy](https://cloud.google.com/terms/deprecation) documentation.
+      DEPRECATED = 5
+    end
+  end
+end

data/proto_docs/google/api/metric.rb

@@ -28,11 +28,12 @@ module Google
     # @!attribute [rw] type
     #   @return [::String]
     #     The metric type, including its DNS name prefix. The type is not
-    #     URL-encoded.  All user-defined custom metric types have the DNS name
-    #     `custom.googleapis.com`.  Metric types should use a natural hierarchical
-    #     grouping. For example:
+    #     URL-encoded. All user-defined metric types have the DNS name
+    #     `custom.googleapis.com` or `external.googleapis.com`. Metric types should
+    #     use a natural hierarchical grouping. For example:
     #
     #         "custom.googleapis.com/invoice/paid/amount"
+    #         "external.googleapis.com/prometheus/up"
     #         "appengine.googleapis.com/http/server/response_latencies"
     # @!attribute [rw] labels
     #   @return [::Array<::Google::Api::LabelDescriptor>]
@@ -52,10 +53,28 @@ module Google
     #     Some combinations of `metric_kind` and `value_type` might not be supported.
     # @!attribute [rw] unit
     #   @return [::String]
-    #     The unit in which the metric value is reported. It is only applicable
-    #     if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
-    #     supported units are a subset of [The Unified Code for Units of
-    #     Measure](http://unitsofmeasure.org/ucum.html) standard:
+    #     The units in which the metric value is reported. It is only applicable
+    #     if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
+    #     defines the representation of the stored metric values.
+    #
+    #     Different systems might scale the values to be more easily displayed (so a
+    #     value of `0.02kBy` _might_ be displayed as `20By`, and a value of
+    #     `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is
+    #     `kBy`, then the value of the metric is always in thousands of bytes, no
+    #     matter how it might be displayed.
+    #
+    #     If you want a custom metric to record the exact number of CPU-seconds used
+    #     by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is
+    #     `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005
+    #     CPU-seconds, then the value is written as `12005`.
+    #
+    #     Alternatively, if you want a custom metric to record data in a more
+    #     granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
+    #     `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`),
+    #     or use `Kis{CPU}` and write `11.723` (which is `12005/1024`).
+    #
+    #     The supported units are a subset of [The Unified Code for Units of
+    #     Measure](https://unitsofmeasure.org/ucum.html) standard:
     #
     #     **Basic units (UNIT)**
     #
@@ -65,36 +84,44 @@ module Google
     #     * `min`   minute
     #     * `h`     hour
     #     * `d`     day
+    #     * `1`     dimensionless
     #
     #     **Prefixes (PREFIX)**
     #
-    #     * `k`     kilo    (10**3)
-    #     * `M`     mega    (10**6)
-    #     * `G`     giga    (10**9)
-    #     * `T`     tera    (10**12)
-    #     * `P`     peta    (10**15)
-    #     * `E`     exa     (10**18)
-    #     * `Z`     zetta   (10**21)
-    #     * `Y`     yotta   (10**24)
-    #     * `m`     milli   (10**-3)
-    #     * `u`     micro   (10**-6)
-    #     * `n`     nano    (10**-9)
-    #     * `p`     pico    (10**-12)
-    #     * `f`     femto   (10**-15)
-    #     * `a`     atto    (10**-18)
-    #     * `z`     zepto   (10**-21)
-    #     * `y`     yocto   (10**-24)
-    #     * `Ki`    kibi    (2**10)
-    #     * `Mi`    mebi    (2**20)
-    #     * `Gi`    gibi    (2**30)
-    #     * `Ti`    tebi    (2**40)
+    #     * `k`     kilo    (10^3)
+    #     * `M`     mega    (10^6)
+    #     * `G`     giga    (10^9)
+    #     * `T`     tera    (10^12)
+    #     * `P`     peta    (10^15)
+    #     * `E`     exa     (10^18)
+    #     * `Z`     zetta   (10^21)
+    #     * `Y`     yotta   (10^24)
+    #
+    #     * `m`     milli   (10^-3)
+    #     * `u`     micro   (10^-6)
+    #     * `n`     nano    (10^-9)
+    #     * `p`     pico    (10^-12)
+    #     * `f`     femto   (10^-15)
+    #     * `a`     atto    (10^-18)
+    #     * `z`     zepto   (10^-21)
+    #     * `y`     yocto   (10^-24)
+    #
+    #     * `Ki`    kibi    (2^10)
+    #     * `Mi`    mebi    (2^20)
+    #     * `Gi`    gibi    (2^30)
+    #     * `Ti`    tebi    (2^40)
+    #     * `Pi`    pebi    (2^50)
     #
     #     **Grammar**
     #
     #     The grammar also includes these connectors:
     #
-    #     * `/`    division (as an infix operator, e.g. `1/s`).
-    #     * `.`    multiplication (as an infix operator, e.g. `GBy.d`)
+    #     * `/`    division or ratio (as an infix operator). For examples,
+    #              `kBy/{email}` or `MiBy/10ms` (although you should almost never
+    #              have `/s` in a metric `unit`; rates should always be computed at
+    #              query time from the underlying cumulative or delta value).
+    #     * `.`    multiplication or composition (as an infix operator). For
+    #              examples, `GBy.d` or `k{watt}.h`.
     #
     #     The grammar for a unit is as follows:
     #
@@ -109,14 +136,25 @@ module Google
     #
     #     Notes:
     #
-    #     * `Annotation` is just a comment if it follows a `UNIT` and is
-    #        equivalent to `1` if it is used alone. For examples,
-    #        `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
+    #     * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
+    #        is used alone, then the unit is equivalent to `1`. For examples,
+    #        `{request}/s == 1/s`, `By{transmitted}/s == By/s`.
     #     * `NAME` is a sequence of non-blank printable ASCII characters not
-    #        containing '\\{' or '}'.
-    #     * `1` represents dimensionless value 1, such as in `1/s`.
-    #     * `%` represents dimensionless value 1/100, and annotates values giving
-    #        a percentage.
+    #        containing `{` or `}`.
+    #     * `1` represents a unitary [dimensionless
+    #        unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
+    #        as in `1/s`. It is typically used when none of the basic units are
+    #        appropriate. For example, "new users per day" can be represented as
+    #        `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new
+    #        users). Alternatively, "thousands of page views per day" would be
+    #        represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric
+    #        value of `5.3` would mean "5300 page views per day").
+    #     * `%` represents dimensionless value of 1/100, and annotates values giving
+    #        a percentage (so the metric values are typically in the range of 0..100,
+    #        and a metric value `3` means "3 percent").
+    #     * `10^2.%` indicates a metric contains a ratio, typically in the range
+    #        0..1, that will be multiplied by 100 and displayed as a percentage
+    #        (so a metric value `0.03` means "3 percent").
     # @!attribute [rw] description
     #   @return [::String]
     #     A detailed description of the metric, which can be used in documentation.
@@ -126,11 +164,46 @@ module Google
     #     Use sentence case without an ending period, for example "Request count".
     #     This field is optional but it is recommended to be set for any metrics
     #     associated with user-visible concepts, such as Quota.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Api::MetricDescriptor::MetricDescriptorMetadata]
+    #     Optional. Metadata which can be used to guide usage of the metric.
+    # @!attribute [rw] launch_stage
+    #   @return [::Google::Api::LaunchStage]
+    #     Optional. The launch stage of the metric definition.
+    # @!attribute [rw] monitored_resource_types
+    #   @return [::Array<::String>]
+    #     Read-only. If present, then a [time
+    #     series][google.monitoring.v3.TimeSeries], which is identified partially by
+    #     a metric type and a {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor}, that is associated
+    #     with this metric type can only be associated with one of the monitored
+    #     resource types listed here.
     class MetricDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
 
+      # Additional annotations that can be used to guide the usage of a metric.
+      # @!attribute [rw] launch_stage
+      #   @return [::Google::Api::LaunchStage]
+      #     Deprecated. Must use the {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} instead.
+      # @!attribute [rw] sample_period
+      #   @return [::Google::Protobuf::Duration]
+      #     The sampling period of metric data points. For metrics which are written
+      #     periodically, consecutive data points are stored at this time interval,
+      #     excluding data loss due to errors. Metrics with a higher granularity have
+      #     a smaller sampling period.
+      # @!attribute [rw] ingest_delay
+      #   @return [::Google::Protobuf::Duration]
+      #     The delay of data points caused by ingestion. Data points older than this
+      #     age are guaranteed to be ingested and available to be read, excluding
+      #     data loss due to errors.
+      class MetricDescriptorMetadata
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
       # The kind of measurement. It describes how the data is reported.
+      # For information on setting the start time and end time based on
+      # the MetricKind, see [TimeInterval][google.monitoring.v3.TimeInterval].
       module MetricKind
         # Do not use this default value.
         METRIC_KIND_UNSPECIFIED = 0

data/proto_docs/google/api/monitored_resource.rb

@@ -40,7 +40,6 @@ module Google
     #   @return [::String]
     #     Required. The monitored resource type. For example, the type
     #     `"cloudsql_database"` represents databases in Google Cloud SQL.
-    #     The maximum length of this value is 256 characters.
     # @!attribute [rw] display_name
     #   @return [::String]
     #     Optional. A concise name for the monitored resource type that might be
@@ -56,6 +55,9 @@ module Google
     #     Required. A set of labels used to describe instances of this monitored
     #     resource type. For example, an individual Google Cloud SQL database is
     #     identified by values for the labels `"database_id"` and `"zone"`.
+    # @!attribute [rw] launch_stage
+    #   @return [::Google::Api::LaunchStage]
+    #     Optional. The launch stage of the monitored resource definition.
     class MonitoredResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -101,15 +103,14 @@ module Google
     # Auxiliary metadata for a {::Google::Api::MonitoredResource MonitoredResource} object.
     # {::Google::Api::MonitoredResource MonitoredResource} objects contain the minimum set of information to
     # uniquely identify a monitored resource instance. There is some other useful
-    # auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion
-    # pipeline to extract metadata for cloud resources of all types , and stores
+    # auxiliary metadata. Monitoring and Logging use an ingestion
+    # pipeline to extract metadata for cloud resources of all types, and store
     # the metadata in this message.
     # @!attribute [rw] system_labels
     #   @return [::Google::Protobuf::Struct]
     #     Output only. Values for predefined system metadata labels.
-    #     System labels are a kind of metadata extracted by Google Stackdriver.
-    #     Stackdriver determines what system labels are useful and how to obtain
-    #     their values. Some examples: "machine_image", "vpc", "subnet_id",
+    #     System labels are a kind of metadata extracted by Google, including
+    #     "machine_image", "vpc", "subnet_id",
     #     "security_group", "name", etc.
     #     System label values can be only strings, Boolean values, or a list of
     #     strings. For example: