Package com.google.cloud.aiplatform.v1

Class TunedModel

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.TunedModel
All Implemented Interfaces:
TunedModelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TunedModel extends com.google.protobuf.GeneratedMessage implements TunedModelOrBuilder
 The Model Registry Model and Online Prediction Endpoint associated with
 this [TuningJob][google.cloud.aiplatform.v1.TuningJob].
Protobuf type google.cloud.aiplatform.v1.TunedModel
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TunedModel.Builder
    The Model Registry Model and Online Prediction Endpoint associated with this [TuningJob][google.cloud.aiplatform.v1.TuningJob].

    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
    CHECKPOINTS_FIELD_NUMBER
     
    static final int
    ENDPOINT_FIELD_NUMBER
     
    static final int
    MODEL_FIELD_NUMBER
     

    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
    equals(Object obj)
     
    TunedModelCheckpoint
    getCheckpoints(int index)
    Output only.
    int
    getCheckpointsCount()
    Output only.
    List<TunedModelCheckpoint>
    getCheckpointsList()
    Output only.
    TunedModelCheckpointOrBuilder
    getCheckpointsOrBuilder(int index)
    Output only.
    List<? extends TunedModelCheckpointOrBuilder>
    getCheckpointsOrBuilderList()
    Output only.
    static TunedModel
    getDefaultInstance()
     
    TunedModel
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEndpoint()
    Output only.
    com.google.protobuf.ByteString
    getEndpointBytes()
    Output only.
    String
    getModel()
    Output only.
    com.google.protobuf.ByteString
    getModelBytes()
    Output only.
    com.google.protobuf.Parser<TunedModel>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TunedModel.Builder
    newBuilder()
     
    static TunedModel.Builder
    newBuilder(TunedModel prototype)
     
    TunedModel.Builder
    newBuilderForType()
     
    protected TunedModel.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static TunedModel
    parseDelimitedFrom(InputStream input)
     
    static TunedModel
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TunedModel
    parseFrom(byte[] data)
     
    static TunedModel
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TunedModel
    parseFrom(com.google.protobuf.ByteString data)
     
    static TunedModel
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TunedModel
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TunedModel
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TunedModel
    parseFrom(InputStream input)
     
    static TunedModel
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TunedModel
    parseFrom(ByteBuffer data)
     
    static TunedModel
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TunedModel>
    parser()
     
    TunedModel.Builder
    toBuilder()
     
    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, internalGetMapFieldReflection, 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()

    • internalGetFieldAccessorTable

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

    • getModel

      public String getModel()
       Output only. The resource name of the TunedModel. Format:

 `projects/{project}/locations/{location}/models/{model}@{version_id}`

 When tuning from a base model, the version ID will be 1.

 For continuous tuning, if the provided tuned_model_display_name is set and
 different from parent model's display name, the tuned model will have a new
 parent model with version 1. Otherwise the version id will be incremented
 by 1 from the last version ID in the parent model. E.g.,

 `projects/{project}/locations/{location}/models/{model}@{last_version_id +
 1}`
      string model = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getModel in interface TunedModelOrBuilder
      Returns:
      The model.

    • getModelBytes

      public com.google.protobuf.ByteString getModelBytes()
       Output only. The resource name of the TunedModel. Format:

 `projects/{project}/locations/{location}/models/{model}@{version_id}`

 When tuning from a base model, the version ID will be 1.

 For continuous tuning, if the provided tuned_model_display_name is set and
 different from parent model's display name, the tuned model will have a new
 parent model with version 1. Otherwise the version id will be incremented
 by 1 from the last version ID in the parent model. E.g.,

 `projects/{project}/locations/{location}/models/{model}@{last_version_id +
 1}`
      string model = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getModelBytes in interface TunedModelOrBuilder
      Returns:
      The bytes for model.

    • getEndpoint

      public String getEndpoint()
       Output only. A resource name of an Endpoint. Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`.
      string endpoint = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getEndpoint in interface TunedModelOrBuilder
      Returns:
      The endpoint.

    • getEndpointBytes

      public com.google.protobuf.ByteString getEndpointBytes()
       Output only. A resource name of an Endpoint. Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`.
      string endpoint = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getEndpointBytes in interface TunedModelOrBuilder
      Returns:
      The bytes for endpoint.

    • getCheckpointsList

      public List<TunedModelCheckpoint> getCheckpointsList()
       Output only. The checkpoints associated with this TunedModel.
 This field is only populated for tuning jobs that enable intermediate
 checkpoints.
      repeated .google.cloud.aiplatform.v1.TunedModelCheckpoint checkpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCheckpointsList in interface TunedModelOrBuilder

    • getCheckpointsOrBuilderList

      public List<? extends TunedModelCheckpointOrBuilder> getCheckpointsOrBuilderList()
       Output only. The checkpoints associated with this TunedModel.
 This field is only populated for tuning jobs that enable intermediate
 checkpoints.
      repeated .google.cloud.aiplatform.v1.TunedModelCheckpoint checkpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCheckpointsOrBuilderList in interface TunedModelOrBuilder

    • getCheckpointsCount

      public int getCheckpointsCount()
       Output only. The checkpoints associated with this TunedModel.
 This field is only populated for tuning jobs that enable intermediate
 checkpoints.
      repeated .google.cloud.aiplatform.v1.TunedModelCheckpoint checkpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCheckpointsCount in interface TunedModelOrBuilder

    • getCheckpoints

      public TunedModelCheckpoint getCheckpoints(int index)
       Output only. The checkpoints associated with this TunedModel.
 This field is only populated for tuning jobs that enable intermediate
 checkpoints.
      repeated .google.cloud.aiplatform.v1.TunedModelCheckpoint checkpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCheckpoints in interface TunedModelOrBuilder

    • getCheckpointsOrBuilder

      public TunedModelCheckpointOrBuilder getCheckpointsOrBuilder(int index)
       Output only. The checkpoints associated with this TunedModel.
 This field is only populated for tuning jobs that enable intermediate
 checkpoints.
      repeated .google.cloud.aiplatform.v1.TunedModelCheckpoint checkpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCheckpointsOrBuilder in interface TunedModelOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TunedModel parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static TunedModel parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TunedModel.Builder newBuilder()

    • newBuilder

      public static TunedModel.Builder newBuilder(TunedModel prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TunedModel getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TunedModel> parser()

    • getParserForType

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