Package com.google.dataflow.v1beta3

Class DisplayData

  • All Implemented Interfaces:
    DisplayDataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DisplayData
extends com.google.protobuf.GeneratedMessageV3
implements DisplayDataOrBuilder
     Data provided with a pipeline or transform to provide descriptive info.
    Protobuf type google.dataflow.v1beta3.DisplayData
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DisplayData.Builder
      Data provided with a pipeline or transform to provide descriptive info.
      static class  DisplayData.ValueCase  

      • 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

    • 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()

      • internalGetFieldAccessorTable

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

      • getKey

        public String getKey()
         The key identifying the display data.
 This is intended to be used as a label for the display data
 when viewed in a dax monitoring system.
        string key = 1;
        Specified by:
        getKey in interface DisplayDataOrBuilder
        Returns:
        The key.

      • getKeyBytes

        public com.google.protobuf.ByteString getKeyBytes()
         The key identifying the display data.
 This is intended to be used as a label for the display data
 when viewed in a dax monitoring system.
        string key = 1;
        Specified by:
        getKeyBytes in interface DisplayDataOrBuilder
        Returns:
        The bytes for key.

      • getNamespace

        public String getNamespace()
         The namespace for the key. This is usually a class name or programming
 language namespace (i.e. python module) which defines the display data.
 This allows a dax monitoring system to specially handle the data
 and perform custom rendering.
        string namespace = 2;
        Specified by:
        getNamespace in interface DisplayDataOrBuilder
        Returns:
        The namespace.

      • getNamespaceBytes

        public com.google.protobuf.ByteString getNamespaceBytes()
         The namespace for the key. This is usually a class name or programming
 language namespace (i.e. python module) which defines the display data.
 This allows a dax monitoring system to specially handle the data
 and perform custom rendering.
        string namespace = 2;
        Specified by:
        getNamespaceBytes in interface DisplayDataOrBuilder
        Returns:
        The bytes for namespace.

      • hasStrValue

        public boolean hasStrValue()
         Contains value if the data is of string type.
        string str_value = 4;
        Specified by:
        hasStrValue in interface DisplayDataOrBuilder
        Returns:
        Whether the strValue field is set.

      • getStrValue

        public String getStrValue()
         Contains value if the data is of string type.
        string str_value = 4;
        Specified by:
        getStrValue in interface DisplayDataOrBuilder
        Returns:
        The strValue.

      • getStrValueBytes

        public com.google.protobuf.ByteString getStrValueBytes()
         Contains value if the data is of string type.
        string str_value = 4;
        Specified by:
        getStrValueBytes in interface DisplayDataOrBuilder
        Returns:
        The bytes for strValue.

      • hasInt64Value

        public boolean hasInt64Value()
         Contains value if the data is of int64 type.
        int64 int64_value = 5;
        Specified by:
        hasInt64Value in interface DisplayDataOrBuilder
        Returns:
        Whether the int64Value field is set.

      • getInt64Value

        public long getInt64Value()
         Contains value if the data is of int64 type.
        int64 int64_value = 5;
        Specified by:
        getInt64Value in interface DisplayDataOrBuilder
        Returns:
        The int64Value.

      • hasFloatValue

        public boolean hasFloatValue()
         Contains value if the data is of float type.
        float float_value = 6;
        Specified by:
        hasFloatValue in interface DisplayDataOrBuilder
        Returns:
        Whether the floatValue field is set.

      • getFloatValue

        public float getFloatValue()
         Contains value if the data is of float type.
        float float_value = 6;
        Specified by:
        getFloatValue in interface DisplayDataOrBuilder
        Returns:
        The floatValue.

      • hasJavaClassValue

        public boolean hasJavaClassValue()
         Contains value if the data is of java class type.
        string java_class_value = 7;
        Specified by:
        hasJavaClassValue in interface DisplayDataOrBuilder
        Returns:
        Whether the javaClassValue field is set.

      • getJavaClassValue

        public String getJavaClassValue()
         Contains value if the data is of java class type.
        string java_class_value = 7;
        Specified by:
        getJavaClassValue in interface DisplayDataOrBuilder
        Returns:
        The javaClassValue.

      • getJavaClassValueBytes

        public com.google.protobuf.ByteString getJavaClassValueBytes()
         Contains value if the data is of java class type.
        string java_class_value = 7;
        Specified by:
        getJavaClassValueBytes in interface DisplayDataOrBuilder
        Returns:
        The bytes for javaClassValue.

      • hasTimestampValue

        public boolean hasTimestampValue()
         Contains value if the data is of timestamp type.
        .google.protobuf.Timestamp timestamp_value = 8;
        Specified by:
        hasTimestampValue in interface DisplayDataOrBuilder
        Returns:
        Whether the timestampValue field is set.

      • getTimestampValue

        public com.google.protobuf.Timestamp getTimestampValue()
         Contains value if the data is of timestamp type.
        .google.protobuf.Timestamp timestamp_value = 8;
        Specified by:
        getTimestampValue in interface DisplayDataOrBuilder
        Returns:
        The timestampValue.

      • getTimestampValueOrBuilder

        public com.google.protobuf.TimestampOrBuilder getTimestampValueOrBuilder()
         Contains value if the data is of timestamp type.
        .google.protobuf.Timestamp timestamp_value = 8;
        Specified by:
        getTimestampValueOrBuilder in interface DisplayDataOrBuilder

      • hasDurationValue

        public boolean hasDurationValue()
         Contains value if the data is of duration type.
        .google.protobuf.Duration duration_value = 9;
        Specified by:
        hasDurationValue in interface DisplayDataOrBuilder
        Returns:
        Whether the durationValue field is set.

      • getDurationValue

        public com.google.protobuf.Duration getDurationValue()
         Contains value if the data is of duration type.
        .google.protobuf.Duration duration_value = 9;
        Specified by:
        getDurationValue in interface DisplayDataOrBuilder
        Returns:
        The durationValue.

      • getDurationValueOrBuilder

        public com.google.protobuf.DurationOrBuilder getDurationValueOrBuilder()
         Contains value if the data is of duration type.
        .google.protobuf.Duration duration_value = 9;
        Specified by:
        getDurationValueOrBuilder in interface DisplayDataOrBuilder

      • hasBoolValue

        public boolean hasBoolValue()
         Contains value if the data is of a boolean type.
        bool bool_value = 10;
        Specified by:
        hasBoolValue in interface DisplayDataOrBuilder
        Returns:
        Whether the boolValue field is set.

      • getBoolValue

        public boolean getBoolValue()
         Contains value if the data is of a boolean type.
        bool bool_value = 10;
        Specified by:
        getBoolValue in interface DisplayDataOrBuilder
        Returns:
        The boolValue.

      • getShortStrValue

        public String getShortStrValue()
         A possible additional shorter value to display.
 For example a java_class_name_value of com.mypackage.MyDoFn
 will be stored with MyDoFn as the short_str_value and
 com.mypackage.MyDoFn as the java_class_name value.
 short_str_value can be displayed and java_class_name_value
 will be displayed as a tooltip.
        string short_str_value = 11;
        Specified by:
        getShortStrValue in interface DisplayDataOrBuilder
        Returns:
        The shortStrValue.

      • getShortStrValueBytes

        public com.google.protobuf.ByteString getShortStrValueBytes()
         A possible additional shorter value to display.
 For example a java_class_name_value of com.mypackage.MyDoFn
 will be stored with MyDoFn as the short_str_value and
 com.mypackage.MyDoFn as the java_class_name value.
 short_str_value can be displayed and java_class_name_value
 will be displayed as a tooltip.
        string short_str_value = 11;
        Specified by:
        getShortStrValueBytes in interface DisplayDataOrBuilder
        Returns:
        The bytes for shortStrValue.

      • getUrlBytes

        public com.google.protobuf.ByteString getUrlBytes()
         An optional full URL.
        string url = 12;
        Specified by:
        getUrlBytes in interface DisplayDataOrBuilder
        Returns:
        The bytes for url.

      • getLabel

        public String getLabel()
         An optional label to display in a dax UI for the element.
        string label = 13;
        Specified by:
        getLabel in interface DisplayDataOrBuilder
        Returns:
        The label.

      • getLabelBytes

        public com.google.protobuf.ByteString getLabelBytes()
         An optional label to display in a dax UI for the element.
        string label = 13;
        Specified by:
        getLabelBytes in interface DisplayDataOrBuilder
        Returns:
        The bytes for label.

      • 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 DisplayData parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected DisplayData.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static DisplayData getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<DisplayData> 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 DisplayData getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder