google-cloud-trace-v2 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6864c9407d59ab77bd6e12afa32e436d06e8d3996e327ecc716837f0ba64faa
-  data.tar.gz: 8d6379ce949eaee4f8578c698e9a4898d09a7d5049d0f4f56fa92fa921a3c89c
+  metadata.gz: 224234399270f0ca8d189395f5e36fed65eccf9ab7cfea542780bc737652a152
+  data.tar.gz: 86b28088af0d023f61ace48c765cf92cb4516abbdaf06b6ec561862543bd2b46
 SHA512:
-  metadata.gz: 786a3640ac4b4ec0d350cb5ddaab450a7613a03ea5066658cf47e4f4fae35694740c008b3c7652b0c3d7d8c6535ef8a11e6a5415548814e004b6c24069e7b105
-  data.tar.gz: ecfaa554aa5c8490a163a6b2064fec2beedb8f2e1c38b3731bb7de25d1e3334a853fe455eec076c225b44f7ec4a0ae42ab0a9dc0ae465fac2393e9a45ce5f836
+  metadata.gz: 42efcdbc937b225e674bc52b899ea4666be905f5ce0eea5e13e233de5b8a15761c4aa1b0d4d818b6742ca66822373d4f527de62ee4deca0fd9a82d121e6d7c7d
+  data.tar.gz: 3d6d4b5c21fdda089a92ce63d60b7ca3c7428989deefabc609a37ced651a465c0e68bbbb9d12639aa31ab037735f195c5b83297f10d638b121c967061f646a4b

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-trace-v2
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Trace::V2::TraceService::Credentials}):
 
-1. `TRACE_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `TRACE_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `TRACE_CREDENTIALS` - Path to JSON file, or JSON contents
+* `TRACE_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/trace/v2"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Trace::V2::TraceService::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/trace/v2"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Trace::V2::TraceService::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/trace/v2"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/trace/v2"
 
 client = ::Google::Cloud::Trace::V2::TraceService::Client.new
-request = my_create_request
+request = ::Google::Cloud::Trace::V2::BatchWriteSpansRequest.new # (request fields as keyword arguments...)
 response = client.batch_write_spans request
 ```
 

data/lib/google/cloud/trace/v2/trace_service/client.rb

@@ -45,13 +45,12 @@ module Google
             # See {::Google::Cloud::Trace::V2::TraceService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all TraceService clients:
-            #
-            #     ::Google::Cloud::Trace::V2::TraceService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all TraceService clients
+            #   ::Google::Cloud::Trace::V2::TraceService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -73,10 +72,7 @@ module Google
 
                 default_config.rpcs.create_span.timeout = 120.0
                 default_config.rpcs.create_span.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 1.0,
-              multiplier: 1.2,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 1.0, multiplier: 1.2, retry_codes: [14, 4]
                 }
 
                 default_config
@@ -108,19 +104,15 @@ module Google
             ##
             # Create a new TraceService client object.
             #
-            # ## Examples
-            #
-            # To create a new TraceService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Trace::V2::TraceService::Client.new
+            # @example
             #
-            # To create a new TraceService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Trace::V2::TraceService::Client.new
             #
-            #     client = ::Google::Cloud::Trace::V2::TraceService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Trace::V2::TraceService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the TraceService client.
             # @yieldparam config [Client::Configuration]
@@ -140,14 +132,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
@@ -198,6 +189,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/trace/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Trace::V2::TraceService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Trace::V2::BatchWriteSpansRequest.new
+            #
+            #   # Call the batch_write_spans method.
+            #   result = client.batch_write_spans request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def batch_write_spans request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -215,16 +221,20 @@ module Google
                 gapic_version: ::Google::Cloud::Trace::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.batch_write_spans.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.batch_write_spans.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @trace_service_stub.call_rpc :batch_write_spans, request, options: options do |response, operation|
@@ -317,6 +327,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/trace/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Trace::V2::TraceService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Trace::V2::Span.new
+            #
+            #   # Call the create_span method.
+            #   result = client.create_span request
+            #
+            #   # The returned object is of type Google::Cloud::Trace::V2::Span.
+            #   p result
+            #
             def create_span request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -334,16 +359,20 @@ module Google
                 gapic_version: ::Google::Cloud::Trace::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.create_span.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_span.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @trace_service_stub.call_rpc :create_span, request, options: options do |response, operation|
@@ -367,22 +396,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 batch_write_spans
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Trace::V2::TraceService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.batch_write_spans.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Trace::V2::TraceService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.batch_write_spans.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # batch_write_spans to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Trace::V2::TraceService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.batch_write_spans.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Trace::V2::TraceService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.batch_write_spans.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Trace
       module V2
-        VERSION = "0.3.0"
+        VERSION = "0.3.4"
       end
     end
   end

data/lib/google/devtools/cloudtrace/v2/trace_pb.rb

@@ -1,14 +1,14 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/devtools/cloudtrace/v2/trace.proto
 
-require 'google/protobuf'
-
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
 require 'google/rpc/status_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/devtools/cloudtrace/v2/trace.proto", :syntax => :proto3) do
     add_message "google.devtools.cloudtrace.v2.Span" do

data/lib/google/devtools/cloudtrace/v2/tracing_pb.rb

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

data/lib/google/devtools/cloudtrace/v2/tracing_services_pb.rb

@@ -31,7 +31,7 @@ module Google
           # contain span(s) from multiple services.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

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

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-trace-v2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Trace V2 API