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
DURATION_VALUE_FIELD_NUMBER
public static final int DURATION_VALUE_FIELD_NUMBER
Field Value
FLOAT_VALUE_FIELD_NUMBER
public static final int FLOAT_VALUE_FIELD_NUMBER
Field Value
INT64_VALUE_FIELD_NUMBER
public static final int INT64_VALUE_FIELD_NUMBER
Field Value
JAVA_CLASS_VALUE_FIELD_NUMBER
public static final int JAVA_CLASS_VALUE_FIELD_NUMBER
Field Value
KEY_FIELD_NUMBER
public static final int KEY_FIELD_NUMBER
Field Value
LABEL_FIELD_NUMBER
public static final int LABEL_FIELD_NUMBER
Field Value
NAMESPACE_FIELD_NUMBER
public static final int NAMESPACE_FIELD_NUMBER
Field Value
SHORT_STR_VALUE_FIELD_NUMBER
public static final int SHORT_STR_VALUE_FIELD_NUMBER
Field Value
STR_VALUE_FIELD_NUMBER
public static final int STR_VALUE_FIELD_NUMBER
Field Value
TIMESTAMP_VALUE_FIELD_NUMBER
public static final int TIMESTAMP_VALUE_FIELD_NUMBER
Field Value
URL_FIELD_NUMBER
public static final int URL_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DisplayData getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DisplayData.Builder newBuilder()
Returns
newBuilder(DisplayData prototype)
public static DisplayData.Builder newBuilder(DisplayData prototype)
Parameter
Returns
public static DisplayData parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DisplayData parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DisplayData parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DisplayData parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DisplayData parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DisplayData parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DisplayData parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DisplayData parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DisplayData parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DisplayData parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DisplayData parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DisplayData parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DisplayData> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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()
Returns
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;
Returns
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
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
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
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
getParserForType()
public Parser<DisplayData> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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
getTimestampValue()
public Timestamp getTimestampValue()
Contains value if the data is of timestamp type.
.google.protobuf.Timestamp timestamp_value = 8;
Returns
getTimestampValueOrBuilder()
public TimestampOrBuilder getTimestampValueOrBuilder()
Contains value if the data is of timestamp type.
.google.protobuf.Timestamp timestamp_value = 8;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUrl()
An optional full URL.
string url = 12;
Returns
getUrlBytes()
public ByteString getUrlBytes()
An optional full URL.
string url = 12;
Returns
getValueCase()
public DisplayData.ValueCase getValueCase()
Returns
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DisplayData.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DisplayData.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DisplayData.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions