google-cloud-trace-v1 0.4.0 → 0.6.0

data/lib/google/cloud/trace/v1/trace_service/rest/service_stub.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "google/devtools/cloudtrace/v1/trace_pb"
+
+module Google
+  module Cloud
+    module Trace
+      module V1
+        module TraceService
+          module Rest
+            ##
+            # REST service stub for the TraceService service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              def initialize endpoint:, credentials:
+                # These require statements are intentionally placed here to initialize
+                # the REST modules only when it's required.
+                require "gapic/rest"
+
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                                                             numeric_enums: true,
+                                                             raise_faraday_errors: false
+              end
+
+              ##
+              # Baseline implementation for the list_traces REST call
+              #
+              # @param request_pb [::Google::Cloud::Trace::V1::ListTracesRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Trace::V1::ListTracesResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Trace::V1::ListTracesResponse]
+              #   A result object deserialized from the server's reply
+              def list_traces request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_list_traces_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Trace::V1::ListTracesResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the get_trace REST call
+              #
+              # @param request_pb [::Google::Cloud::Trace::V1::GetTraceRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Trace::V1::Trace]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Trace::V1::Trace]
+              #   A result object deserialized from the server's reply
+              def get_trace request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_get_trace_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Trace::V1::Trace.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the patch_traces REST call
+              #
+              # @param request_pb [::Google::Cloud::Trace::V1::PatchTracesRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Protobuf::Empty]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Protobuf::Empty]
+              #   A result object deserialized from the server's reply
+              def patch_traces request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_patch_traces_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the list_traces REST call
+              #
+              # @param request_pb [::Google::Cloud::Trace::V1::ListTracesRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_list_traces_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/projects/{project_id}/traces",
+                                                          matches: [
+                                                            ["project_id", %r{^[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the get_trace REST call
+              #
+              # @param request_pb [::Google::Cloud::Trace::V1::GetTraceRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_get_trace_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/projects/{project_id}/traces/{trace_id}",
+                                                          matches: [
+                                                            ["project_id", %r{^[^/]+/?$}, false],
+                                                            ["trace_id", %r{^[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the patch_traces REST call
+              #
+              # @param request_pb [::Google::Cloud::Trace::V1::PatchTracesRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_patch_traces_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :patch,
+                                                          uri_template: "/v1/projects/{project_id}/traces",
+                                                          body: "traces",
+                                                          matches: [
+                                                            ["project_id", %r{^[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/trace/v1/trace_service/rest.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/trace/v1/version"
+
+require "google/cloud/trace/v1/trace_service/credentials"
+require "google/cloud/trace/v1/trace_service/rest/client"
+
+module Google
+  module Cloud
+    module Trace
+      module V1
+        ##
+        # This file describes an API for collecting and viewing traces and spans
+        # within a trace.  A Trace is a collection of spans corresponding to a single
+        # operation or set of operations for an application. A span is an individual
+        # timed event which forms a node of the trace tree. Spans for a single trace
+        # may span multiple services.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/trace/v1/trace_service/rest"
+        #     client = ::Google::Cloud::Trace::V1::TraceService::Rest::Client.new
+        #
+        module TraceService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/trace/v1/trace_service/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/trace/v1/trace_service.rb

@@ -24,6 +24,7 @@ require "google/cloud/trace/v1/version"
 
 require "google/cloud/trace/v1/trace_service/credentials"
 require "google/cloud/trace/v1/trace_service/client"
+require "google/cloud/trace/v1/trace_service/rest"
 
 module Google
   module Cloud
@@ -36,11 +37,16 @@ module Google
         # timed event which forms a node of the trace tree. Spans for a single trace
         # may span multiple services.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/trace/v1/trace_service"
         #     client = ::Google::Cloud::Trace::V1::TraceService::Client.new
         #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/trace/v1/trace_service/rest"
+        #     client = ::Google::Cloud::Trace::V1::TraceService::Rest::Client.new
+        #
         module TraceService
         end
       end

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Trace
       module V1
-        VERSION = "0.4.0"
+        VERSION = "0.6.0"
       end
     end
   end

data/lib/google/cloud/trace/v1.rb

@@ -23,13 +23,18 @@ module Google
   module Cloud
     module Trace
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/trace/v1"
       #     client = ::Google::Cloud::Trace::V1::TraceService::Client.new
       #
+      # @example Load this package, including all its services, and instantiate a REST client
+      #
+      #     require "google/cloud/trace/v1"
+      #     client = ::Google::Cloud::Trace::V1::TraceService::Rest::Client.new
+      #
       module V1
       end
     end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/devtools/cloudtrace/v1/trace.proto
 
@@ -5,64 +6,36 @@ require 'google/protobuf'
 
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
-require 'google/api/resource_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/api/annotations_pb'
 
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("google/devtools/cloudtrace/v1/trace.proto", :syntax => :proto3) do
-    add_message "google.devtools.cloudtrace.v1.Trace" do
-      optional :project_id, :string, 1
-      optional :trace_id, :string, 2
-      repeated :spans, :message, 3, "google.devtools.cloudtrace.v1.TraceSpan"
-    end
-    add_message "google.devtools.cloudtrace.v1.Traces" do
-      repeated :traces, :message, 1, "google.devtools.cloudtrace.v1.Trace"
-    end
-    add_message "google.devtools.cloudtrace.v1.TraceSpan" do
-      optional :span_id, :fixed64, 1
-      optional :kind, :enum, 2, "google.devtools.cloudtrace.v1.TraceSpan.SpanKind"
-      optional :name, :string, 3
-      optional :start_time, :message, 4, "google.protobuf.Timestamp"
-      optional :end_time, :message, 5, "google.protobuf.Timestamp"
-      optional :parent_span_id, :fixed64, 6
-      map :labels, :string, :string, 7
-    end
-    add_enum "google.devtools.cloudtrace.v1.TraceSpan.SpanKind" do
-      value :SPAN_KIND_UNSPECIFIED, 0
-      value :RPC_SERVER, 1
-      value :RPC_CLIENT, 2
-    end
-    add_message "google.devtools.cloudtrace.v1.ListTracesRequest" do
-      optional :project_id, :string, 1
-      optional :view, :enum, 2, "google.devtools.cloudtrace.v1.ListTracesRequest.ViewType"
-      optional :page_size, :int32, 3
-      optional :page_token, :string, 4
-      optional :start_time, :message, 5, "google.protobuf.Timestamp"
-      optional :end_time, :message, 6, "google.protobuf.Timestamp"
-      optional :filter, :string, 7
-      optional :order_by, :string, 8
-    end
-    add_enum "google.devtools.cloudtrace.v1.ListTracesRequest.ViewType" do
-      value :VIEW_TYPE_UNSPECIFIED, 0
-      value :MINIMAL, 1
-      value :ROOTSPAN, 2
-      value :COMPLETE, 3
-    end
-    add_message "google.devtools.cloudtrace.v1.ListTracesResponse" do
-      repeated :traces, :message, 1, "google.devtools.cloudtrace.v1.Trace"
-      optional :next_page_token, :string, 2
-    end
-    add_message "google.devtools.cloudtrace.v1.GetTraceRequest" do
-      optional :project_id, :string, 1
-      optional :trace_id, :string, 2
-    end
-    add_message "google.devtools.cloudtrace.v1.PatchTracesRequest" do
-      optional :project_id, :string, 1
-      optional :traces, :message, 2, "google.devtools.cloudtrace.v1.Traces"
+
+descriptor_data = "\n)google/devtools/cloudtrace/v1/trace.proto\x12\x1dgoogle.devtools.cloudtrace.v1\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x1cgoogle/api/annotations.proto\"f\n\x05Trace\x12\x12\n\nproject_id\x18\x01 \x01(\t\x12\x10\n\x08trace_id\x18\x02 \x01(\t\x12\x37\n\x05spans\x18\x03 \x03(\x0b\x32(.google.devtools.cloudtrace.v1.TraceSpan\">\n\x06Traces\x12\x34\n\x06traces\x18\x01 \x03(\x0b\x32$.google.devtools.cloudtrace.v1.Trace\"\xa2\x03\n\tTraceSpan\x12\x0f\n\x07span_id\x18\x01 \x01(\x06\x12?\n\x04kind\x18\x02 \x01(\x0e\x32\x31.google.devtools.cloudtrace.v1.TraceSpan.SpanKind\x12\x0c\n\x04name\x18\x03 \x01(\t\x12.\n\nstart_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x1b\n\x0eparent_span_id\x18\x06 \x01(\x06\x42\x03\xe0\x41\x01\x12\x44\n\x06labels\x18\x07 \x03(\x0b\x32\x34.google.devtools.cloudtrace.v1.TraceSpan.LabelsEntry\x1a-\n\x0bLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"E\n\x08SpanKind\x12\x19\n\x15SPAN_KIND_UNSPECIFIED\x10\x00\x12\x0e\n\nRPC_SERVER\x10\x01\x12\x0e\n\nRPC_CLIENT\x10\x02\"\x80\x03\n\x11ListTracesRequest\x12\x17\n\nproject_id\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12L\n\x04view\x18\x02 \x01(\x0e\x32\x39.google.devtools.cloudtrace.v1.ListTracesRequest.ViewTypeB\x03\xe0\x41\x01\x12\x16\n\tpage_size\x18\x03 \x01(\x05\x42\x03\xe0\x41\x01\x12\x12\n\npage_token\x18\x04 \x01(\t\x12.\n\nstart_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x13\n\x06\x66ilter\x18\x07 \x01(\tB\x03\xe0\x41\x01\x12\x15\n\x08order_by\x18\x08 \x01(\tB\x03\xe0\x41\x01\"N\n\x08ViewType\x12\x19\n\x15VIEW_TYPE_UNSPECIFIED\x10\x00\x12\x0b\n\x07MINIMAL\x10\x01\x12\x0c\n\x08ROOTSPAN\x10\x02\x12\x0c\n\x08\x43OMPLETE\x10\x03\"c\n\x12ListTracesResponse\x12\x34\n\x06traces\x18\x01 \x03(\x0b\x32$.google.devtools.cloudtrace.v1.Trace\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"A\n\x0fGetTraceRequest\x12\x17\n\nproject_id\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x15\n\x08trace_id\x18\x02 \x01(\tB\x03\xe0\x41\x02\"i\n\x12PatchTracesRequest\x12\x17\n\nproject_id\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12:\n\x06traces\x18\x02 \x01(\x0b\x32%.google.devtools.cloudtrace.v1.TracesB\x03\xe0\x41\x02\x32\xb5\x05\n\x0cTraceService\x12\xa8\x01\n\nListTraces\x12\x30.google.devtools.cloudtrace.v1.ListTracesRequest\x1a\x31.google.devtools.cloudtrace.v1.ListTracesResponse\"5\x82\xd3\xe4\x93\x02\"\x12 /v1/projects/{project_id}/traces\xda\x41\nproject_id\x12\xab\x01\n\x08GetTrace\x12..google.devtools.cloudtrace.v1.GetTraceRequest\x1a$.google.devtools.cloudtrace.v1.Trace\"I\x82\xd3\xe4\x93\x02-\x12+/v1/projects/{project_id}/traces/{trace_id}\xda\x41\x13project_id,trace_id\x12\x9e\x01\n\x0bPatchTraces\x12\x31.google.devtools.cloudtrace.v1.PatchTracesRequest\x1a\x16.google.protobuf.Empty\"D\x82\xd3\xe4\x93\x02*2 /v1/projects/{project_id}/traces:\x06traces\xda\x41\x11project_id,traces\x1a\xaa\x01\xca\x41\x19\x63loudtrace.googleapis.com\xd2\x41\x8a\x01https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/trace.append,https://www.googleapis.com/auth/trace.readonlyB\xad\x01\n!com.google.devtools.cloudtrace.v1B\nTraceProtoP\x01Z/cloud.google.com/go/trace/apiv1/tracepb;tracepb\xaa\x02\x15Google.Cloud.Trace.V1\xca\x02\x15Google\\Cloud\\Trace\\V1\xea\x02\x18Google::Cloud::Trace::V1b\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError => e
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+    ["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
     end
   end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
 end
 
 module Google