Package org.platanios.tensorflow.proto

Class SummaryMetadata.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, SummaryMetadataOrBuilder
    Enclosing class:
    SummaryMetadata
    public static final class SummaryMetadata.Builder
extends com.google.protobuf.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 org.platanios.tensorflow.proto.SummaryMetadata

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • clear

        public SummaryMetadata.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • getDefaultInstanceForType

        public SummaryMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public SummaryMetadata build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public SummaryMetadata buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public SummaryMetadata.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • setField

        public SummaryMetadata.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • clearField

        public SummaryMetadata.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • clearOneof

        public SummaryMetadata.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • setRepeatedField

        public SummaryMetadata.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • addRepeatedField

        public SummaryMetadata.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • mergeFrom

        public SummaryMetadata.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SummaryMetadata.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • mergeFrom

        public SummaryMetadata.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SummaryMetadata.Builder>
        Throws:
        java.io.IOException

      • 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 interface SummaryMetadataOrBuilder
        Returns:
        Whether the pluginData field is set.

      • clearPluginData

        public SummaryMetadata.Builder clearPluginData()
         Data that associates a summary with a certain plugin.
        .org.platanios.tensorflow.proto.SummaryMetadata.PluginData plugin_data = 1;

      • getPluginDataBuilder

        public SummaryMetadata.PluginData.Builder getPluginDataBuilder()
         Data that associates a summary with a certain plugin.
        .org.platanios.tensorflow.proto.SummaryMetadata.PluginData plugin_data = 1;

      • getDisplayName

        public java.lang.String getDisplayName()
         Display name for viewing in TensorBoard.
        string display_name = 2;
        Specified by:
        getDisplayName in interface SummaryMetadataOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.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​(java.lang.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​(com.google.protobuf.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 java.lang.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 com.google.protobuf.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​(java.lang.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​(com.google.protobuf.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.
        .org.platanios.tensorflow.proto.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.
        .org.platanios.tensorflow.proto.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.
        .org.platanios.tensorflow.proto.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.
        .org.platanios.tensorflow.proto.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.
        .org.platanios.tensorflow.proto.DataClass data_class = 4;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final SummaryMetadata.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>

      • mergeUnknownFields

        public final SummaryMetadata.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SummaryMetadata.Builder>