Package com.google.cloud.aiplatform.v1

Class TunedModel.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TunedModel.Builder>
com.google.cloud.aiplatform.v1.TunedModel.Builder
All Implemented Interfaces:
TunedModelOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TunedModel
public static final class TunedModel.Builder extends com.google.protobuf.GeneratedMessage.Builder<TunedModel.Builder> 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

  • 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.Builder<TunedModel.Builder>

    • clear

      public TunedModel.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.GeneratedMessage.Builder<TunedModel.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.GeneratedMessage.Builder<TunedModel.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public TunedModel.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<TunedModel.Builder>

    • mergeFrom

      public TunedModel.Builder mergeFrom(TunedModel other)

    • isInitialized

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

    • mergeFrom

      public TunedModel.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<TunedModel.Builder>
      Throws:
      IOException

    • 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.

    • setModel

      public TunedModel.Builder setModel(String value)
       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) = { ... }
      Parameters:
      value - The model to set.
      Returns:
      This builder for chaining.

    • clearModel

      public TunedModel.Builder clearModel()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setModelBytes

      public TunedModel.Builder setModelBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for model to set.
      Returns:
      This builder for chaining.

    • 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.

    • setEndpoint

      public TunedModel.Builder setEndpoint(String value)
       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) = { ... }
      Parameters:
      value - The endpoint to set.
      Returns:
      This builder for chaining.

    • clearEndpoint

      public TunedModel.Builder clearEndpoint()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setEndpointBytes

      public TunedModel.Builder setEndpointBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for endpoint to set.
      Returns:
      This builder for chaining.

    • 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

    • 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

    • setCheckpoints

      public TunedModel.Builder setCheckpoints(int index, TunedModelCheckpoint value)
       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];

    • setCheckpoints

      public TunedModel.Builder setCheckpoints(int index, TunedModelCheckpoint.Builder builderForValue)
       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];

    • addCheckpoints

      public TunedModel.Builder addCheckpoints(TunedModelCheckpoint value)
       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];

    • addCheckpoints

      public TunedModel.Builder addCheckpoints(int index, TunedModelCheckpoint value)
       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];

    • addCheckpoints

      public TunedModel.Builder addCheckpoints(TunedModelCheckpoint.Builder builderForValue)
       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];

    • addCheckpoints

      public TunedModel.Builder addCheckpoints(int index, TunedModelCheckpoint.Builder builderForValue)
       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];

    • addAllCheckpoints

      public TunedModel.Builder addAllCheckpoints(Iterable<? extends TunedModelCheckpoint> values)
       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];

    • clearCheckpoints

      public TunedModel.Builder clearCheckpoints()
       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];

    • removeCheckpoints

      public TunedModel.Builder removeCheckpoints(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];

    • getCheckpointsBuilder

      public TunedModelCheckpoint.Builder getCheckpointsBuilder(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];

    • 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

    • 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

    • addCheckpointsBuilder

      public TunedModelCheckpoint.Builder addCheckpointsBuilder()
       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];

    • addCheckpointsBuilder

      public TunedModelCheckpoint.Builder addCheckpointsBuilder(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];

    • getCheckpointsBuilderList

      public List<TunedModelCheckpoint.Builder> getCheckpointsBuilderList()
       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];