Class SummaryMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.SummaryMetadata

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, SummaryMetadataOrBuilder

public final class SummaryMetadata
extends GeneratedMessageV3
implements SummaryMetadataOrBuilder

A SummaryMetadata encapsulates information on which plugins are able to make
use of a certain summary value.

Protobuf type tensorflow.SummaryMetadata

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SummaryMetadata.Builder	A SummaryMetadata encapsulates information on which plugins are able to make use of a certain summary value.
static final class	SummaryMetadata.PluginData	Protobuf type tensorflow.SummaryMetadata.PluginData
static interface	SummaryMetadata.PluginDataOrBuilder

Nested classes/interfaces inherited from class GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DATA_CLASS_FIELD_NUMBER
static final int	DISPLAY_NAME_FIELD_NUMBER
static final int	PLUGIN_DATA_FIELD_NUMBER
static final int	SUMMARY_DESCRIPTION_FIELD_NUMBER

Fields inherited from class GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
DataClass	getDataClass()	Class of data stored in this time series.
int	getDataClassValue()	Class of data stored in this time series.
static SummaryMetadata	getDefaultInstance()
SummaryMetadata	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
String	getDisplayName()	Display name for viewing in TensorBoard.
ByteString	getDisplayNameBytes()	Display name for viewing in TensorBoard.
Parser<SummaryMetadata>	getParserForType()
SummaryMetadata.PluginData	getPluginData()	Data that associates a summary with a certain plugin.
SummaryMetadata.PluginDataOrBuilder	getPluginDataOrBuilder()	Data that associates a summary with a certain plugin.
int	getSerializedSize()
String	getSummaryDescription()	Longform readable description of the summary sequence.
ByteString	getSummaryDescriptionBytes()	Longform readable description of the summary sequence.
final UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasPluginData()	Data that associates a summary with a certain plugin.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static SummaryMetadata.Builder	newBuilder()
static SummaryMetadata.Builder	newBuilder(SummaryMetadata prototype)
SummaryMetadata.Builder	newBuilderForType()
protected SummaryMetadata.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static SummaryMetadata	parseDelimitedFrom(InputStream input)
static SummaryMetadata	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static SummaryMetadata	parseFrom(byte[] data)
static SummaryMetadata	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static SummaryMetadata	parseFrom(ByteString data)
static SummaryMetadata	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static SummaryMetadata	parseFrom(CodedInputStream input)
static SummaryMetadata	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static SummaryMetadata	parseFrom(InputStream input)
static SummaryMetadata	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static SummaryMetadata	parseFrom(ByteBuffer data)
static SummaryMetadata	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<SummaryMetadata>	parser()
SummaryMetadata.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

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

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

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

Field Details

PLUGIN_DATA_FIELD_NUMBER

public static final int PLUGIN_DATA_FIELD_NUMBER

See Also:

• Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

SUMMARY_DESCRIPTION_FIELD_NUMBER

public static final int SUMMARY_DESCRIPTION_FIELD_NUMBER

See Also:

• Constant Field Values

DATA_CLASS_FIELD_NUMBER

public static final int DATA_CLASS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

hasPluginData

public boolean hasPluginData()

Data that associates a summary with a certain plugin.

.tensorflow.SummaryMetadata.PluginData plugin_data = 1;

Specified by:

hasPluginData in interface SummaryMetadataOrBuilder

Returns:

Whether the pluginData field is set.

getPluginData

public SummaryMetadata.PluginData getPluginData()

Data that associates a summary with a certain plugin.

.tensorflow.SummaryMetadata.PluginData plugin_data = 1;

Specified by:

getPluginData in interface SummaryMetadataOrBuilder

Returns:

The pluginData.

getPluginDataOrBuilder

public SummaryMetadata.PluginDataOrBuilder getPluginDataOrBuilder()

Data that associates a summary with a certain plugin.

.tensorflow.SummaryMetadata.PluginData plugin_data = 1;

Specified by:

getPluginDataOrBuilder in interface SummaryMetadataOrBuilder

getDisplayName

public String getDisplayName()

Display name for viewing in TensorBoard.

string display_name = 2;

Specified by:

getDisplayName in interface SummaryMetadataOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public ByteString getDisplayNameBytes()

Display name for viewing in TensorBoard.

string display_name = 2;

Specified by:

getDisplayNameBytes in interface SummaryMetadataOrBuilder

Returns:

The bytes for displayName.

getSummaryDescription

public String getSummaryDescription()

Longform readable description of the summary sequence. Markdown supported.

string summary_description = 3;

Specified by:

getSummaryDescription in interface SummaryMetadataOrBuilder

Returns:

The summaryDescription.

getSummaryDescriptionBytes

public ByteString getSummaryDescriptionBytes()

Longform readable description of the summary sequence. Markdown supported.

string summary_description = 3;

Specified by:

getSummaryDescriptionBytes in interface SummaryMetadataOrBuilder

Returns:

The bytes for summaryDescription.

getDataClassValue

public int getDataClassValue()

Class of data stored in this time series. Required for compatibility with
TensorBoard's generic data facilities (`DataProvider`, et al.). This value
imposes constraints on the dtype and shape of the corresponding tensor
values. See `DataClass` docs for details.

.tensorflow.DataClass data_class = 4;

Specified by:

getDataClassValue in interface SummaryMetadataOrBuilder

Returns:

The enum numeric value on the wire for dataClass.

getDataClass

public DataClass getDataClass()

Class of data stored in this time series. Required for compatibility with
TensorBoard's generic data facilities (`DataProvider`, et al.). This value
imposes constraints on the dtype and shape of the corresponding tensor
values. See `DataClass` docs for details.

.tensorflow.DataClass data_class = 4;

Specified by:

getDataClass in interface SummaryMetadataOrBuilder

Returns:

The dataClass.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static SummaryMetadata parseFrom(ByteBuffer data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static SummaryMetadata parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static SummaryMetadata parseFrom(ByteString data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static SummaryMetadata parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static SummaryMetadata parseFrom(byte[] data)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static SummaryMetadata parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                 throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static SummaryMetadata parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static SummaryMetadata parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static SummaryMetadata parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static SummaryMetadata parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static SummaryMetadata parseFrom(CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static SummaryMetadata parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilderForType

public SummaryMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static SummaryMetadata.Builder newBuilder()

newBuilder

public static SummaryMetadata.Builder newBuilder(SummaryMetadata prototype)

toBuilder

public SummaryMetadata.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected SummaryMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static SummaryMetadata getDefaultInstance()

parser

public static Parser<SummaryMetadata> parser()

getParserForType

public Parser<SummaryMetadata> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public SummaryMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder