Package com.google.cloud.aiplatform.v1

Class TensorboardExperiment

  • All Implemented Interfaces:
    TensorboardExperimentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TensorboardExperiment
extends com.google.protobuf.GeneratedMessageV3
implements TensorboardExperimentOrBuilder
     A TensorboardExperiment is a group of TensorboardRuns, that are typically the
 results of a training job run, in a Tensorboard.
    Protobuf type google.cloud.aiplatform.v1.TensorboardExperiment
    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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • 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 TensorboardExperiment.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface TensorboardExperimentOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Name of the TensorboardExperiment.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface TensorboardExperimentOrBuilder
        Returns:
        The bytes for name.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         User provided name of this TensorboardExperiment.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface TensorboardExperimentOrBuilder
        Returns:
        The bytes for displayName.

      • getDescriptionBytes

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

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

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

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: TensorboardExperimentOrBuilder
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with `aiplatform.googleapis.com/`
 and are immutable. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;
        Specified by:
        getLabelsCount in interface TensorboardExperimentOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with `aiplatform.googleapis.com/`
 and are immutable. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;
        Specified by:
        containsLabels in interface TensorboardExperimentOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with `aiplatform.googleapis.com/`
 and are immutable. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;
        Specified by:
        getLabelsMap in interface TensorboardExperimentOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with `aiplatform.googleapis.com/`
 and are immutable. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;
        Specified by:
        getLabelsOrDefault in interface TensorboardExperimentOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with `aiplatform.googleapis.com/`
 and are immutable. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;
        Specified by:
        getLabelsOrThrow in interface TensorboardExperimentOrBuilder

      • getEtag

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

      • getEtagBytes

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

      • getSource

        public String getSource()
         Immutable. Source of the TensorboardExperiment. Example: a custom training
 job.
        string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getSource in interface TensorboardExperimentOrBuilder
        Returns:
        The source.

      • getSourceBytes

        public com.google.protobuf.ByteString getSourceBytes()
         Immutable. Source of the TensorboardExperiment. Example: a custom training
 job.
        string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getSourceBytes in interface TensorboardExperimentOrBuilder
        Returns:
        The bytes for source.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<TensorboardExperiment> 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 TensorboardExperiment getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder