Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Overview

TraceConfig defines the configurations in an environment of distributed trace.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1TraceConfig

Returns a new instance of GoogleCloudApigeeV1TraceConfig.



13099
13100
13101
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 13099

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#endpoint ⇒ String

Required. Endpoint of the exporter. Corresponds to the JSON property endpoint

Returns:

  • (String) 


13073
13074
13075
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 13073

def endpoint
  @endpoint
end

#exporter ⇒ String

Required. Exporter that is used to view the distributed trace captured using the chosen trace protocol. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. Corresponds to the JSON property exporter

Returns:

  • (String) 


13081
13082
13083
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 13081

def exporter
  @exporter
end

#sampling_config ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceSamplingConfig

TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. Corresponds to the JSON property samplingConfig

Returns:



13088
13089
13090
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 13088

def sampling_config
  @sampling_config
end

#trace_protocol ⇒ String

Optional. The trace protocol to use. Configuration Requirements (if trace_protocol is OTLP): - Allowed Exporters: CLOUD_TRACE or OPEN_TELEMETRY_COLLECTOR. - If Exporter is OPEN_TELEMETRY_COLLECTOR: - endpoint refers to a valid OTLP collector URL. - If Exporter is CLOUD_TRACE: - endpoint refers to a valid project ID. Corresponds to the JSON property traceProtocol

Returns:

  • (String) 


13097
13098
13099
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 13097

def trace_protocol
  @trace_protocol
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13104
13105
13106
13107
13108
13109
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 13104

def update!(**args)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @exporter = args[:exporter] if args.key?(:exporter)
  @sampling_config = args[:sampling_config] if args.key?(:sampling_config)
  @trace_protocol = args[:trace_protocol] if args.key?(:trace_protocol)
end