Class DisplayData.Builder (0.47.0) 

public static final class DisplayData.Builder extends GeneratedMessageV3.Builder<DisplayData.Builder> implements DisplayDataOrBuilder

Data provided with a pipeline or transform to provide descriptive info.

Protobuf type google.dataflow.v1beta3.DisplayData

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DisplayData.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DisplayData.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DisplayData.Builder
Overrides

build()

public DisplayData build()
Returns
Type Description
DisplayData

buildPartial()

public DisplayData buildPartial()
Returns
Type Description
DisplayData

clear()

public DisplayData.Builder clear()
Returns
Type Description
DisplayData.Builder
Overrides

clearBoolValue()

public DisplayData.Builder clearBoolValue()

Contains value if the data is of a boolean type.

bool bool_value = 10;

Returns
Type Description
DisplayData.Builder

This builder for chaining.

clearDurationValue()

public DisplayData.Builder clearDurationValue()

Contains value if the data is of duration type.

.google.protobuf.Duration duration_value = 9;

Returns
Type Description
DisplayData.Builder

clearField(Descriptors.FieldDescriptor field)

public DisplayData.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DisplayData.Builder
Overrides

clearFloatValue()

public DisplayData.Builder clearFloatValue()

Contains value if the data is of float type.

float float_value = 6;

Returns
Type Description
DisplayData.Builder

This builder for chaining.

clearInt64Value()

public DisplayData.Builder clearInt64Value()

Contains value if the data is of int64 type.

int64 int64_value = 5;

Returns
Type Description
DisplayData.Builder

This builder for chaining.

clearJavaClassValue()

public DisplayData.Builder clearJavaClassValue()

Contains value if the data is of java class type.

string java_class_value = 7;

Returns
Type Description
DisplayData.Builder

This builder for chaining.

clearKey()

public DisplayData.Builder clearKey()

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
DisplayData.Builder

This builder for chaining.

clearLabel()

public DisplayData.Builder clearLabel()

An optional label to display in a dax UI for the element.

string label = 13;

Returns
Type Description
DisplayData.Builder

This builder for chaining.

clearNamespace()

public DisplayData.Builder clearNamespace()

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
DisplayData.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DisplayData.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DisplayData.Builder
Overrides

clearShortStrValue()

public DisplayData.Builder clearShortStrValue()

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
DisplayData.Builder

This builder for chaining.

clearStrValue()

public DisplayData.Builder clearStrValue()

Contains value if the data is of string type.

string str_value = 4;

Returns
Type Description
DisplayData.Builder

This builder for chaining.

clearTimestampValue()

public DisplayData.Builder clearTimestampValue()

Contains value if the data is of timestamp type.

.google.protobuf.Timestamp timestamp_value = 8;

Returns
Type Description
DisplayData.Builder

clearUrl()

public DisplayData.Builder clearUrl()

An optional full URL.

string url = 12;

Returns
Type Description
DisplayData.Builder

This builder for chaining.

clearValue()

public DisplayData.Builder clearValue()
Returns
Type Description
DisplayData.Builder

clone()

public DisplayData.Builder clone()
Returns
Type Description
DisplayData.Builder
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
Type Description
DisplayData

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getDurationValueBuilder()

public Duration.Builder getDurationValueBuilder()

Contains value if the data is of duration type.

.google.protobuf.Duration duration_value = 9;

Returns
Type Description
Builder

getDurationValueOrBuilder()

public DurationOrBuilder getDurationValueOrBuilder()

Contains value if the data is of duration type.

.google.protobuf.Duration duration_value = 9;

Returns
Type Description
DurationOrBuilder

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

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;

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

public String 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.

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.

getTimestampValueBuilder()

public Timestamp.Builder getTimestampValueBuilder()

Contains value if the data is of timestamp type.

.google.protobuf.Timestamp timestamp_value = 8;

Returns
Type Description
Builder

getTimestampValueOrBuilder()

public TimestampOrBuilder getTimestampValueOrBuilder()

Contains value if the data is of timestamp type.

.google.protobuf.Timestamp timestamp_value = 8;

Returns
Type Description
TimestampOrBuilder

getUrl()

public String 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()
Returns
Type Description
DisplayData.ValueCase

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDurationValue(Duration value)

public DisplayData.Builder mergeDurationValue(Duration value)

Contains value if the data is of duration type.

.google.protobuf.Duration duration_value = 9;

Parameter
Name Description
value Duration
Returns
Type Description
DisplayData.Builder

mergeFrom(DisplayData other)

public DisplayData.Builder mergeFrom(DisplayData other)
Parameter
Name Description
other DisplayData
Returns
Type Description
DisplayData.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DisplayData.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DisplayData.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DisplayData.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DisplayData.Builder
Overrides

mergeTimestampValue(Timestamp value)

public DisplayData.Builder mergeTimestampValue(Timestamp value)

Contains value if the data is of timestamp type.

.google.protobuf.Timestamp timestamp_value = 8;

Parameter
Name Description
value Timestamp
Returns
Type Description
DisplayData.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DisplayData.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DisplayData.Builder
Overrides

setBoolValue(boolean value)

public DisplayData.Builder setBoolValue(boolean value)

Contains value if the data is of a boolean type.

bool bool_value = 10;

Parameter
Name Description
value boolean

The boolValue to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setDurationValue(Duration value)

public DisplayData.Builder setDurationValue(Duration value)

Contains value if the data is of duration type.

.google.protobuf.Duration duration_value = 9;

Parameter
Name Description
value Duration
Returns
Type Description
DisplayData.Builder

setDurationValue(Duration.Builder builderForValue)

public DisplayData.Builder setDurationValue(Duration.Builder builderForValue)

Contains value if the data is of duration type.

.google.protobuf.Duration duration_value = 9;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DisplayData.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DisplayData.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DisplayData.Builder
Overrides

setFloatValue(float value)

public DisplayData.Builder setFloatValue(float value)

Contains value if the data is of float type.

float float_value = 6;

Parameter
Name Description
value float

The floatValue to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setInt64Value(long value)

public DisplayData.Builder setInt64Value(long value)

Contains value if the data is of int64 type.

int64 int64_value = 5;

Parameter
Name Description
value long

The int64Value to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setJavaClassValue(String value)

public DisplayData.Builder setJavaClassValue(String value)

Contains value if the data is of java class type.

string java_class_value = 7;

Parameter
Name Description
value String

The javaClassValue to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setJavaClassValueBytes(ByteString value)

public DisplayData.Builder setJavaClassValueBytes(ByteString value)

Contains value if the data is of java class type.

string java_class_value = 7;

Parameter
Name Description
value ByteString

The bytes for javaClassValue to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setKey(String value)

public DisplayData.Builder setKey(String value)

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;

Parameter
Name Description
value String

The key to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setKeyBytes(ByteString value)

public DisplayData.Builder setKeyBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for key to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setLabel(String value)

public DisplayData.Builder setLabel(String value)

An optional label to display in a dax UI for the element.

string label = 13;

Parameter
Name Description
value String

The label to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setLabelBytes(ByteString value)

public DisplayData.Builder setLabelBytes(ByteString value)

An optional label to display in a dax UI for the element.

string label = 13;

Parameter
Name Description
value ByteString

The bytes for label to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setNamespace(String value)

public DisplayData.Builder setNamespace(String value)

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;

Parameter
Name Description
value String

The namespace to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setNamespaceBytes(ByteString value)

public DisplayData.Builder setNamespaceBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for namespace to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DisplayData.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DisplayData.Builder
Overrides

setShortStrValue(String value)

public DisplayData.Builder setShortStrValue(String value)

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;

Parameter
Name Description
value String

The shortStrValue to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setShortStrValueBytes(ByteString value)

public DisplayData.Builder setShortStrValueBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for shortStrValue to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setStrValue(String value)

public DisplayData.Builder setStrValue(String value)

Contains value if the data is of string type.

string str_value = 4;

Parameter
Name Description
value String

The strValue to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setStrValueBytes(ByteString value)

public DisplayData.Builder setStrValueBytes(ByteString value)

Contains value if the data is of string type.

string str_value = 4;

Parameter
Name Description
value ByteString

The bytes for strValue to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setTimestampValue(Timestamp value)

public DisplayData.Builder setTimestampValue(Timestamp value)

Contains value if the data is of timestamp type.

.google.protobuf.Timestamp timestamp_value = 8;

Parameter
Name Description
value Timestamp
Returns
Type Description
DisplayData.Builder

setTimestampValue(Timestamp.Builder builderForValue)

public DisplayData.Builder setTimestampValue(Timestamp.Builder builderForValue)

Contains value if the data is of timestamp type.

.google.protobuf.Timestamp timestamp_value = 8;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DisplayData.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DisplayData.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DisplayData.Builder
Overrides

setUrl(String value)

public DisplayData.Builder setUrl(String value)

An optional full URL.

string url = 12;

Parameter
Name Description
value String

The url to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.

setUrlBytes(ByteString value)

public DisplayData.Builder setUrlBytes(ByteString value)

An optional full URL.

string url = 12;

Parameter
Name Description
value ByteString

The bytes for url to set.
Returns
Type Description
DisplayData.Builder

This builder for chaining.