Class: Google::Cloud::Dataflow::V1beta3::MetricStructuredName

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/dataflow/v1beta3/metrics.rb

Overview

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

Defined Under Namespace

Classes: ContextEntry

Instance Attribute Summary collapse

Instance Attribute Details

#context ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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'] = .

Returns:

  • (::Google::Protobuf::Map{::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'] = .



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 41

class MetricStructuredName
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ContextEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Worker-defined metric name.

Returns:

  • (::String) —

    Worker-defined metric name.



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 41

class MetricStructuredName
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ContextEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#origin ⇒ ::String

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

Returns:

  • (::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.



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'proto_docs/google/dataflow/v1beta3/metrics.rb', line 41

class MetricStructuredName
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ContextEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end