Class MetricStructuredName

  • All Implemented Interfaces:
    MetricStructuredNameOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class MetricStructuredName
    extends com.google.protobuf.GeneratedMessageV3
    implements MetricStructuredNameOrBuilder
     Identifies a metric, by describing the source which generated the
     metric.
     
    Protobuf type google.dataflow.v1beta3.MetricStructuredName
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MetricStructuredName.Builder
      Identifies a metric, by describing the source which generated the metric.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int CONTEXT_FIELD_NUMBER  
      static int NAME_FIELD_NUMBER  
      static int ORIGIN_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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.
      • 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
      • 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.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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
      • newBuilderForType

        public MetricStructuredName.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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