Package com.google.dataflow.v1beta3

Interface MetricStructuredNameOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MetricStructuredName, MetricStructuredName.Builder
@Generated public interface MetricStructuredNameOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsContext(String key)
    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.
    Map<String,String>
    getContext()
    Deprecated.
    int
    getContextCount()
    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.
    Map<String,String>
    getContextMap()
    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.
    String
    getContextOrDefault(String key, String defaultValue)
    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.
    String
    getContextOrThrow(String key)
    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.
    String
    getName()
    Worker-defined metric name.
    com.google.protobuf.ByteString
    getNameBytes()
    Worker-defined metric name.
    String
    getOrigin()
    Origin (namespace) of metric name.
    com.google.protobuf.ByteString
    getOriginBytes()
    Origin (namespace) of metric name.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getOrigin

      String getOrigin()
       Origin (namespace) of metric name. May be blank for user-define metrics;
 will be "dataflow" for metrics defined by the Dataflow service or SDK.
      string origin = 1;
      Returns:
      The origin.

    • getOriginBytes

      com.google.protobuf.ByteString getOriginBytes()
       Origin (namespace) of metric name. May be blank for user-define metrics;
 will be "dataflow" for metrics defined by the Dataflow service or SDK.
      string origin = 1;
      Returns:
      The bytes for origin.

    • getName

      String getName()
       Worker-defined metric name.
      string name = 2;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Worker-defined metric name.
      string name = 2;
      Returns:
      The bytes for name.

    • getContextCount

      int getContextCount()
       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'] = <step-name>. Counters associated with PCollections
 in the SDK will have context['pcollection'] = <pcollection-name>.
      map<string, string> context = 3;

    • containsContext

      boolean containsContext(String key)
       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'] = <step-name>. Counters associated with PCollections
 in the SDK will have context['pcollection'] = <pcollection-name>.
      map<string, string> context = 3;

    • getContext

      @Deprecated Map<String,String> getContext()
      Deprecated.
      Use getContextMap() instead.

    • getContextMap

      Map<String,String> getContextMap()
       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'] = <step-name>. Counters associated with PCollections
 in the SDK will have context['pcollection'] = <pcollection-name>.
      map<string, string> context = 3;

    • getContextOrDefault

      String getContextOrDefault(String key, String defaultValue)
       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'] = <step-name>. Counters associated with PCollections
 in the SDK will have context['pcollection'] = <pcollection-name>.
      map<string, string> context = 3;

    • getContextOrThrow

      String getContextOrThrow(String key)
       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'] = <step-name>. Counters associated with PCollections
 in the SDK will have context['pcollection'] = <pcollection-name>.
      map<string, string> context = 3;