Send feedback
  
   
 
  
    
      Class DisplayData (0.20.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 0.20.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  DisplayData   extends   GeneratedMessageV3   implements   DisplayDataOrBuilder  
   
   Data provided with a pipeline or transform to provide descriptive info.
 Protobuf type google.dataflow.v1beta3.DisplayData
 
  
  
  
  Static Fields
   
  BOOL_VALUE_FIELD_NUMBER 
  
    
public   static   final   int   BOOL_VALUE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  DURATION_VALUE_FIELD_NUMBER 
  
    
public   static   final   int   DURATION_VALUE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  FLOAT_VALUE_FIELD_NUMBER 
  
    
public   static   final   int   FLOAT_VALUE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  INT64_VALUE_FIELD_NUMBER 
  
    
public   static   final   int   INT64_VALUE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  JAVA_CLASS_VALUE_FIELD_NUMBER 
  
    
public   static   final   int   JAVA_CLASS_VALUE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  KEY_FIELD_NUMBER 
  
    
public   static   final   int   KEY_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  LABEL_FIELD_NUMBER 
  
    
public   static   final   int   LABEL_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  NAMESPACE_FIELD_NUMBER 
  
    
public   static   final   int   NAMESPACE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  SHORT_STR_VALUE_FIELD_NUMBER 
  
    
public   static   final   int   SHORT_STR_VALUE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  STR_VALUE_FIELD_NUMBER 
  
    
public   static   final   int   STR_VALUE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  TIMESTAMP_VALUE_FIELD_NUMBER 
  
    
public   static   final   int   TIMESTAMP_VALUE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  URL_FIELD_NUMBER 
  
    
public   static   final   int   URL_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   DisplayData   getDefaultInstance ()  
   
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
   
  newBuilder() 
  
    
public   static   DisplayData . Builder   newBuilder ()  
   
  
   
  newBuilder(DisplayData prototype) 
  
    
public   static   DisplayData . Builder   newBuilder ( DisplayData   prototype )  
   
  
  
   
  
  
    
public   static   DisplayData   parseDelimitedFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   DisplayData   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(byte[] data) 
  
    
public   static   DisplayData   parseFrom ( byte []   data )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   DisplayData   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteString data) 
  
    
public   static   DisplayData   parseFrom ( ByteString   data )  
   
  
  
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   DisplayData   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   DisplayData   parseFrom ( CodedInputStream   input )  
   
  
  
  
   
  
  
    
public   static   DisplayData   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   DisplayData   parseFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   DisplayData   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   DisplayData   parseFrom ( ByteBuffer   data )  
   
  
  
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   DisplayData   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parser() 
  
    
public   static   Parser<DisplayData>   parser ()  
   
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        obj 
        Object  
       
     
  
  
  Overrides 
  
   
  getBoolValue() 
  
    
public   boolean   getBoolValue ()  
   
   Contains value if the data is of a boolean type.
 bool bool_value = 10;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        The boolValue.
 
       
     
  
   
  getDefaultInstanceForType() 
  
    
public   DisplayData   getDefaultInstanceForType ()  
   
  
   
  getDurationValue() 
  
    
public   Duration   getDurationValue ()  
   
   Contains value if the data is of duration type.
 .google.protobuf.Duration duration_value = 9;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Duration  
        The durationValue.
 
       
     
  
   
  getDurationValueOrBuilder() 
  
    
public   DurationOrBuilder   getDurationValueOrBuilder ()  
   
   Contains value if the data is of duration type.
 .google.protobuf.Duration duration_value = 9;
 
  
   
  getFloatValue() 
  
    
public   float   getFloatValue ()  
   
   Contains value if the data is of float type.
 float float_value = 6;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        float  
        The floatValue.
 
       
     
  
   
  getInt64Value() 
  
    
public   long   getInt64Value ()  
   
   Contains value if the data is of int64 type.
 int64 int64_value = 5;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        long  
        The int64Value.
 
       
     
  
   
  getJavaClassValue() 
  
    
public   String   getJavaClassValue ()  
   
   Contains value if the data is of java class type.
 string java_class_value = 7;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The javaClassValue.
 
       
     
  
   
  getJavaClassValueBytes() 
  
    
