Package com.google.cloud.aiplatform.v1

Class TensorboardTimeSeries

  • All Implemented Interfaces:
    TensorboardTimeSeriesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TensorboardTimeSeries
extends com.google.protobuf.GeneratedMessageV3
implements TensorboardTimeSeriesOrBuilder
     TensorboardTimeSeries maps to times series produced in training runs
    Protobuf type google.cloud.aiplatform.v1.TensorboardTimeSeries
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.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 class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. Name of the TensorboardTimeSeries.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Name of the TensorboardTimeSeries.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. User provided name of this TensorboardTimeSeries.
 This value should be unique among all TensorboardTimeSeries resources
 belonging to the same TensorboardRun resource (parent resource).
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. User provided name of this TensorboardTimeSeries.
 This value should be unique among all TensorboardTimeSeries resources
 belonging to the same TensorboardRun resource (parent resource).
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The bytes for displayName.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Description of this TensorboardTimeSeries.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The bytes for description.

      • getValueTypeValue

        public int getValueTypeValue()
         Required. Immutable. Type of TensorboardTimeSeries value.
        .google.cloud.aiplatform.v1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getValueTypeValue in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The enum numeric value on the wire for valueType.

      • getValueType

        public TensorboardTimeSeries.ValueType getValueType()
         Required. Immutable. Type of TensorboardTimeSeries value.
        .google.cloud.aiplatform.v1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getValueType in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The valueType.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this TensorboardTimeSeries was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface TensorboardTimeSeriesOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this TensorboardTimeSeries was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this TensorboardTimeSeries was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface TensorboardTimeSeriesOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Timestamp when this TensorboardTimeSeries was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface TensorboardTimeSeriesOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Timestamp when this TensorboardTimeSeries was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Timestamp when this TensorboardTimeSeries was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface TensorboardTimeSeriesOrBuilder

      • getEtag

        public String getEtag()
         Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 7;
        Specified by:
        getEtag in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 7;
        Specified by:
        getEtagBytes in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The bytes for etag.

      • getPluginName

        public String getPluginName()
         Immutable. Name of the plugin this time series pertain to. Such as Scalar,
 Tensor, Blob
        string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPluginName in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The pluginName.

      • getPluginNameBytes

        public com.google.protobuf.ByteString getPluginNameBytes()
         Immutable. Name of the plugin this time series pertain to. Such as Scalar,
 Tensor, Blob
        string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPluginNameBytes in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The bytes for pluginName.

      • getPluginData

        public com.google.protobuf.ByteString getPluginData()
         Data of the current plugin, with the size limited to 65KB.
        bytes plugin_data = 9;
        Specified by:
        getPluginData in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The pluginData.

      • hasMetadata

        public boolean hasMetadata()
         Output only. Scalar, Tensor, or Blob metadata for this
 TensorboardTimeSeries.
        .google.cloud.aiplatform.v1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasMetadata in interface TensorboardTimeSeriesOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public TensorboardTimeSeries.Metadata getMetadata()
         Output only. Scalar, Tensor, or Blob metadata for this
 TensorboardTimeSeries.
        .google.cloud.aiplatform.v1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetadata in interface TensorboardTimeSeriesOrBuilder
        Returns:
        The metadata.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • 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 TensorboardTimeSeries parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TensorboardTimeSeries parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TensorboardTimeSeries parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TensorboardTimeSeries parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TensorboardTimeSeries parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TensorboardTimeSeries parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public TensorboardTimeSeries.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TensorboardTimeSeries.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TensorboardTimeSeries.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<TensorboardTimeSeries> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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