google-cloud-logging-v2 0.8.1 → 0.10.0

data/proto_docs/google/api/client.rb

@@ -0,0 +1,381 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+    # Required information for every language.
+    # @!attribute [rw] reference_docs_uri
+    #   @return [::String]
+    #     Link to automatically generated reference documentation.  Example:
+    #     https://cloud.google.com/nodejs/docs/reference/asset/latest
+    # @!attribute [rw] destinations
+    #   @return [::Array<::Google::Api::ClientLibraryDestination>]
+    #     The destination where API teams want this client library to be published.
+    class CommonLanguageSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Details about how and where to publish client libraries.
+    # @!attribute [rw] version
+    #   @return [::String]
+    #     Version of the API to apply these settings to. This is the full protobuf
+    #     package for the API, ending in the version element.
+    #     Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
+    # @!attribute [rw] launch_stage
+    #   @return [::Google::Api::LaunchStage]
+    #     Launch stage of this version of the API.
+    # @!attribute [rw] rest_numeric_enums
+    #   @return [::Boolean]
+    #     When using transport=rest, the client request will encode enums as
+    #     numbers rather than strings.
+    # @!attribute [rw] java_settings
+    #   @return [::Google::Api::JavaSettings]
+    #     Settings for legacy Java features, supported in the Service YAML.
+    # @!attribute [rw] cpp_settings
+    #   @return [::Google::Api::CppSettings]
+    #     Settings for C++ client libraries.
+    # @!attribute [rw] php_settings
+    #   @return [::Google::Api::PhpSettings]
+    #     Settings for PHP client libraries.
+    # @!attribute [rw] python_settings
+    #   @return [::Google::Api::PythonSettings]
+    #     Settings for Python client libraries.
+    # @!attribute [rw] node_settings
+    #   @return [::Google::Api::NodeSettings]
+    #     Settings for Node client libraries.
+    # @!attribute [rw] dotnet_settings
+    #   @return [::Google::Api::DotnetSettings]
+    #     Settings for .NET client libraries.
+    # @!attribute [rw] ruby_settings
+    #   @return [::Google::Api::RubySettings]
+    #     Settings for Ruby client libraries.
+    # @!attribute [rw] go_settings
+    #   @return [::Google::Api::GoSettings]
+    #     Settings for Go client libraries.
+    class ClientLibrarySettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # This message configures the settings for publishing [Google Cloud Client
+    # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
+    # generated from the service config.
+    # @!attribute [rw] method_settings
+    #   @return [::Array<::Google::Api::MethodSettings>]
+    #     A list of API method settings, e.g. the behavior for methods that use the
+    #     long-running operation pattern.
+    # @!attribute [rw] new_issue_uri
+    #   @return [::String]
+    #     Link to a *public* URI where users can report issues.  Example:
+    #     https://issuetracker.google.com/issues/new?component=190865&template=1161103
+    # @!attribute [rw] documentation_uri
+    #   @return [::String]
+    #     Link to product home page.  Example:
+    #     https://cloud.google.com/asset-inventory/docs/overview
+    # @!attribute [rw] api_short_name
+    #   @return [::String]
+    #     Used as a tracking tag when collecting data about the APIs developer
+    #     relations artifacts like docs, packages delivered to package managers,
+    #     etc.  Example: "speech".
+    # @!attribute [rw] github_label
+    #   @return [::String]
+    #     GitHub label to apply to issues and pull requests opened for this API.
+    # @!attribute [rw] codeowner_github_teams
+    #   @return [::Array<::String>]
+    #     GitHub teams to be added to CODEOWNERS in the directory in GitHub
+    #     containing source code for the client libraries for this API.
+    # @!attribute [rw] doc_tag_prefix
+    #   @return [::String]
+    #     A prefix used in sample code when demarking regions to be included in
+    #     documentation.
+    # @!attribute [rw] organization
+    #   @return [::Google::Api::ClientLibraryOrganization]
+    #     For whom the client library is being published.
+    # @!attribute [rw] library_settings
+    #   @return [::Array<::Google::Api::ClientLibrarySettings>]
+    #     Client library settings.  If the same version string appears multiple
+    #     times in this list, then the last one wins.  Settings from earlier
+    #     settings with the same version string are discarded.
+    # @!attribute [rw] proto_reference_documentation_uri
+    #   @return [::String]
+    #     Optional link to proto reference documentation.  Example:
+    #     https://cloud.google.com/pubsub/lite/docs/reference/rpc
+    class Publishing
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Java client libraries.
+    # @!attribute [rw] library_package
+    #   @return [::String]
+    #     The package name to use in Java. Clobbers the java_package option
+    #     set in the protobuf. This should be used **only** by APIs
+    #     who have already set the language_settings.java.package_name" field
+    #     in gapic.yaml. API teams should use the protobuf java_package option
+    #     where possible.
+    #
+    #     Example of a YAML configuration::
+    #
+    #      publishing:
+    #        java_settings:
+    #          library_package: com.google.cloud.pubsub.v1
+    # @!attribute [rw] service_class_names
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Configure the Java class name to use instead of the service's for its
+    #     corresponding generated GAPIC client. Keys are fully-qualified
+    #     service names as they appear in the protobuf (including the full
+    #     the language_settings.java.interface_names" field in gapic.yaml. API
+    #     teams should otherwise use the service name as it appears in the
+    #     protobuf.
+    #
+    #     Example of a YAML configuration::
+    #
+    #      publishing:
+    #        java_settings:
+    #          service_class_names:
+    #            - google.pubsub.v1.Publisher: TopicAdmin
+    #            - google.pubsub.v1.Subscriber: SubscriptionAdmin
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class JavaSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class ServiceClassNamesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+
+    # Settings for C++ client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class CppSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Php client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class PhpSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Python client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class PythonSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Node client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class NodeSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Dotnet client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from original service names to renamed versions.
+    #     This is used when the default generated types
+    #     would cause a naming conflict. (Neither name is
+    #     fully-qualified.)
+    #     Example: Subscriber to SubscriberServiceApi.
+    # @!attribute [rw] renamed_resources
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from full resource types to the effective short name
+    #     for the resource. This is used when otherwise resource
+    #     named from different services would cause naming collisions.
+    #     Example entry:
+    #     "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
+    # @!attribute [rw] ignored_resources
+    #   @return [::Array<::String>]
+    #     List of full resource types to ignore during generation.
+    #     This is typically used for API-specific Location resources,
+    #     which should be handled by the generator as if they were actually
+    #     the common Location resources.
+    #     Example entry: "documentai.googleapis.com/Location"
+    # @!attribute [rw] forced_namespace_aliases
+    #   @return [::Array<::String>]
+    #     Namespaces which must be aliased in snippets due to
+    #     a known (but non-generator-predictable) naming collision
+    # @!attribute [rw] handwritten_signatures
+    #   @return [::Array<::String>]
+    #     Method signatures (in the form "service.method(signature)")
+    #     which are provided separately, so shouldn't be generated.
+    #     Snippets *calling* these methods are still generated, however.
+    class DotnetSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedResourcesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+
+    # Settings for Ruby client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class RubySettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Go client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class GoSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Describes the generator configuration for a method.
+    # @!attribute [rw] selector
+    #   @return [::String]
+    #     The fully qualified name of the method, for which the options below apply.
+    #     This is used to find the method to apply the options.
+    # @!attribute [rw] long_running
+    #   @return [::Google::Api::MethodSettings::LongRunning]
+    #     Describes settings to use for long-running operations when generating
+    #     API methods for RPCs. Complements RPCs that use the annotations in
+    #     google/longrunning/operations.proto.
+    #
+    #     Example of a YAML configuration::
+    #
+    #      publishing:
+    #        method_settings:
+    #          - selector: google.cloud.speech.v2.Speech.BatchRecognize
+    #            long_running:
+    #              initial_poll_delay:
+    #                seconds: 60 # 1 minute
+    #              poll_delay_multiplier: 1.5
+    #              max_poll_delay:
+    #                seconds: 360 # 6 minutes
+    #              total_poll_timeout:
+    #                 seconds: 54000 # 90 minutes
+    class MethodSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Describes settings to use when generating API methods that use the
+      # long-running operation pattern.
+      # All default values below are from those used in the client library
+      # generators (e.g.
+      # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
+      # @!attribute [rw] initial_poll_delay
+      #   @return [::Google::Protobuf::Duration]
+      #     Initial delay after which the first poll request will be made.
+      #     Default value: 5 seconds.
+      # @!attribute [rw] poll_delay_multiplier
+      #   @return [::Float]
+      #     Multiplier to gradually increase delay between subsequent polls until it
+      #     reaches max_poll_delay.
+      #     Default value: 1.5.
+      # @!attribute [rw] max_poll_delay
+      #   @return [::Google::Protobuf::Duration]
+      #     Maximum time between two subsequent poll requests.
+      #     Default value: 45 seconds.
+      # @!attribute [rw] total_poll_timeout
+      #   @return [::Google::Protobuf::Duration]
+      #     Total polling timeout.
+      #     Default value: 5 minutes.
+      class LongRunning
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+
+    # The organization for which the client libraries are being published.
+    # Affects the url where generated docs are published, etc.
+    module ClientLibraryOrganization
+      # Not useful.
+      CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
+
+      # Google Cloud Platform Org.
+      CLOUD = 1
+
+      # Ads (Advertising) Org.
+      ADS = 2
+
+      # Photos Org.
+      PHOTOS = 3
+
+      # Street View Org.
+      STREET_VIEW = 4
+
+      # Shopping Org.
+      SHOPPING = 5
+
+      # Geo Org.
+      GEO = 6
+
+      # Generative AI - https://developers.generativeai.google
+      GENERATIVE_AI = 7
+    end
+
+    # To where should client libraries be published?
+    module ClientLibraryDestination
+      # Client libraries will neither be generated nor published to package
+      # managers.
+      CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
+
+      # Generate the client library in a repo under github.com/googleapis,
+      # but don't publish it to package managers.
+      GITHUB = 10
+
+      # Publish the library to package managers like nuget.org and npmjs.com.
+      PACKAGE_MANAGER = 20
+    end
+  end
+end

data/proto_docs/google/api/distribution.rb

@@ -133,6 +133,7 @@ module Google
         # following boundaries:
         #
         #    Upper bound (0 <= i < N-1):     offset + (width * i).
+        #
         #    Lower bound (1 <= i < N):       offset + (width * (i - 1)).
         # @!attribute [rw] num_finite_buckets
         #   @return [::Integer]
@@ -156,6 +157,7 @@ module Google
         # following boundaries:
         #
         #    Upper bound (0 <= i < N-1):     scale * (growth_factor ^ i).
+        #
         #    Lower bound (1 <= i < N):       scale * (growth_factor ^ (i - 1)).
         # @!attribute [rw] num_finite_buckets
         #   @return [::Integer]

data/proto_docs/google/api/launch_stage.rb

@@ -20,7 +20,7 @@
 module Google
   module Api
     # The launch stage as defined by [Google Cloud Platform
-    # Launch Stages](http://cloud.google.com/terms/launch-stages).
+    # Launch Stages](https://cloud.google.com/terms/launch-stages).
     module LaunchStage
       # Do not use this default value.
       LAUNCH_STAGE_UNSPECIFIED = 0
@@ -42,7 +42,7 @@ module Google
       # 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,
+      # 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
@@ -61,7 +61,7 @@ module Google
       GA = 4
 
       # Deprecated features are scheduled to be shut down and removed. For more
-      # information, see the “Deprecation Policy” section of our [Terms of
+      # 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.

data/proto_docs/google/api/metric.rb

@@ -174,9 +174,10 @@ module Google
     #   @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.
+    #     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
@@ -184,7 +185,9 @@ module Google
       # 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.
+      #     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
@@ -253,8 +256,9 @@ module Google
     # labels of a {::Google::Api::MetricDescriptor `MetricDescriptor`}.
     # @!attribute [rw] type
     #   @return [::String]
-    #     An existing metric type, see {::Google::Api::MetricDescriptor google.api.MetricDescriptor}.
-    #     For example, `custom.googleapis.com/invoice/paid/amount`.
+    #     An existing metric type, see
+    #     {::Google::Api::MetricDescriptor google.api.MetricDescriptor}. For example,
+    #     `custom.googleapis.com/invoice/paid/amount`.
     # @!attribute [rw] labels
     #   @return [::Google::Protobuf::Map{::String => ::String}]
     #     The set of label values that uniquely identify this metric. All

data/proto_docs/google/api/monitored_resource.rb

@@ -19,9 +19,10 @@
 
 module Google
   module Api
-    # An object that describes the schema of a {::Google::Api::MonitoredResource MonitoredResource} object using a
-    # type name and a set of labels.  For example, the monitored resource
-    # descriptor for Google Compute Engine VM instances has a type of
+    # An object that describes the schema of a
+    # {::Google::Api::MonitoredResource MonitoredResource} object using a type name
+    # and a set of labels.  For example, the monitored resource descriptor for
+    # Google Compute Engine VM instances has a type of
     # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
     # `"zone"` to identify particular VM instances.
     #
