Class TensorboardRun

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.TensorboardRun
All Implemented Interfaces:
TensorboardRunOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class TensorboardRun extends com.google.protobuf.GeneratedMessage implements TensorboardRunOrBuilder
 TensorboardRun maps to a specific execution of a training job with a given
 set of hyperparameter values, model definition, dataset, etc
 
Protobuf type google.cloud.aiplatform.v1.TensorboardRun
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    The labels with user-defined metadata to organize your TensorboardRuns.
    boolean
     
    com.google.protobuf.Timestamp
    Output only.
    com.google.protobuf.TimestampOrBuilder
    Output only.
     
     
    Description of this TensorboardRun.
    com.google.protobuf.ByteString
    Description of this TensorboardRun.
    static final com.google.protobuf.Descriptors.Descriptor
     
    Required.
    com.google.protobuf.ByteString
    Required.
    Used to perform a consistent read-modify-write updates.
    com.google.protobuf.ByteString
    Used to perform a consistent read-modify-write updates.
    Deprecated.
    int
    The labels with user-defined metadata to organize your TensorboardRuns.
    The labels with user-defined metadata to organize your TensorboardRuns.
    getLabelsOrDefault(String key, String defaultValue)
    The labels with user-defined metadata to organize your TensorboardRuns.
    The labels with user-defined metadata to organize your TensorboardRuns.
    Output only.
    com.google.protobuf.ByteString
    Output only.
    com.google.protobuf.Parser<TensorboardRun>
     
    int
     
    com.google.protobuf.Timestamp
    Output only.
    com.google.protobuf.TimestampOrBuilder
    Output only.
    boolean
    Output only.
    int
     
    boolean
    Output only.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    protected com.google.protobuf.MapFieldReflectionAccessor
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TensorboardRun>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Field Details

  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getName

      public String getName()
       Output only. Name of the TensorboardRun.
       Format:
       `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface TensorboardRunOrBuilder
      Returns:
      The name.
    • getNameBytes

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

      public String getDisplayName()
       Required. User provided name of this TensorboardRun.
       This value must be unique among all TensorboardRuns
       belonging to the same parent TensorboardExperiment.
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface TensorboardRunOrBuilder
      Returns:
      The displayName.
    • getDisplayNameBytes

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

      public String getDescription()
       Description of this TensorboardRun.
       
      string description = 3;
      Specified by:
      getDescription in interface TensorboardRunOrBuilder
      Returns:
      The description.
    • getDescriptionBytes

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

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

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when this TensorboardRun was created.
       
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface TensorboardRunOrBuilder
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when this TensorboardRun was created.
       
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface TensorboardRunOrBuilder
    • hasUpdateTime

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

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

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when this TensorboardRun was last updated.
       
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface TensorboardRunOrBuilder
    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: TensorboardRunOrBuilder
       The labels with user-defined metadata to organize your TensorboardRuns.
      
       This field will be used to filter and visualize Runs in the Tensorboard UI.
       For example, a Vertex AI training job can set a label
       aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
       within that job. An end user can set a label experiment_id=xxxxx for all
       the runs produced in a Jupyter notebook. These runs can be grouped by a
       label value and visualized together in the Tensorboard UI.
      
       Label keys and values can be no 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 TensorboardRun
       (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.
       
      map<string, string> labels = 8;
      Specified by:
      getLabelsCount in interface TensorboardRunOrBuilder
    • containsLabels

      public boolean containsLabels(String key)
       The labels with user-defined metadata to organize your TensorboardRuns.
      
       This field will be used to filter and visualize Runs in the Tensorboard UI.
       For example, a Vertex AI training job can set a label
       aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
       within that job. An end user can set a label experiment_id=xxxxx for all
       the runs produced in a Jupyter notebook. These runs can be grouped by a
       label value and visualized together in the Tensorboard UI.
      
       Label keys and values can be no 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 TensorboardRun
       (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.
       
      map<string, string> labels = 8;
      Specified by:
      containsLabels in interface TensorboardRunOrBuilder
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface TensorboardRunOrBuilder
    • getLabelsMap

      public Map<String,String> getLabelsMap()
       The labels with user-defined metadata to organize your TensorboardRuns.
      
       This field will be used to filter and visualize Runs in the Tensorboard UI.
       For example, a Vertex AI training job can set a label
       aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
       within that job. An end user can set a label experiment_id=xxxxx for all
       the runs produced in a Jupyter notebook. These runs can be grouped by a
       label value and visualized together in the Tensorboard UI.
      
       Label keys and values can be no 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 TensorboardRun
       (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.
       
      map<string, string> labels = 8;
      Specified by:
      getLabelsMap in interface TensorboardRunOrBuilder
    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       The labels with user-defined metadata to organize your TensorboardRuns.
      
       This field will be used to filter and visualize Runs in the Tensorboard UI.
       For example, a Vertex AI training job can set a label
       aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
       within that job. An end user can set a label experiment_id=xxxxx for all
       the runs produced in a Jupyter notebook. These runs can be grouped by a
       label value and visualized together in the Tensorboard UI.
      
       Label keys and values can be no 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 TensorboardRun
       (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.
       
      map<string, string> labels = 8;
      Specified by:
      getLabelsOrDefault in interface TensorboardRunOrBuilder
    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       The labels with user-defined metadata to organize your TensorboardRuns.
      
       This field will be used to filter and visualize Runs in the Tensorboard UI.
       For example, a Vertex AI training job can set a label
       aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
       within that job. An end user can set a label experiment_id=xxxxx for all
       the runs produced in a Jupyter notebook. These runs can be grouped by a
       label value and visualized together in the Tensorboard UI.
      
       Label keys and values can be no 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 TensorboardRun
       (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.
       
      map<string, string> labels = 8;
      Specified by:
      getLabelsOrThrow in interface TensorboardRunOrBuilder
    • getEtag

      public String getEtag()
       Used to perform a consistent read-modify-write updates. If not set, a blind
       "overwrite" update happens.
       
      string etag = 9;
      Specified by:
      getEtag in interface TensorboardRunOrBuilder
      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 = 9;
      Specified by:
      getEtagBytes in interface TensorboardRunOrBuilder
      Returns:
      The bytes for etag.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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 TensorboardRun parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

      public static TensorboardRun parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

      public static TensorboardRun parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TensorboardRun parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static TensorboardRun parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static TensorboardRun parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TensorboardRun parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static TensorboardRun parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

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

      public static TensorboardRun.Builder newBuilder()
    • newBuilder

      public static TensorboardRun.Builder newBuilder(TensorboardRun prototype)
    • toBuilder

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

      protected TensorboardRun.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static TensorboardRun getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<TensorboardRun> parser()
    • getParserForType

      public com.google.protobuf.Parser<TensorboardRun> 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.GeneratedMessage
    • getDefaultInstanceForType

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