Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1RuntimeTraceConfig

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

NEXT ID: 10 RuntimeTraceConfig defines the configurations for distributed trace in an environment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1RuntimeTraceConfig

Returns a new instance of GoogleCloudApigeeV1RuntimeTraceConfig.



10269
10270
10271
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10269

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

Instance Attribute Details

#endpoint ⇒ String

Endpoint of the exporter. Corresponds to the JSON property endpoint

Returns:

  • (String) 


10214
10215
10216
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10214

def endpoint
  @endpoint
end

#exporter ⇒ String

Exporter that is used to view the distributed trace captured using OpenCensus. 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) 


10221
10222
10223
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10221

def exporter
  @exporter
end

#name ⇒ String

Name of the trace config in the following format: organizations/org/ environment/env/traceConfig Corresponds to the JSON property name

Returns:

  • (String) 


10227
10228
10229
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10227

def name
  @name
end

#open_telemetry_protocol_enabled ⇒ Boolean Also known as: open_telemetry_protocol_enabled?

Optional. If true, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if open_telemetry_protocol_enabled is true): - 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 Deprecated: Use trace_protocol instead. Corresponds to the JSON property openTelemetryProtocolEnabled

Returns:

  • (Boolean) 


10237
10238
10239
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10237

def open_telemetry_protocol_enabled
  @open_telemetry_protocol_enabled
end

#overrides ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1RuntimeTraceConfigOverride>

List of trace configuration overrides for spicific API proxies. Corresponds to the JSON property overrides

Returns:



10243
10244
10245
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10243

def overrides
  @overrides
end

#revision_create_time ⇒ String

The timestamp that the revision was created or updated. Corresponds to the JSON property revisionCreateTime

Returns:

  • (String) 


10248
10249
10250
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10248

def revision_create_time
  @revision_create_time
end

#revision_id ⇒ String

Revision number which can be used by the runtime to detect if the trace config has changed between two versions. Corresponds to the JSON property revisionId

Returns:

  • (String) 


10254
10255
10256
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10254

def revision_id
  @revision_id
end

#sampling_config ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1RuntimeTraceSamplingConfig

NEXT ID: 3 RuntimeTraceSamplingConfig 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:



10262
10263
10264
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10262

def sampling_config
  @sampling_config
end

#trace_protocol ⇒ String

Optional. The trace protocol to use. Corresponds to the JSON property traceProtocol

Returns:

  • (String) 


10267
10268
10269
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10267

def trace_protocol
  @trace_protocol
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10274

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