Package com.google.cloud.aiplatform.v1beta1

Class TuningJob

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.TuningJob
All Implemented Interfaces:
TuningJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TuningJob extends com.google.protobuf.GeneratedMessage implements TuningJobOrBuilder
 Represents a TuningJob that runs with Google owned models.
Protobuf type google.cloud.aiplatform.v1beta1.TuningJob
See Also:

  • Field Details

    • BASE_MODEL_FIELD_NUMBER

      public static final int BASE_MODEL_FIELD_NUMBER
      See Also:

    • PRE_TUNED_MODEL_FIELD_NUMBER

      public static final int PRE_TUNED_MODEL_FIELD_NUMBER
      See Also:

    • SUPERVISED_TUNING_SPEC_FIELD_NUMBER

      public static final int SUPERVISED_TUNING_SPEC_FIELD_NUMBER
      See Also:

    • DISTILLATION_SPEC_FIELD_NUMBER

      public static final int DISTILLATION_SPEC_FIELD_NUMBER
      See Also:

    • PARTNER_MODEL_TUNING_SPEC_FIELD_NUMBER

      public static final int PARTNER_MODEL_TUNING_SPEC_FIELD_NUMBER
      See Also:

    • VEO_TUNING_SPEC_FIELD_NUMBER

      public static final int VEO_TUNING_SPEC_FIELD_NUMBER
      See Also:

    • VEO_LORA_TUNING_SPEC_FIELD_NUMBER

      public static final int VEO_LORA_TUNING_SPEC_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • TUNED_MODEL_DISPLAY_NAME_FIELD_NUMBER

      public static final int TUNED_MODEL_DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • CUSTOM_BASE_MODEL_FIELD_NUMBER

      public static final int CUSTOM_BASE_MODEL_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • START_TIME_FIELD_NUMBER

      public static final int START_TIME_FIELD_NUMBER
      See Also:

    • END_TIME_FIELD_NUMBER

      public static final int END_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • ERROR_FIELD_NUMBER

      public static final int ERROR_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • EXPERIMENT_FIELD_NUMBER

      public static final int EXPERIMENT_FIELD_NUMBER
      See Also:

    • TUNED_MODEL_FIELD_NUMBER

      public static final int TUNED_MODEL_FIELD_NUMBER
      See Also:

    • TUNING_DATA_STATS_FIELD_NUMBER

      public static final int TUNING_DATA_STATS_FIELD_NUMBER
      See Also:

    • PIPELINE_JOB_FIELD_NUMBER

      public static final int PIPELINE_JOB_FIELD_NUMBER
      See Also:

    • ENCRYPTION_SPEC_FIELD_NUMBER

      public static final int ENCRYPTION_SPEC_FIELD_NUMBER
      See Also:

    • SERVICE_ACCOUNT_FIELD_NUMBER

      public static final int SERVICE_ACCOUNT_FIELD_NUMBER
      See Also:

    • OUTPUT_URI_FIELD_NUMBER

      public static final int OUTPUT_URI_FIELD_NUMBER
      See Also:

    • EVALUATE_DATASET_RUNS_FIELD_NUMBER

      public static final int EVALUATE_DATASET_RUNS_FIELD_NUMBER
      See Also:

  • 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

    • getSourceModelCase

      public TuningJob.SourceModelCase getSourceModelCase()
      Specified by:
      getSourceModelCase in interface TuningJobOrBuilder

    • getTuningSpecCase

      public TuningJob.TuningSpecCase getTuningSpecCase()
      Specified by:
      getTuningSpecCase in interface TuningJobOrBuilder

    • hasBaseModel

      public boolean hasBaseModel()
       The base model that is being tuned. See [Supported
 models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
      string base_model = 4;
      Specified by:
      hasBaseModel in interface TuningJobOrBuilder
      Returns:
      Whether the baseModel field is set.

    • getBaseModel

      public String getBaseModel()
       The base model that is being tuned. See [Supported
 models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
      string base_model = 4;
      Specified by:
      getBaseModel in interface TuningJobOrBuilder
      Returns:
      The baseModel.

    • getBaseModelBytes

      public com.google.protobuf.ByteString getBaseModelBytes()
       The base model that is being tuned. See [Supported
 models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
      string base_model = 4;
      Specified by:
      getBaseModelBytes in interface TuningJobOrBuilder
      Returns:
      The bytes for baseModel.

    • hasPreTunedModel

      public boolean hasPreTunedModel()
       The pre-tuned model for continuous tuning.
      .google.cloud.aiplatform.v1beta1.PreTunedModel pre_tuned_model = 31;
      Specified by:
      hasPreTunedModel in interface TuningJobOrBuilder
      Returns:
      Whether the preTunedModel field is set.

    • getPreTunedModel

      public PreTunedModel getPreTunedModel()
       The pre-tuned model for continuous tuning.
      .google.cloud.aiplatform.v1beta1.PreTunedModel pre_tuned_model = 31;
      Specified by:
      getPreTunedModel in interface TuningJobOrBuilder
      Returns:
      The preTunedModel.

    • getPreTunedModelOrBuilder

      public PreTunedModelOrBuilder getPreTunedModelOrBuilder()
       The pre-tuned model for continuous tuning.
      .google.cloud.aiplatform.v1beta1.PreTunedModel pre_tuned_model = 31;
      Specified by:
      getPreTunedModelOrBuilder in interface TuningJobOrBuilder

    • hasSupervisedTuningSpec

      public boolean hasSupervisedTuningSpec()
       Tuning Spec for Supervised Fine Tuning.
      .google.cloud.aiplatform.v1beta1.SupervisedTuningSpec supervised_tuning_spec = 5;
      Specified by:
      hasSupervisedTuningSpec in interface TuningJobOrBuilder
      Returns:
      Whether the supervisedTuningSpec field is set.

    • getSupervisedTuningSpec

      public SupervisedTuningSpec getSupervisedTuningSpec()
       Tuning Spec for Supervised Fine Tuning.
      .google.cloud.aiplatform.v1beta1.SupervisedTuningSpec supervised_tuning_spec = 5;
      Specified by:
      getSupervisedTuningSpec in interface TuningJobOrBuilder
      Returns:
      The supervisedTuningSpec.

    • getSupervisedTuningSpecOrBuilder

      public SupervisedTuningSpecOrBuilder getSupervisedTuningSpecOrBuilder()
       Tuning Spec for Supervised Fine Tuning.
      .google.cloud.aiplatform.v1beta1.SupervisedTuningSpec supervised_tuning_spec = 5;
      Specified by:
      getSupervisedTuningSpecOrBuilder in interface TuningJobOrBuilder

    • hasDistillationSpec

      public boolean hasDistillationSpec()
       Tuning Spec for Distillation.
      .google.cloud.aiplatform.v1beta1.DistillationSpec distillation_spec = 17;
      Specified by:
      hasDistillationSpec in interface TuningJobOrBuilder
      Returns:
      Whether the distillationSpec field is set.

    • getDistillationSpec

      public DistillationSpec getDistillationSpec()
       Tuning Spec for Distillation.
      .google.cloud.aiplatform.v1beta1.DistillationSpec distillation_spec = 17;
      Specified by:
      getDistillationSpec in interface TuningJobOrBuilder
      Returns:
      The distillationSpec.

    • getDistillationSpecOrBuilder

      public DistillationSpecOrBuilder getDistillationSpecOrBuilder()
       Tuning Spec for Distillation.
      .google.cloud.aiplatform.v1beta1.DistillationSpec distillation_spec = 17;
      Specified by:
      getDistillationSpecOrBuilder in interface TuningJobOrBuilder

    • hasPartnerModelTuningSpec

      public boolean hasPartnerModelTuningSpec()
       Tuning Spec for open sourced and third party Partner models.
      .google.cloud.aiplatform.v1beta1.PartnerModelTuningSpec partner_model_tuning_spec = 21;
      Specified by:
      hasPartnerModelTuningSpec in interface TuningJobOrBuilder
      Returns:
      Whether the partnerModelTuningSpec field is set.

    • getPartnerModelTuningSpec

      public PartnerModelTuningSpec getPartnerModelTuningSpec()
       Tuning Spec for open sourced and third party Partner models.
      .google.cloud.aiplatform.v1beta1.PartnerModelTuningSpec partner_model_tuning_spec = 21;
      Specified by:
      getPartnerModelTuningSpec in interface TuningJobOrBuilder
      Returns:
      The partnerModelTuningSpec.

    • getPartnerModelTuningSpecOrBuilder

      public PartnerModelTuningSpecOrBuilder getPartnerModelTuningSpecOrBuilder()
       Tuning Spec for open sourced and third party Partner models.
      .google.cloud.aiplatform.v1beta1.PartnerModelTuningSpec partner_model_tuning_spec = 21;
      Specified by:
      getPartnerModelTuningSpecOrBuilder in interface TuningJobOrBuilder

    • hasVeoTuningSpec

      public boolean hasVeoTuningSpec()
       Tuning Spec for Veo Tuning.
      .google.cloud.aiplatform.v1beta1.VeoTuningSpec veo_tuning_spec = 33;
      Specified by:
      hasVeoTuningSpec in interface TuningJobOrBuilder
      Returns:
      Whether the veoTuningSpec field is set.

    • getVeoTuningSpec

      public VeoTuningSpec getVeoTuningSpec()
       Tuning Spec for Veo Tuning.
      .google.cloud.aiplatform.v1beta1.VeoTuningSpec veo_tuning_spec = 33;
      Specified by:
      getVeoTuningSpec in interface TuningJobOrBuilder
      Returns:
      The veoTuningSpec.

    • getVeoTuningSpecOrBuilder

      public VeoTuningSpecOrBuilder getVeoTuningSpecOrBuilder()
       Tuning Spec for Veo Tuning.
      .google.cloud.aiplatform.v1beta1.VeoTuningSpec veo_tuning_spec = 33;
      Specified by:
      getVeoTuningSpecOrBuilder in interface TuningJobOrBuilder

    • hasVeoLoraTuningSpec

      public boolean hasVeoLoraTuningSpec()
       Tuning Spec for Veo LoRA Tuning.
      .google.cloud.aiplatform.v1beta1.VeoLoraTuningSpec veo_lora_tuning_spec = 38;
      Specified by:
      hasVeoLoraTuningSpec in interface TuningJobOrBuilder
      Returns:
      Whether the veoLoraTuningSpec field is set.

    • getVeoLoraTuningSpec

      public VeoLoraTuningSpec getVeoLoraTuningSpec()
       Tuning Spec for Veo LoRA Tuning.
      .google.cloud.aiplatform.v1beta1.VeoLoraTuningSpec veo_lora_tuning_spec = 38;
      Specified by:
      getVeoLoraTuningSpec in interface TuningJobOrBuilder
      Returns:
      The veoLoraTuningSpec.

    • getVeoLoraTuningSpecOrBuilder

      public VeoLoraTuningSpecOrBuilder getVeoLoraTuningSpecOrBuilder()
       Tuning Spec for Veo LoRA Tuning.
      .google.cloud.aiplatform.v1beta1.VeoLoraTuningSpec veo_lora_tuning_spec = 38;
      Specified by:
      getVeoLoraTuningSpecOrBuilder in interface TuningJobOrBuilder

    • getName

      public String getName()
       Output only. Identifier. Resource name of a TuningJob. Format:
 `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface TuningJobOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Identifier. Resource name of a TuningJob. Format:
 `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface TuningJobOrBuilder
      Returns:
      The bytes for name.

    • getTunedModelDisplayName

      public String getTunedModelDisplayName()
       Optional. The display name of the
 [TunedModel][google.cloud.aiplatform.v1.Model]. The name can be up to 128
 characters long and can consist of any UTF-8 characters.
      string tuned_model_display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTunedModelDisplayName in interface TuningJobOrBuilder
      Returns:
      The tunedModelDisplayName.

    • getTunedModelDisplayNameBytes

      public com.google.protobuf.ByteString getTunedModelDisplayNameBytes()
       Optional. The display name of the
 [TunedModel][google.cloud.aiplatform.v1.Model]. The name can be up to 128
 characters long and can consist of any UTF-8 characters.
      string tuned_model_display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTunedModelDisplayNameBytes in interface TuningJobOrBuilder
      Returns:
      The bytes for tunedModelDisplayName.

    • getDescription

      public String getDescription()
       Optional. The description of the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface TuningJobOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The description of the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface TuningJobOrBuilder
      Returns:
      The bytes for description.

    • getCustomBaseModel

      public String getCustomBaseModel()
       Optional. The user-provided path to custom model weights. Set this field
 to tune a custom model. The path must be a Cloud Storage directory that
 contains the model weights in .safetensors format along with associated
 model metadata files. If this field is set, the base_model field must still
 be set to indicate which base model the custom model is derived from. This
 feature is only available for open source models.
      string custom_base_model = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomBaseModel in interface TuningJobOrBuilder
      Returns:
      The customBaseModel.

    • getCustomBaseModelBytes

      public com.google.protobuf.ByteString getCustomBaseModelBytes()
       Optional. The user-provided path to custom model weights. Set this field
 to tune a custom model. The path must be a Cloud Storage directory that
 contains the model weights in .safetensors format along with associated
 model metadata files. If this field is set, the base_model field must still
 be set to indicate which base model the custom model is derived from. This
 feature is only available for open source models.
      string custom_base_model = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomBaseModelBytes in interface TuningJobOrBuilder
      Returns:
      The bytes for customBaseModel.

    • getStateValue

      public int getStateValue()
       Output only. The detailed state of the job.
      .google.cloud.aiplatform.v1beta1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface TuningJobOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public JobState getState()
       Output only. The detailed state of the job.
      .google.cloud.aiplatform.v1beta1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface TuningJobOrBuilder
      Returns:
      The state.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Time when the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface TuningJobOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Time when the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface TuningJobOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time when the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface TuningJobOrBuilder

    • hasStartTime

      public boolean hasStartTime()
       Output only. Time when the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] for the first time
 entered the `JOB_STATE_RUNNING` state.
      .google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasStartTime in interface TuningJobOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       Output only. Time when the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] for the first time
 entered the `JOB_STATE_RUNNING` state.
      .google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartTime in interface TuningJobOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Output only. Time when the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] for the first time
 entered the `JOB_STATE_RUNNING` state.
      .google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartTimeOrBuilder in interface TuningJobOrBuilder

    • hasEndTime

      public boolean hasEndTime()
       Output only. Time when the TuningJob entered any of the following
 [JobStates][google.cloud.aiplatform.v1.JobState]: `JOB_STATE_SUCCEEDED`,
 `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
      .google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasEndTime in interface TuningJobOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public com.google.protobuf.Timestamp getEndTime()
       Output only. Time when the TuningJob entered any of the following
 [JobStates][google.cloud.aiplatform.v1.JobState]: `JOB_STATE_SUCCEEDED`,
 `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
      .google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEndTime in interface TuningJobOrBuilder
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       Output only. Time when the TuningJob entered any of the following
 [JobStates][google.cloud.aiplatform.v1.JobState]: `JOB_STATE_SUCCEEDED`,
 `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
      .google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEndTimeOrBuilder in interface TuningJobOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. Time when the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] was most recently
 updated.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface TuningJobOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Time when the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] was most recently
 updated.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface TuningJobOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Time when the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] was most recently
 updated.
      .google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface TuningJobOrBuilder

    • hasError

      public boolean hasError()
       Output only. Only populated when job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
      .google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasError in interface TuningJobOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public Status getError()
       Output only. Only populated when job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
      .google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getError in interface TuningJobOrBuilder
      Returns:
      The error.

    • getErrorOrBuilder

      public StatusOrBuilder getErrorOrBuilder()
       Output only. Only populated when job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
      .google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getErrorOrBuilder in interface TuningJobOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: TuningJobOrBuilder
       Optional. The labels with user-defined metadata to organize
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] and generated resources
 such as [Model][google.cloud.aiplatform.v1.Model] and
 [Endpoint][google.cloud.aiplatform.v1.Endpoint].

 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.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface TuningJobOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. The labels with user-defined metadata to organize
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] and generated resources
 such as [Model][google.cloud.aiplatform.v1.Model] and
 [Endpoint][google.cloud.aiplatform.v1.Endpoint].

 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.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface TuningJobOrBuilder

    • getLabels

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

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. The labels with user-defined metadata to organize
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] and generated resources
 such as [Model][google.cloud.aiplatform.v1.Model] and
 [Endpoint][google.cloud.aiplatform.v1.Endpoint].

 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.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface TuningJobOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. The labels with user-defined metadata to organize
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] and generated resources
 such as [Model][google.cloud.aiplatform.v1.Model] and
 [Endpoint][google.cloud.aiplatform.v1.Endpoint].

 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.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface TuningJobOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. The labels with user-defined metadata to organize
 [TuningJob][google.cloud.aiplatform.v1.TuningJob] and generated resources
 such as [Model][google.cloud.aiplatform.v1.Model] and
 [Endpoint][google.cloud.aiplatform.v1.Endpoint].

 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.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface TuningJobOrBuilder

    • getExperiment

      public String getExperiment()
       Output only. The Experiment associated with this
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      string experiment = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getExperiment in interface TuningJobOrBuilder
      Returns:
      The experiment.

    • getExperimentBytes

      public com.google.protobuf.ByteString getExperimentBytes()
       Output only. The Experiment associated with this
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      string experiment = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getExperimentBytes in interface TuningJobOrBuilder
      Returns:
      The bytes for experiment.

    • hasTunedModel

      public boolean hasTunedModel()
       Output only. The tuned model resources associated with this
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      .google.cloud.aiplatform.v1beta1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasTunedModel in interface TuningJobOrBuilder
      Returns:
      Whether the tunedModel field is set.

    • getTunedModel

      public TunedModel getTunedModel()
       Output only. The tuned model resources associated with this
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      .google.cloud.aiplatform.v1beta1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTunedModel in interface TuningJobOrBuilder
      Returns:
      The tunedModel.

    • getTunedModelOrBuilder

      public TunedModelOrBuilder getTunedModelOrBuilder()
       Output only. The tuned model resources associated with this
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      .google.cloud.aiplatform.v1beta1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTunedModelOrBuilder in interface TuningJobOrBuilder

    • hasTuningDataStats

      public boolean hasTuningDataStats()
       Output only. The tuning data statistics associated with this
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      .google.cloud.aiplatform.v1beta1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasTuningDataStats in interface TuningJobOrBuilder
      Returns:
      Whether the tuningDataStats field is set.

    • getTuningDataStats

      public TuningDataStats getTuningDataStats()
       Output only. The tuning data statistics associated with this
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      .google.cloud.aiplatform.v1beta1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTuningDataStats in interface TuningJobOrBuilder
      Returns:
      The tuningDataStats.

    • getTuningDataStatsOrBuilder

      public TuningDataStatsOrBuilder getTuningDataStatsOrBuilder()
       Output only. The tuning data statistics associated with this
 [TuningJob][google.cloud.aiplatform.v1.TuningJob].
      .google.cloud.aiplatform.v1beta1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTuningDataStatsOrBuilder in interface TuningJobOrBuilder

    • getPipelineJob

      public String getPipelineJob()
       Output only. The resource name of the PipelineJob associated with the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob]. Format:
 `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`.
      string pipeline_job = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getPipelineJob in interface TuningJobOrBuilder
      Returns:
      The pipelineJob.

    • getPipelineJobBytes

      public com.google.protobuf.ByteString getPipelineJobBytes()
       Output only. The resource name of the PipelineJob associated with the
 [TuningJob][google.cloud.aiplatform.v1.TuningJob]. Format:
 `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`.
      string pipeline_job = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getPipelineJobBytes in interface TuningJobOrBuilder
      Returns:
      The bytes for pipelineJob.

    • hasEncryptionSpec

      public boolean hasEncryptionSpec()
       Customer-managed encryption key options for a TuningJob. If this is set,
 then all resources created by the TuningJob will be encrypted with the
 provided encryption key.
      .google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;
      Specified by:
      hasEncryptionSpec in interface TuningJobOrBuilder
      Returns:
      Whether the encryptionSpec field is set.

    • getEncryptionSpec

      public EncryptionSpec getEncryptionSpec()
       Customer-managed encryption key options for a TuningJob. If this is set,
 then all resources created by the TuningJob will be encrypted with the
 provided encryption key.
      .google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;
      Specified by:
      getEncryptionSpec in interface TuningJobOrBuilder
      Returns:
      The encryptionSpec.

    • getEncryptionSpecOrBuilder

      public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
       Customer-managed encryption key options for a TuningJob. If this is set,
 then all resources created by the TuningJob will be encrypted with the
 provided encryption key.
      .google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 16;
      Specified by:
      getEncryptionSpecOrBuilder in interface TuningJobOrBuilder

    • getServiceAccount

      public String getServiceAccount()
       The service account that the tuningJob workload runs as.
 If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the
 project will be used. See
 https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent

 Users starting the pipeline must have the `iam.serviceAccounts.actAs`
 permission on this service account.
      string service_account = 22;
      Specified by:
      getServiceAccount in interface TuningJobOrBuilder
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      public com.google.protobuf.ByteString getServiceAccountBytes()
       The service account that the tuningJob workload runs as.
 If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the
 project will be used. See
 https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent

 Users starting the pipeline must have the `iam.serviceAccounts.actAs`
 permission on this service account.
      string service_account = 22;
      Specified by:
      getServiceAccountBytes in interface TuningJobOrBuilder
      Returns:
      The bytes for serviceAccount.

    • getOutputUri

      public String getOutputUri()
       Optional. Cloud Storage path to the directory where tuning job outputs are
 written to. This field is only available and required for open source
 models.
      string output_uri = 25 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOutputUri in interface TuningJobOrBuilder
      Returns:
      The outputUri.

    • getOutputUriBytes

      public com.google.protobuf.ByteString getOutputUriBytes()
       Optional. Cloud Storage path to the directory where tuning job outputs are
 written to. This field is only available and required for open source
 models.
      string output_uri = 25 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOutputUriBytes in interface TuningJobOrBuilder
      Returns:
      The bytes for outputUri.

    • getEvaluateDatasetRunsList

      public List<EvaluateDatasetRun> getEvaluateDatasetRunsList()
       Output only. Evaluation runs for the Tuning Job.
      repeated .google.cloud.aiplatform.v1beta1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEvaluateDatasetRunsList in interface TuningJobOrBuilder

    • getEvaluateDatasetRunsOrBuilderList

      public List<? extends EvaluateDatasetRunOrBuilder> getEvaluateDatasetRunsOrBuilderList()
       Output only. Evaluation runs for the Tuning Job.
      repeated .google.cloud.aiplatform.v1beta1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEvaluateDatasetRunsOrBuilderList in interface TuningJobOrBuilder

    • getEvaluateDatasetRunsCount

      public int getEvaluateDatasetRunsCount()
       Output only. Evaluation runs for the Tuning Job.
      repeated .google.cloud.aiplatform.v1beta1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEvaluateDatasetRunsCount in interface TuningJobOrBuilder

    • getEvaluateDatasetRuns

      public EvaluateDatasetRun getEvaluateDatasetRuns(int index)
       Output only. Evaluation runs for the Tuning Job.
      repeated .google.cloud.aiplatform.v1beta1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEvaluateDatasetRuns in interface TuningJobOrBuilder

    • getEvaluateDatasetRunsOrBuilder

      public EvaluateDatasetRunOrBuilder getEvaluateDatasetRunsOrBuilder(int index)
       Output only. Evaluation runs for the Tuning Job.
      repeated .google.cloud.aiplatform.v1beta1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEvaluateDatasetRunsOrBuilder in interface TuningJobOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TuningJob.Builder newBuilder()

    • newBuilder

      public static TuningJob.Builder newBuilder(TuningJob prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TuningJob getDefaultInstance()

    • parser

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

    • getParserForType

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