Package com.google.dataflow.v1beta3

Class DisplayData

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.dataflow.v1beta3.DisplayData

All Implemented Interfaces:

DisplayDataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class DisplayData
extends com.google.protobuf.GeneratedMessage
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 final class	DisplayData.Builder	Data provided with a pipeline or transform to provide descriptive info.
static enum	DisplayData.ValueCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BOOL_VALUE_FIELD_NUMBER
static final int	DURATION_VALUE_FIELD_NUMBER
static final int	FLOAT_VALUE_FIELD_NUMBER
static final int	INT64_VALUE_FIELD_NUMBER
static final int	JAVA_CLASS_VALUE_FIELD_NUMBER
static final int	KEY_FIELD_NUMBER
static final int	LABEL_FIELD_NUMBER
static final int	NAMESPACE_FIELD_NUMBER
static final int	SHORT_STR_VALUE_FIELD_NUMBER
static final int	STR_VALUE_FIELD_NUMBER
static final int	TIMESTAMP_VALUE_FIELD_NUMBER
static final int	URL_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	getBoolValue()	Contains value if the data is of a boolean type.
static DisplayData	getDefaultInstance()
DisplayData	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Duration	getDurationValue()	Contains value if the data is of duration type.
com.google.protobuf.DurationOrBuilder	getDurationValueOrBuilder()	Contains value if the data is of duration type.
float	getFloatValue()	Contains value if the data is of float type.
long	getInt64Value()	Contains value if the data is of int64 type.
String	getJavaClassValue()	Contains value if the data is of java class type.
com.google.protobuf.ByteString	getJavaClassValueBytes()	Contains value if the data is of java class type.
String	getKey()	The key identifying the display data.
com.google.protobuf.ByteString	getKeyBytes()	The key identifying the display data.
String	getLabel()	An optional label to display in a dax UI for the element.
com.google.protobuf.ByteString	getLabelBytes()	An optional label to display in a dax UI for the element.
String	getNamespace()	The namespace for the key.
com.google.protobuf.ByteString	getNamespaceBytes()	The namespace for the key.
com.google.protobuf.Parser<DisplayData>	getParserForType()
int	getSerializedSize()
String	getShortStrValue()	A possible additional shorter value to display.
com.google.protobuf.ByteString	getShortStrValueBytes()	A possible additional shorter value to display.
String	getStrValue()	Contains value if the data is of string type.
com.google.protobuf.ByteString	getStrValueBytes()	Contains value if the data is of string type.
com.google.protobuf.Timestamp	getTimestampValue()	Contains value if the data is of timestamp type.
com.google.protobuf.TimestampOrBuilder	getTimestampValueOrBuilder()	Contains value if the data is of timestamp type.
String	getUrl()	An optional full URL.
com.google.protobuf.ByteString	getUrlBytes()	An optional full URL.
DisplayData.ValueCase	getValueCase()
boolean	hasBoolValue()	Contains value if the data is of a boolean type.
boolean	hasDurationValue()	Contains value if the data is of duration type.
boolean	hasFloatValue()	Contains value if the data is of float type.
int	hashCode()
boolean	hasInt64Value()	Contains value if the data is of int64 type.
boolean	hasJavaClassValue()	Contains value if the data is of java class type.
boolean	hasStrValue()	Contains value if the data is of string type.
boolean	hasTimestampValue()	Contains value if the data is of timestamp type.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static DisplayData.Builder	newBuilder()
static DisplayData.Builder	newBuilder(DisplayData prototype)
DisplayData.Builder	newBuilderForType()
protected DisplayData.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static DisplayData	parseDelimitedFrom(InputStream input)
static DisplayData	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DisplayData	parseFrom(byte[] data)
static DisplayData	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DisplayData	parseFrom(com.google.protobuf.ByteString data)
static DisplayData	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DisplayData	parseFrom(com.google.protobuf.CodedInputStream input)
static DisplayData	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DisplayData	parseFrom(InputStream input)
static DisplayData	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DisplayData	parseFrom(ByteBuffer data)
static DisplayData	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DisplayData>	parser()
DisplayData.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER

See Also:

• Constant Field Values

NAMESPACE_FIELD_NUMBER

public static final int NAMESPACE_FIELD_NUMBER

See Also:

• Constant Field Values

STR_VALUE_FIELD_NUMBER

public static final int STR_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

INT64_VALUE_FIELD_NUMBER

public static final int INT64_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

FLOAT_VALUE_FIELD_NUMBER

public static final int FLOAT_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

JAVA_CLASS_VALUE_FIELD_NUMBER

public static final int JAVA_CLASS_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

TIMESTAMP_VALUE_FIELD_NUMBER

public static final int TIMESTAMP_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

DURATION_VALUE_FIELD_NUMBER

public static final int DURATION_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

BOOL_VALUE_FIELD_NUMBER

public static final int BOOL_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

SHORT_STR_VALUE_FIELD_NUMBER

public static final int SHORT_STR_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

URL_FIELD_NUMBER

public static final int URL_FIELD_NUMBER

See Also:

• Constant Field Values

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getValueCase

public DisplayData.ValueCase getValueCase()

Specified by:

getValueCase in interface DisplayDataOrBuilder

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.

getUrl

public String getUrl()

 An optional full URL.
 

string url = 12;

Specified by:

getUrl in interface DisplayDataOrBuilder

Returns:

The url.

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.GeneratedMessage

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.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static DisplayData parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static DisplayData parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static DisplayData parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseFrom

public static DisplayData parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

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

newBuilder

public static DisplayData.Builder newBuilder()

newBuilder

public static DisplayData.Builder newBuilder(DisplayData prototype)

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.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

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.GeneratedMessage

getDefaultInstanceForType

public DisplayData getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder