# Copyright 2017, Google Inc. All rights reserved.
#
# 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
#
#     http://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.
#
# EDITING INSTRUCTIONS
# This file was generated from the file
# https://github.com/googleapis/googleapis/blob/master/google/devtools/cloudtrace/v1/trace.proto,
# and updates to that file get reflected here through a refresh process.
# For the short term, the refresh process will only be runnable by Google
# engineers.
#
# The only allowed edits are to method and file documentation. A 3-way
# merge preserves those additions if the generated source changes.

require "json"
require "pathname"

require "google/gax"

require "google/devtools/cloudtrace/v1/trace_pb"

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.
        #
        # @!attribute [r] trace_service_stub
        #   @return [Google::Devtools::Cloudtrace::V1::TraceService::Stub]
        class TraceServiceClient
          attr_reader :trace_service_stub

          # The default address of the service.
          SERVICE_ADDRESS = "cloudtrace.googleapis.com".freeze

          # The default port of the service.
          DEFAULT_SERVICE_PORT = 443

          DEFAULT_TIMEOUT = 30

          PAGE_DESCRIPTORS = {
            "list_traces" => Google::Gax::PageDescriptor.new(
              "page_token",
              "next_page_token",
              "traces")
          }.freeze

          private_constant :PAGE_DESCRIPTORS

          # The scopes needed to make gRPC calls to all of the methods defined in
          # this service.
          ALL_SCOPES = [
            "https://www.googleapis.com/auth/cloud-platform",
            "https://www.googleapis.com/auth/trace.append",
            "https://www.googleapis.com/auth/trace.readonly"
          ].freeze

          # @param service_path [String]
          #   The domain name of the API remote host.
          # @param port [Integer]
          #   The port on which to connect to the remote host.
          # @param channel [Channel]
          #   A Channel object through which to make calls.
          # @param chan_creds [Grpc::ChannelCredentials]
          #   A ChannelCredentials for the setting up the RPC client.
          # @param client_config[Hash]
          #   A Hash for call options for each method. See
          #   Google::Gax#construct_settings for the structure of
          #   this data. Falls back to the default config if not specified
          #   or the specified config is missing data points.
          # @param timeout [Numeric]
          #   The default timeout, in seconds, for calls made through this client.
          def initialize \
              service_path: SERVICE_ADDRESS,
              port: DEFAULT_SERVICE_PORT,
              channel: nil,
              chan_creds: nil,
              scopes: ALL_SCOPES,
              client_config: {},
              timeout: DEFAULT_TIMEOUT,
              app_name: nil,
              app_version: nil,
              lib_name: nil,
              lib_version: ""
            # These require statements are intentionally placed here to initialize
            # the gRPC module only when it's required.
            # See https://github.com/googleapis/toolkit/issues/446
            require "google/gax/grpc"
            require "google/devtools/cloudtrace/v1/trace_services_pb"


            if app_name || app_version
              warn "`app_name` and `app_version` are no longer being used in the request headers."
            end

            google_api_client = "gl-ruby/#{RUBY_VERSION}"
            google_api_client << " #{lib_name}/#{lib_version}" if lib_name
            google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
            google_api_client << " grpc/#{GRPC::VERSION}"
            google_api_client.freeze

            headers = { :"x-goog-api-client" => google_api_client }
            client_config_file = Pathname.new(__dir__).join(
              "trace_service_client_config.json"
            )
            defaults = client_config_file.open do |f|
              Google::Gax.construct_settings(
                "google.devtools.cloudtrace.v1.TraceService",
                JSON.parse(f.read),
                client_config,
                Google::Gax::Grpc::STATUS_CODE_NAMES,
                timeout,
                page_descriptors: PAGE_DESCRIPTORS,
                errors: Google::Gax::Grpc::API_ERRORS,
                kwargs: headers
              )
            end
            @trace_service_stub = Google::Gax::Grpc.create_stub(
              service_path,
              port,
              chan_creds: chan_creds,
              channel: channel,
              scopes: scopes,
              &Google::Devtools::Cloudtrace::V1::TraceService::Stub.method(:new)
            )

            @patch_traces = Google::Gax.create_api_call(
              @trace_service_stub.method(:patch_traces),
              defaults["patch_traces"]
            )
            @get_trace = Google::Gax.create_api_call(
              @trace_service_stub.method(:get_trace),
              defaults["get_trace"]
            )
            @list_traces = Google::Gax.create_api_call(
              @trace_service_stub.method(:list_traces),
              defaults["list_traces"]
            )
          end

          # Service calls

          # Sends new traces to Stackdriver Trace or updates existing traces. If the ID
          # of a trace that you send matches that of an existing trace, any fields
          # in the existing trace and its spans are overwritten by the provided values,
          # and any new fields provided are merged with the existing trace data. If the
          # ID does not match, a new trace is created.
          #
          # @param project_id [String]
          #   ID of the Cloud project where the trace data is stored.
          # @param traces [Google::Devtools::Cloudtrace::V1::Traces]
          #   The body of the message.
          # @param options [Google::Gax::CallOptions]
          #   Overrides the default settings for this call, e.g, timeout,
          #   retries, etc.
          # @raise [Google::Gax::GaxError] if the RPC is aborted.
          # @example
          #   require "google/cloud/trace/v1/trace_service_client"
          #
          #   TraceServiceClient = Google::Cloud::Trace::V1::TraceServiceClient
          #   Traces = Google::Devtools::Cloudtrace::V1::Traces
          #
          #   trace_service_client = TraceServiceClient.new
          #   project_id = ''
          #   traces = Traces.new
          #   trace_service_client.patch_traces(project_id, traces)

          def patch_traces \
              project_id,
              traces,
              options: nil
            req = Google::Devtools::Cloudtrace::V1::PatchTracesRequest.new({
              project_id: project_id,
              traces: traces
            }.delete_if { |_, v| v.nil? })
            @patch_traces.call(req, options)
            nil
          end

          # Gets a single trace by its ID.
          #
          # @param project_id [String]
          #   ID of the Cloud project where the trace data is stored.
          # @param trace_id [String]
          #   ID of the trace to return.
          # @param options [Google::Gax::CallOptions]
          #   Overrides the default settings for this call, e.g, timeout,
          #   retries, etc.
          # @return [Google::Devtools::Cloudtrace::V1::Trace]
          # @raise [Google::Gax::GaxError] if the RPC is aborted.
          # @example
          #   require "google/cloud/trace/v1/trace_service_client"
          #
          #   TraceServiceClient = Google::Cloud::Trace::V1::TraceServiceClient
          #
          #   trace_service_client = TraceServiceClient.new
          #   project_id = ''
          #   trace_id = ''
          #   response = trace_service_client.get_trace(project_id, trace_id)

          def get_trace \
              project_id,
              trace_id,
              options: nil
            req = Google::Devtools::Cloudtrace::V1::GetTraceRequest.new({
              project_id: project_id,
              trace_id: trace_id
            }.delete_if { |_, v| v.nil? })
            @get_trace.call(req, options)
          end

          # Returns of a list of traces that match the specified filter conditions.
          #
          # @param project_id [String]
          #   ID of the Cloud project where the trace data is stored.
          # @param view [Google::Devtools::Cloudtrace::V1::ListTracesRequest::ViewType]
          #   Type of data returned for traces in the list. Optional. Default is
          #   +MINIMAL+.
          # @param page_size [Integer]
          #   Maximum number of traces to return. If not specified or <= 0, the
          #   implementation selects a reasonable value.  The implementation may
          #   return fewer traces than the requested page size. Optional.
          # @param start_time [Google::Protobuf::Timestamp]
          #   End of the time interval (inclusive) during which the trace data was
          #   collected from the application.
          # @param end_time [Google::Protobuf::Timestamp]
          #   Start of the time interval (inclusive) during which the trace data was
          #   collected from the application.
          # @param filter [String]
          #   An optional filter for the request.
          # @param order_by [String]
          #   Field used to sort the returned traces. Optional.
          #   Can be one of the following:
          #
          #   *   +trace_id+
          #   *   +name+ (+name+ field of root span in the trace)
          #   *   +duration+ (difference between +end_time+ and +start_time+ fields of
          #        the root span)
          #   *   +start+ (+start_time+ field of the root span)
          #
          #   Descending order can be specified by appending +desc+ to the sort field
          #   (for example, +name desc+).
          #
          #   Only one sort field is permitted.
          # @param options [Google::Gax::CallOptions]
          #   Overrides the default settings for this call, e.g, timeout,
          #   retries, etc.
          # @return [Google::Gax::PagedEnumerable<Google::Devtools::Cloudtrace::V1::Trace>]
          #   An enumerable of Google::Devtools::Cloudtrace::V1::Trace instances.
          #   See Google::Gax::PagedEnumerable documentation for other
          #   operations such as per-page iteration or access to the response
          #   object.
          # @raise [Google::Gax::GaxError] if the RPC is aborted.
          # @example
          #   require "google/cloud/trace/v1/trace_service_client"
          #
          #   TraceServiceClient = Google::Cloud::Trace::V1::TraceServiceClient
          #
          #   trace_service_client = TraceServiceClient.new
          #   project_id = ''
          #
          #   # Iterate over all results.
          #   trace_service_client.list_traces(project_id).each do |element|
          #     # Process element.
          #   end
          #
          #   # Or iterate over results one page at a time.
          #   trace_service_client.list_traces(project_id).each_page do |page|
          #     # Process each page at a time.
          #     page.each do |element|
          #       # Process element.
          #     end
          #   end

          def list_traces \
              project_id,
              view: nil,
              page_size: nil,
              start_time: nil,
              end_time: nil,
              filter: nil,
              order_by: nil,
              options: nil
            req = Google::Devtools::Cloudtrace::V1::ListTracesRequest.new({
              project_id: project_id,
              view: view,
              page_size: page_size,
              start_time: start_time,
              end_time: end_time,
              filter: filter,
              order_by: order_by
            }.delete_if { |_, v| v.nil? })
            @list_traces.call(req, options)
          end
        end
      end
    end
  end
end