Class SummaryMetadata.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<SummaryMetadata.Builder>

com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

org.tensorflow.proto.SummaryMetadata.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable, SummaryMetadataOrBuilder

Enclosing class:

SummaryMetadata

public static final class SummaryMetadata.Builder
extends GeneratedMessageV3.Builder<SummaryMetadata.Builder>
implements SummaryMetadataOrBuilder

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

Protobuf type tensorflow.SummaryMetadata

Method Summary

Modifier and Type	Method	Description
SummaryMetadata.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
SummaryMetadata	build()
SummaryMetadata	buildPartial()
SummaryMetadata.Builder	clear()
SummaryMetadata.Builder	clearDataClass()	Class of data stored in this time series.
SummaryMetadata.Builder	clearDisplayName()	Display name for viewing in TensorBoard.
SummaryMetadata.Builder	clearField(Descriptors.FieldDescriptor field)
SummaryMetadata.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
SummaryMetadata.Builder	clearPluginData()	Data that associates a summary with a certain plugin.
SummaryMetadata.Builder	clearSummaryDescription()	Longform readable description of the summary sequence.
SummaryMetadata.Builder	clone()
DataClass	getDataClass()	Class of data stored in this time series.
int	getDataClassValue()	Class of data stored in this time series.
SummaryMetadata	getDefaultInstanceForType()
static final Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
String	getDisplayName()	Display name for viewing in TensorBoard.
ByteString	getDisplayNameBytes()	Display name for viewing in TensorBoard.
SummaryMetadata.PluginData	getPluginData()	Data that associates a summary with a certain plugin.
SummaryMetadata.PluginData.Builder	getPluginDataBuilder()	Data that associates a summary with a certain plugin.
SummaryMetadata.PluginDataOrBuilder	getPluginDataOrBuilder()	Data that associates a summary with a certain plugin.
String	getSummaryDescription()	Longform readable description of the summary sequence.
ByteString	getSummaryDescriptionBytes()	Longform readable description of the summary sequence.
boolean	hasPluginData()	Data that associates a summary with a certain plugin.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
SummaryMetadata.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
SummaryMetadata.Builder	mergeFrom(Message other)
SummaryMetadata.Builder	mergeFrom(SummaryMetadata other)
SummaryMetadata.Builder	mergePluginData(SummaryMetadata.PluginData value)	Data that associates a summary with a certain plugin.
final SummaryMetadata.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
SummaryMetadata.Builder	setDataClass(DataClass value)	Class of data stored in this time series.
SummaryMetadata.Builder	setDataClassValue(int value)	Class of data stored in this time series.
SummaryMetadata.Builder	setDisplayName(String value)	Display name for viewing in TensorBoard.
SummaryMetadata.Builder	setDisplayNameBytes(ByteString value)	Display name for viewing in TensorBoard.
SummaryMetadata.Builder	setField(Descriptors.FieldDescriptor field, Object value)
SummaryMetadata.Builder	setPluginData(SummaryMetadata.PluginData value)	Data that associates a summary with a certain plugin.
SummaryMetadata.Builder	setPluginData(SummaryMetadata.PluginData.Builder builderForValue)	Data that associates a summary with a certain plugin.
SummaryMetadata.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
SummaryMetadata.Builder	setSummaryDescription(String value)	Longform readable description of the summary sequence.
SummaryMetadata.Builder	setSummaryDescriptionBytes(ByteString value)	Longform readable description of the summary sequence.
final SummaryMetadata.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface MessageLite.Builder

mergeFrom

Methods inherited from interface MessageOrBuilder

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

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

clear

public SummaryMetadata.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

getDefaultInstanceForType

public SummaryMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public SummaryMetadata build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public SummaryMetadata buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public SummaryMetadata.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

setField

public SummaryMetadata.Builder setField(Descriptors.FieldDescriptor field,
 Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

clearField

public SummaryMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

clearOneof

public SummaryMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

addRepeatedField

public SummaryMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field,
 Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

mergeFrom

public SummaryMetadata.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<SummaryMetadata.Builder>

mergeFrom

public SummaryMetadata.Builder mergeFrom(SummaryMetadata other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

mergeFrom

public SummaryMetadata.Builder mergeFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<SummaryMetadata.Builder>

Throws:

IOException

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.

setPluginData

public SummaryMetadata.Builder setPluginData(SummaryMetadata.PluginData value)

Data that associates a summary with a certain plugin.

.tensorflow.SummaryMetadata.PluginData plugin_data = 1;

setPluginData

public SummaryMetadata.Builder setPluginData(SummaryMetadata.PluginData.Builder builderForValue)

Data that associates a summary with a certain plugin.

.tensorflow.SummaryMetadata.PluginData plugin_data = 1;

mergePluginData

public SummaryMetadata.Builder mergePluginData(SummaryMetadata.PluginData value)

Data that associates a summary with a certain plugin.

.tensorflow.SummaryMetadata.PluginData plugin_data = 1;

clearPluginData

public SummaryMetadata.Builder clearPluginData()

Data that associates a summary with a certain plugin.

.tensorflow.SummaryMetadata.PluginData plugin_data = 1;

getPluginDataBuilder

public SummaryMetadata.PluginData.Builder getPluginDataBuilder()

Data that associates a summary with a certain plugin.

.tensorflow.SummaryMetadata.PluginData plugin_data = 1;

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.

setDisplayName

public SummaryMetadata.Builder setDisplayName(String value)

Display name for viewing in TensorBoard.

string display_name = 2;

Parameters:

value - The displayName to set.

Returns:

This builder for chaining.

clearDisplayName

public SummaryMetadata.Builder clearDisplayName()

Display name for viewing in TensorBoard.

string display_name = 2;

Returns:

This builder for chaining.

setDisplayNameBytes

public SummaryMetadata.Builder setDisplayNameBytes(ByteString value)

Display name for viewing in TensorBoard.

string display_name = 2;

Parameters:

value - The bytes for displayName to set.

Returns:

This builder for chaining.

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.

setSummaryDescription

public SummaryMetadata.Builder setSummaryDescription(String value)

Longform readable description of the summary sequence. Markdown supported.

string summary_description = 3;

Parameters:

value - The summaryDescription to set.

Returns:

This builder for chaining.

clearSummaryDescription

public SummaryMetadata.Builder clearSummaryDescription()

Longform readable description of the summary sequence. Markdown supported.

string summary_description = 3;

Returns:

This builder for chaining.

setSummaryDescriptionBytes

public SummaryMetadata.Builder setSummaryDescriptionBytes(ByteString value)

Longform readable description of the summary sequence. Markdown supported.

string summary_description = 3;

Parameters:

value - The bytes for summaryDescription to set.

Returns:

This builder for chaining.

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.

setDataClassValue

public SummaryMetadata.Builder setDataClassValue(int value)

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;

Parameters:

value - The enum numeric value on the wire for dataClass to set.

Returns:

This builder for chaining.

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.

setDataClass

public SummaryMetadata.Builder setDataClass(DataClass value)

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;

Parameters:

value - The dataClass to set.

Returns:

This builder for chaining.

clearDataClass

public SummaryMetadata.Builder clearDataClass()

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;

Returns:

This builder for chaining.

setUnknownFields

public final SummaryMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>

mergeUnknownFields

public final SummaryMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<SummaryMetadata.Builder>