Package org.platanios.tensorflow.proto
Class SummaryMetadata
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- org.platanios.tensorflow.proto.SummaryMetadata
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.io.Serializable
,SummaryMetadataOrBuilder
public final class SummaryMetadata extends com.google.protobuf.GeneratedMessageV3 implements SummaryMetadataOrBuilder
A SummaryMetadata encapsulates information on which plugins are able to make use of a certain summary value.
Protobuf typeorg.platanios.tensorflow.proto.SummaryMetadata
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SummaryMetadata.Builder
A SummaryMetadata encapsulates information on which plugins are able to make use of a certain summary value.static class
SummaryMetadata.PluginData
Protobuf typeorg.platanios.tensorflow.proto.SummaryMetadata.PluginData
static interface
SummaryMetadata.PluginDataOrBuilder
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
DATA_CLASS_FIELD_NUMBER
static int
DISPLAY_NAME_FIELD_NUMBER
static int
PLUGIN_DATA_FIELD_NUMBER
static int
SUMMARY_DESCRIPTION_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.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 com.google.protobuf.Descriptors.Descriptor
getDescriptor()
java.lang.String
getDisplayName()
Display name for viewing in TensorBoard.com.google.protobuf.ByteString
getDisplayNameBytes()
Display name for viewing in TensorBoard.com.google.protobuf.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()
java.lang.String
getSummaryDescription()
Longform readable description of the summary sequence.com.google.protobuf.ByteString
getSummaryDescriptionBytes()
Longform readable description of the summary sequence.com.google.protobuf.UnknownFieldSet
getUnknownFields()
int
hashCode()
boolean
hasPluginData()
Data that associates a summary with a certain plugin.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static SummaryMetadata.Builder
newBuilder()
static SummaryMetadata.Builder
newBuilder(SummaryMetadata prototype)
SummaryMetadata.Builder
newBuilderForType()
protected SummaryMetadata.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SummaryMetadata
parseDelimitedFrom(java.io.InputStream input)
static SummaryMetadata
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummaryMetadata
parseFrom(byte[] data)
static SummaryMetadata
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummaryMetadata
parseFrom(com.google.protobuf.ByteString data)
static SummaryMetadata
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummaryMetadata
parseFrom(com.google.protobuf.CodedInputStream input)
static SummaryMetadata
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummaryMetadata
parseFrom(java.io.InputStream input)
static SummaryMetadata
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SummaryMetadata
parseFrom(java.nio.ByteBuffer data)
static SummaryMetadata
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SummaryMetadata>
parser()
SummaryMetadata.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, 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 com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
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 Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFields
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
hasPluginData
public boolean hasPluginData()
Data that associates a summary with a certain plugin.
.org.platanios.tensorflow.proto.SummaryMetadata.PluginData plugin_data = 1;
- Specified by:
hasPluginData
in interfaceSummaryMetadataOrBuilder
- Returns:
- Whether the pluginData field is set.
-
getPluginData
public SummaryMetadata.PluginData getPluginData()
Data that associates a summary with a certain plugin.
.org.platanios.tensorflow.proto.SummaryMetadata.PluginData plugin_data = 1;
- Specified by:
getPluginData
in interfaceSummaryMetadataOrBuilder
- Returns:
- The pluginData.
-
getPluginDataOrBuilder
public SummaryMetadata.PluginDataOrBuilder getPluginDataOrBuilder()
Data that associates a summary with a certain plugin.
.org.platanios.tensorflow.proto.SummaryMetadata.PluginData plugin_data = 1;
- Specified by:
getPluginDataOrBuilder
in interfaceSummaryMetadataOrBuilder
-
getDisplayName
public java.lang.String getDisplayName()
Display name for viewing in TensorBoard.
string display_name = 2;
- Specified by:
getDisplayName
in interfaceSummaryMetadataOrBuilder
- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()
Display name for viewing in TensorBoard.
string display_name = 2;
- Specified by:
getDisplayNameBytes
in interfaceSummaryMetadataOrBuilder
- Returns:
- The bytes for displayName.
-
getSummaryDescription
public java.lang.String getSummaryDescription()
Longform readable description of the summary sequence. Markdown supported.
string summary_description = 3;
- Specified by:
getSummaryDescription
in interfaceSummaryMetadataOrBuilder
- Returns:
- The summaryDescription.
-
getSummaryDescriptionBytes
public com.google.protobuf.ByteString getSummaryDescriptionBytes()
Longform readable description of the summary sequence. Markdown supported.
string summary_description = 3;
- Specified by:
getSummaryDescriptionBytes
in interfaceSummaryMetadataOrBuilder
- 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.
.org.platanios.tensorflow.proto.DataClass data_class = 4;
- Specified by:
getDataClassValue
in interfaceSummaryMetadataOrBuilder
- 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.
.org.platanios.tensorflow.proto.DataClass data_class = 4;
- Specified by:
getDataClass
in interfaceSummaryMetadataOrBuilder
- Returns:
- The dataClass.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static SummaryMetadata parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SummaryMetadata parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SummaryMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SummaryMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SummaryMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SummaryMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SummaryMetadata parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static SummaryMetadata parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static SummaryMetadata parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static SummaryMetadata parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static SummaryMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static SummaryMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public SummaryMetadata.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static SummaryMetadata.Builder newBuilder()
-
newBuilder
public static SummaryMetadata.Builder newBuilder(SummaryMetadata prototype)
-
toBuilder
public SummaryMetadata.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected SummaryMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static SummaryMetadata getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<SummaryMetadata> parser()
-
getParserForType
public com.google.protobuf.Parser<SummaryMetadata> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public SummaryMetadata getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-