google-cloud-logging-v2 0.5.1 → 0.5.5

data/lib/google/cloud/logging/v2/metrics_service/client.rb

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::Logging::V2::MetricsService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all MetricsService clients:
-            #
-            #     ::Google::Cloud::Logging::V2::MetricsService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all MetricsService clients
+            #   ::Google::Cloud::Logging::V2::MetricsService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -67,36 +66,24 @@ module Google
 
                 default_config.rpcs.list_log_metrics.timeout = 60.0
                 default_config.rpcs.list_log_metrics.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.get_log_metric.timeout = 60.0
                 default_config.rpcs.get_log_metric.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.create_log_metric.timeout = 60.0
 
                 default_config.rpcs.update_log_metric.timeout = 60.0
                 default_config.rpcs.update_log_metric.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.delete_log_metric.timeout = 60.0
                 default_config.rpcs.delete_log_metric.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config
@@ -128,19 +115,15 @@ module Google
             ##
             # Create a new MetricsService client object.
             #
-            # ## Examples
-            #
-            # To create a new MetricsService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Logging::V2::MetricsService::Client.new
+            # @example
             #
-            # To create a new MetricsService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Logging::V2::MetricsService::Client.new
             #
-            #     client = ::Google::Cloud::Logging::V2::MetricsService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Logging::V2::MetricsService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the MetricsService client.
             # @yieldparam config [Client::Configuration]
@@ -160,14 +143,13 @@ 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
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -224,6 +206,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::MetricsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::ListLogMetricsRequest.new
+            #
+            #   # Call the list_log_metrics method.
+            #   result = client.list_log_metrics request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Logging::V2::LogMetric.
+            #     p response
+            #   end
+            #
             def list_log_metrics request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -241,16 +244,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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.list_log_metrics.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_log_metrics.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metrics_service_stub.call_rpc :list_log_metrics, request, options: options do |response, operation|
@@ -293,6 +300,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::MetricsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::GetLogMetricRequest.new
+            #
+            #   # Call the get_log_metric method.
+            #   result = client.get_log_metric request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogMetric.
+            #   p result
+            #
             def get_log_metric request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -310,16 +332,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "metric_name" => request.metric_name
-              }
+              header_params = {}
+              if request.metric_name
+                header_params["metric_name"] = request.metric_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.get_log_metric.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_log_metric.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metrics_service_stub.call_rpc :get_log_metric, request, options: options do |response, operation|
@@ -366,6 +392,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::MetricsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::CreateLogMetricRequest.new
+            #
+            #   # Call the create_log_metric method.
+            #   result = client.create_log_metric request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogMetric.
+            #   p result
+            #
             def create_log_metric request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -383,16 +424,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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.create_log_metric.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_log_metric.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metrics_service_stub.call_rpc :create_log_metric, request, options: options do |response, operation|
@@ -440,6 +485,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::MetricsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::UpdateLogMetricRequest.new
+            #
+            #   # Call the update_log_metric method.
+            #   result = client.update_log_metric request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogMetric.
+            #   p result
+            #
             def update_log_metric request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -457,16 +517,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "metric_name" => request.metric_name
-              }
+              header_params = {}
+              if request.metric_name
+                header_params["metric_name"] = request.metric_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.update_log_metric.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_log_metric.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metrics_service_stub.call_rpc :update_log_metric, request, options: options do |response, operation|
@@ -508,6 +572,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::MetricsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::DeleteLogMetricRequest.new
+            #
+            #   # Call the delete_log_metric method.
+            #   result = client.delete_log_metric request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_log_metric request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -525,16 +604,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "metric_name" => request.metric_name
-              }
+              header_params = {}
+              if request.metric_name
+                header_params["metric_name"] = request.metric_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.delete_log_metric.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_log_metric.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metrics_service_stub.call_rpc :delete_log_metric, request, options: options do |response, operation|
@@ -558,22 +641,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 list_log_metrics
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Logging::V2::MetricsService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_log_metrics.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Logging::V2::MetricsService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_log_metrics.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_log_metrics to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Logging::V2::MetricsService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_log_metrics.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Logging::V2::MetricsService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_log_metrics.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/logging/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Logging
       module V2
-        VERSION = "0.5.1"
+        VERSION = "0.5.5"
       end
     end
   end

data/lib/google/logging/v2/log_entry_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/logging/v2/log_entry.proto
 
-require 'google/protobuf'
-
 require 'google/api/field_behavior_pb'
 require 'google/api/monitored_resource_pb'
 require 'google/api/resource_pb'
@@ -13,6 +11,8 @@ require 'google/protobuf/struct_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/logging/v2/log_entry.proto", :syntax => :proto3) do
     add_message "google.logging.v2.LogEntry" do

data/lib/google/logging/v2/logging_config_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/logging/v2/logging_config.proto
 
-require 'google/protobuf'
-
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
@@ -11,6 +9,8 @@ require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/logging/v2/logging_config.proto", :syntax => :proto3) do
     add_message "google.logging.v2.LogBucket" do

data/lib/google/logging/v2/logging_metrics_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/logging/v2/logging_metrics.proto
 
-require 'google/protobuf'
-
 require 'google/api/client_pb'
 require 'google/api/distribution_pb'
 require 'google/api/field_behavior_pb'
@@ -13,6 +11,8 @@ require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/logging/v2/logging_metrics.proto", :syntax => :proto3) do
     add_message "google.logging.v2.LogMetric" do

data/lib/google/logging/v2/logging_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/logging/v2/logging.proto
 
-require 'google/protobuf'
-
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/monitored_resource_pb'
@@ -15,6 +13,8 @@ require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/logging/v2/logging.proto", :syntax => :proto3) do
     add_message "google.logging.v2.DeleteLogRequest" do

data/proto_docs/google/api/distribution.rb

@@ -49,7 +49,7 @@ module Google
     #
     #         Sum[i=1..n]((x_i - mean)^2)
     #
-    #     Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
+    #     Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition
     #     describes Welford's method for accumulating this sum in one pass.
     #
     #     If `count` is zero then this field must be zero.
@@ -207,7 +207,7 @@ module Google
       #   @return [::Array<::Google::Protobuf::Any>]
       #     Contextual information about the example value. Examples are:
       #
-      #       Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace
+      #       Trace: type.googleapis.com/google.monitoring.v3.SpanContext
       #
       #       Literal string: type.googleapis.com/google.protobuf.StringValue
       #

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