public   ByteString   getJavaClassValueBytes ()  
   
   Contains value if the data is of java class type.
 string java_class_value = 7;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for javaClassValue.
 
       
     
  
   
  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;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The key.
 
       
     
  
   
  getKeyBytes() 
  
    
public   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;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for key.
 
       
     
  
   
  getLabel() 
  
   An optional label to display in a dax UI for the element.
 string label = 13;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The label.
 
       
     
  
   
  getLabelBytes() 
  
    
public   ByteString   getLabelBytes ()  
   
   An optional label to display in a dax UI for the element.
 string label = 13;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for label.
 
       
     
  
   
  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;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The namespace.
 
       
     
  
   
  getNamespaceBytes() 
  
    
public   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;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for namespace.
 
       
     
  
   
  getParserForType() 
  
    
public   Parser<DisplayData>   getParserForType ()  
   
  
  Overrides 
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  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;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The shortStrValue.
 
       
     
  
   
  getShortStrValueBytes() 
  
    
public   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;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for shortStrValue.
 
       
     
  
   
  getStrValue() 
  
    
public   String   getStrValue ()  
   
   Contains value if the data is of string type.
 string str_value = 4;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The strValue.
 
       
     
  
   
  getStrValueBytes() 
  
    
public   ByteString   getStrValueBytes ()  
   
   Contains value if the data is of string type.
 string str_value = 4;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for strValue.
 
       
     
  
   
  getTimestampValue() 
  
    
public   Timestamp   getTimestampValue ()  
   
   Contains value if the data is of timestamp type.
 .google.protobuf.Timestamp timestamp_value = 8;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Timestamp  
        The timestampValue.
 
       
     
  
   
  getTimestampValueOrBuilder() 
  
    
public   TimestampOrBuilder   getTimestampValueOrBuilder ()  
   
   Contains value if the data is of timestamp type.
 .google.protobuf.Timestamp timestamp_value = 8;
 
  
   
  getUnknownFields() 
  
    
public   final   UnknownFieldSet   getUnknownFields ()  
   
  
  Overrides 
  
   
  getUrl() 
  
   An optional full URL.
 string url = 12;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The url.
 
       
     
  
   
  getUrlBytes() 
  
    
public   ByteString   getUrlBytes ()  
   
   An optional full URL.
 string url = 12;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for url.
 
       
     
  
   
  getValueCase() 
  
    
public   DisplayData . ValueCase   getValueCase ()  
   
  
   
  hasBoolValue() 
  
    
public   boolean   hasBoolValue ()  
   
   Contains value if the data is of a boolean type.
 bool bool_value = 10;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the boolValue field is set.
 
       
     
  
   
  hasDurationValue() 
  
    
public   boolean   hasDurationValue ()  
   
   Contains value if the data is of duration type.
 .google.protobuf.Duration duration_value = 9;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the durationValue field is set.
 
       
     
  
   
  hasFloatValue() 
  
    
public   boolean   hasFloatValue ()  
   
   Contains value if the data is of float type.
 float float_value = 6;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the floatValue field is set.
 
       
     
  
   
  hasInt64Value() 
  
    
public   boolean   hasInt64Value ()  
   
   Contains value if the data is of int64 type.
 int64 int64_value = 5;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the int64Value field is set.
 
       
     
  
   
  hasJavaClassValue() 
  
    
public   boolean   hasJavaClassValue ()  
   
   Contains value if the data is of java class type.
 string java_class_value = 7;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the javaClassValue field is set.
 
       
     
  
   
  hasStrValue() 
  
    
public   boolean   hasStrValue ()  
   
   Contains value if the data is of string type.
 string str_value = 4;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the strValue field is set.
 
       
     
  
   
  hasTimestampValue() 
  
    
public   boolean   hasTimestampValue ()  
   
   Contains value if the data is of timestamp type.
 .google.protobuf.Timestamp timestamp_value = 8;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the timestampValue field is set.
 
       
     
  
   
  hashCode() 
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   DisplayData . Builder   newBuilderForType ()  
   
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   DisplayData . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Object  
         
       
     
  
  Overrides 
  
   
  toBuilder() 
  
    
public   DisplayData . Builder   toBuilder ()  
   
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-30 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]