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.


1125
1126
1127
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1125

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

Instance Attribute Details

#contextHash<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>)

1123
1124
1125
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1123

def context
  @context
end

#nameString

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

Returns:

  • (String)

1114
1115
1116
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1114

def name
  @name
end

#originString

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)

1109
1110
1111
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1109

def origin
  @origin
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1130
1131
1132
1133
1134
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1130

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