Interface TuningJobOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TuningJob, TuningJob.Builder

@Generated public interface TuningJobOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • hasBaseModel

      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;
      Returns:
      Whether the baseModel field is set.
    • getBaseModel

      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;
      Returns:
      The baseModel.
    • getBaseModelBytes

      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;
      Returns:
      The bytes for baseModel.
    • hasPreTunedModel

      boolean hasPreTunedModel()
       The pre-tuned model for continuous tuning.
       
      .google.cloud.aiplatform.v1.PreTunedModel pre_tuned_model = 31;
      Returns:
      Whether the preTunedModel field is set.
    • getPreTunedModel

      PreTunedModel getPreTunedModel()
       The pre-tuned model for continuous tuning.
       
      .google.cloud.aiplatform.v1.PreTunedModel pre_tuned_model = 31;
      Returns:
      The preTunedModel.
    • getPreTunedModelOrBuilder

      PreTunedModelOrBuilder getPreTunedModelOrBuilder()
       The pre-tuned model for continuous tuning.
       
      .google.cloud.aiplatform.v1.PreTunedModel pre_tuned_model = 31;
    • hasSupervisedTuningSpec

      boolean hasSupervisedTuningSpec()
       Tuning Spec for Supervised Fine Tuning.
       
      .google.cloud.aiplatform.v1.SupervisedTuningSpec supervised_tuning_spec = 5;
      Returns:
      Whether the supervisedTuningSpec field is set.
    • getSupervisedTuningSpec

      SupervisedTuningSpec getSupervisedTuningSpec()
       Tuning Spec for Supervised Fine Tuning.
       
      .google.cloud.aiplatform.v1.SupervisedTuningSpec supervised_tuning_spec = 5;
      Returns:
      The supervisedTuningSpec.
    • getSupervisedTuningSpecOrBuilder

      SupervisedTuningSpecOrBuilder getSupervisedTuningSpecOrBuilder()
       Tuning Spec for Supervised Fine Tuning.
       
      .google.cloud.aiplatform.v1.SupervisedTuningSpec supervised_tuning_spec = 5;
    • getName

      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];
      Returns:
      The name.
    • getNameBytes

      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];
      Returns:
      The bytes for name.
    • getTunedModelDisplayName

      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. For continuous
       tuning, tuned_model_display_name will by default use the same display name
       as the pre-tuned model. If a new display name is provided, the tuning job
       will create a new model instead of a new version.
       
      string tuned_model_display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The tunedModelDisplayName.
    • getTunedModelDisplayNameBytes

      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. For continuous
       tuning, tuned_model_display_name will by default use the same display name
       as the pre-tuned model. If a new display name is provided, the tuning job
       will create a new model instead of a new version.
       
      string tuned_model_display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for tunedModelDisplayName.
    • getDescription

      String getDescription()
       Optional. The description of the
       [TuningJob][google.cloud.aiplatform.v1.TuningJob].
       
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.
    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The description of the
       [TuningJob][google.cloud.aiplatform.v1.TuningJob].
       
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.
    • getStateValue

      int getStateValue()
       Output only. The detailed state of the job.
       
      .google.cloud.aiplatform.v1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.
    • getState

      JobState getState()
       Output only. The detailed state of the job.
       
      .google.cloud.aiplatform.v1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.
    • hasCreateTime

      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];
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      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];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      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];
    • hasStartTime

      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];
      Returns:
      Whether the startTime field is set.
    • getStartTime

      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];
      Returns:
      The startTime.
    • getStartTimeOrBuilder

      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];
    • hasEndTime

      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];
      Returns:
      Whether the endTime field is set.
    • getEndTime

      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];
      Returns:
      The endTime.
    • getEndTimeOrBuilder

      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];
    • hasUpdateTime

      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];
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      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];
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      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];
    • hasError

      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];
      Returns:
      Whether the error field is set.
    • getError

      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];
      Returns:
      The error.
    • getErrorOrBuilder

      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];
    • getLabelsCount

      int getLabelsCount()
       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];
    • containsLabels

      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];
    • getLabels

      Deprecated.
      Use getLabelsMap() instead.
    • getLabelsMap

      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];
    • getLabelsOrDefault

      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];
    • getLabelsOrThrow

      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];
    • getExperiment

      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) = { ... }
      Returns:
      The experiment.
    • getExperimentBytes

      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) = { ... }
      Returns:
      The bytes for experiment.
    • hasTunedModel

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

      TunedModel getTunedModel()
       Output only. The tuned model resources associated with this
       [TuningJob][google.cloud.aiplatform.v1.TuningJob].
       
      .google.cloud.aiplatform.v1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The tunedModel.
    • getTunedModelOrBuilder

      TunedModelOrBuilder getTunedModelOrBuilder()
       Output only. The tuned model resources associated with this
       [TuningJob][google.cloud.aiplatform.v1.TuningJob].
       
      .google.cloud.aiplatform.v1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasTuningDataStats

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

      TuningDataStats getTuningDataStats()
       Output only. The tuning data statistics associated with this
       [TuningJob][google.cloud.aiplatform.v1.TuningJob].
       
      .google.cloud.aiplatform.v1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The tuningDataStats.
    • getTuningDataStatsOrBuilder

      TuningDataStatsOrBuilder getTuningDataStatsOrBuilder()
       Output only. The tuning data statistics associated with this
       [TuningJob][google.cloud.aiplatform.v1.TuningJob].
       
      .google.cloud.aiplatform.v1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasEncryptionSpec

      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.v1.EncryptionSpec encryption_spec = 16;
      Returns:
      Whether the encryptionSpec field is set.
    • getEncryptionSpec

      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.v1.EncryptionSpec encryption_spec = 16;
      Returns:
      The encryptionSpec.
    • getEncryptionSpecOrBuilder

      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.v1.EncryptionSpec encryption_spec = 16;
    • getServiceAccount

      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;
      Returns:
      The serviceAccount.
    • getServiceAccountBytes

      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;
      Returns:
      The bytes for serviceAccount.
    • getEvaluateDatasetRunsList

      List<EvaluateDatasetRun> getEvaluateDatasetRunsList()
       Output only. Evaluation runs for the Tuning Job.
       
      repeated .google.cloud.aiplatform.v1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getEvaluateDatasetRuns

      EvaluateDatasetRun getEvaluateDatasetRuns(int index)
       Output only. Evaluation runs for the Tuning Job.
       
      repeated .google.cloud.aiplatform.v1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getEvaluateDatasetRunsCount

      int getEvaluateDatasetRunsCount()
       Output only. Evaluation runs for the Tuning Job.
       
      repeated .google.cloud.aiplatform.v1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getEvaluateDatasetRunsOrBuilderList

      List<? extends EvaluateDatasetRunOrBuilder> getEvaluateDatasetRunsOrBuilderList()
       Output only. Evaluation runs for the Tuning Job.
       
      repeated .google.cloud.aiplatform.v1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getEvaluateDatasetRunsOrBuilder

      EvaluateDatasetRunOrBuilder getEvaluateDatasetRunsOrBuilder(int index)
       Output only. Evaluation runs for the Tuning Job.
       
      repeated .google.cloud.aiplatform.v1.EvaluateDatasetRun evaluate_dataset_runs = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getSourceModelCase

      TuningJob.SourceModelCase getSourceModelCase()
    • getTuningSpecCase

      TuningJob.TuningSpecCase getTuningSpecCase()