Class: Google::Apis::DataflowV1b3::MetricStructuredName

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

Overview

Identifies a metric, by describing the source which generated the metric.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ MetricStructuredName

Returns a new instance of MetricStructuredName.



2640
2641
2642
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2640

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

Instance Attribute Details

#context ⇒ Hash<String,String>

Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] = . Corresponds to the JSON property context

Returns:

  • (Hash<String,String>) 


2627
2628
2629
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2627

def context
  @context
end

#name ⇒ String

Worker-defined metric name. Corresponds to the JSON property name

Returns:

  • (String) 


2632
2633
2634
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2632

def name
  @name
end

#origin ⇒ String

Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK. Corresponds to the JSON property origin

Returns:

  • (String) 


2638
2639
2640
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2638

def origin
  @origin
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2645
2646
2647
2648
2649
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2645

def update!(**args)
  @context = args[:context] if args.key?(:context)
  @name = args[:name] if args.key?(:name)
  @origin = args[:origin] if args.key?(:origin)
end