@@ -40,6 +41,10 @@ module Google
     #   @return [::String]
     #     Required. The monitored resource type. For example, the type
     #     `"cloudsql_database"` represents databases in Google Cloud SQL.
+    #      For a list of types, see [Monitoring resource
+    #      types](https://cloud.google.com/monitoring/api/resources)
+    #     and [Logging resource
+    #     types](https://cloud.google.com/logging/docs/api/v2/resource-list).
     # @!attribute [rw] display_name
     #   @return [::String]
     #     Optional. A concise name for the monitored resource type that might be
@@ -66,21 +71,28 @@ module Google
     # An object representing a resource that can be used for monitoring, logging,
     # billing, or other purposes. Examples include virtual machine instances,
     # databases, and storage devices such as disks. The `type` field identifies a
-    # {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object that describes the resource's
-    # schema. Information in the `labels` field identifies the actual resource and
-    # its attributes according to the schema. For example, a particular Compute
-    # Engine VM instance could be represented by the following object, because the
-    # {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for `"gce_instance"` has labels
-    # `"instance_id"` and `"zone"`:
+    # {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object
+    # that describes the resource's schema. Information in the `labels` field
+    # identifies the actual resource and its attributes according to the schema.
+    # For example, a particular Compute Engine VM instance could be represented by
+    # the following object, because the
+    # {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for
+    # `"gce_instance"` has labels
+    # `"project_id"`, `"instance_id"` and `"zone"`:
     #
     #     { "type": "gce_instance",
-    #       "labels": { "instance_id": "12345678901234",
+    #       "labels": { "project_id": "my-project",
+    #                   "instance_id": "12345678901234",
     #                   "zone": "us-central1-a" }}
     # @!attribute [rw] type
     #   @return [::String]
     #     Required. The monitored resource type. This field must match
-    #     the `type` field of a {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object. For
-    #     example, the type of a Compute Engine VM instance is `gce_instance`.
+    #     the `type` field of a
+    #     {::Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor}
+    #     object. For example, the type of a Compute Engine VM instance is
+    #     `gce_instance`. Some descriptors include the service name in the type; for
+    #     example, the type of a Datastream stream is
+    #     `datastream.googleapis.com/Stream`.
     # @!attribute [rw] labels
     #   @return [::Google::Protobuf::Map{::String => ::String}]
     #     Required. Values for all of the labels listed in the associated monitored
@@ -100,12 +112,12 @@ module Google
       end
     end
 
-    # 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. Monitoring and Logging use an ingestion
-    # pipeline to extract metadata for cloud resources of all types, and store
-    # the metadata in this message.
+    # 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. 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.

data/proto_docs/google/logging/type/http_request.rb

@@ -63,7 +63,7 @@ module Google
         #   @return [::String]
         #     The referer URL of the request, as defined in
         #     [HTTP/1.1 Header Field
-        #     Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+        #     Definitions](https://datatracker.ietf.org/doc/html/rfc2616#section-14.36).
         # @!attribute [rw] latency
         #   @return [::Google::Protobuf::Duration]
         #     The request processing latency on the server, from the time the request was