Package com.google.dataflow.v1beta3

Class MetricStructuredName

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.dataflow.v1beta3.MetricStructuredName
All Implemented Interfaces:
MetricStructuredNameOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class MetricStructuredName extends com.google.protobuf.GeneratedMessage implements MetricStructuredNameOrBuilder
 Identifies a metric, by describing the source which generated the
 metric.
Protobuf type google.dataflow.v1beta3.MetricStructuredName
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MetricStructuredName.Builder
    Identifies a metric, by describing the source which generated the metric.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONTEXT_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    ORIGIN_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • 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.
    boolean
    equals(Object obj)
     
    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.
    static MetricStructuredName
    getDefaultInstance()
     
    MetricStructuredName
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<MetricStructuredName>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static MetricStructuredName.Builder
    newBuilder()
     
    static MetricStructuredName.Builder
    newBuilder(MetricStructuredName prototype)
     
    MetricStructuredName.Builder
    newBuilderForType()
     
    protected MetricStructuredName.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static MetricStructuredName
    parseDelimitedFrom(InputStream input)
     
    static MetricStructuredName
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetricStructuredName
    parseFrom(byte[] data)
     
    static MetricStructuredName
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetricStructuredName
    parseFrom(com.google.protobuf.ByteString data)
     
    static MetricStructuredName
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetricStructuredName
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MetricStructuredName
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetricStructuredName
    parseFrom(InputStream input)
     
    static MetricStructuredName
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetricStructuredName
    parseFrom(ByteBuffer data)
     
    static MetricStructuredName
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MetricStructuredName>
    parser()
     
    MetricStructuredName.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getOrigin

      public 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;
      Specified by:
      getOrigin in interface MetricStructuredNameOrBuilder
      Returns:
      The origin.

    • getOriginBytes

      public 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;
      Specified by:
      getOriginBytes in interface MetricStructuredNameOrBuilder
      Returns:
      The bytes for origin.

    • getName

      public String getName()
       Worker-defined metric name.
      string name = 2;
      Specified by:
      getName in interface MetricStructuredNameOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Worker-defined metric name.
      string name = 2;
      Specified by:
      getNameBytes in interface MetricStructuredNameOrBuilder
      Returns:
      The bytes for name.

    • getContextCount

      public int getContextCount()
      Description copied from interface: MetricStructuredNameOrBuilder
       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;
      Specified by:
      getContextCount in interface MetricStructuredNameOrBuilder

    • containsContext

      public 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;
      Specified by:
      containsContext in interface MetricStructuredNameOrBuilder

    • getContext

      @Deprecated public Map<String,String> getContext()
      Deprecated.
      Use getContextMap() instead.
      Specified by:
      getContext in interface MetricStructuredNameOrBuilder

    • getContextMap

      public 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;
      Specified by:
      getContextMap in interface MetricStructuredNameOrBuilder

    • getContextOrDefault

      public 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;
      Specified by:
      getContextOrDefault in interface MetricStructuredNameOrBuilder

    • getContextOrThrow

      public 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;
      Specified by:
      getContextOrThrow in interface MetricStructuredNameOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static MetricStructuredName parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetricStructuredName parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetricStructuredName parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetricStructuredName parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetricStructuredName parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetricStructuredName parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetricStructuredName parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MetricStructuredName parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MetricStructuredName parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MetricStructuredName parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MetricStructuredName parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MetricStructuredName parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public MetricStructuredName.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static MetricStructuredName.Builder newBuilder()

    • newBuilder

      public static MetricStructuredName.Builder newBuilder(MetricStructuredName prototype)

    • toBuilder

      public MetricStructuredName.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected MetricStructuredName.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static MetricStructuredName getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MetricStructuredName> parser()

    • getParserForType

      public com.google.protobuf.Parser<MetricStructuredName> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public MetricStructuredName getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder