- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface TuningJobOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and 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];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBaseModel()
public abstract String getBaseModel()The base model that is being tuned, e.g., "gemini-1.0-pro-002".
string base_model = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The baseModel. |
getBaseModelBytes()
public abstract ByteString getBaseModelBytes()The base model that is being tuned, e.g., "gemini-1.0-pro-002".
string base_model = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for baseModel. |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Time when the TuningJob was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Time when the TuningJob was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDescription()
public abstract String getDescription()Optional. The description of the TuningJob.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()Optional. The description of the TuningJob.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getEncryptionSpec()
public abstract 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 | |
|---|---|
| Type | Description |
EncryptionSpec |
The encryptionSpec. |
getEncryptionSpecOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpecOrBuilder |
|
getEndTime()
public abstract Timestamp getEndTime() Output only. Time when the TuningJob entered any of the following
JobStates: 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 | |
|---|---|
| Type | Description |
Timestamp |
The endTime. |
getEndTimeOrBuilder()
public abstract TimestampOrBuilder getEndTimeOrBuilder() Output only. Time when the TuningJob entered any of the following
JobStates: 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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getError()
public abstract 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 | |
|---|---|
| Type | Description |
com.google.rpc.Status |
The error. |
getErrorOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder |
|
getExperiment()
public abstract String getExperiment()Output only. The Experiment associated with this TuningJob.
string experiment = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The experiment. |
getExperimentBytes()
public abstract ByteString getExperimentBytes()Output only. The Experiment associated with this TuningJob.
string experiment = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for experiment. |
getLabels() (deprecated)
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract int getLabelsCount()Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and 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];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public abstract Map<String,String> getLabelsMap()Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and 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];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue)Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and 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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key)Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and 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];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getServiceAccount()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The serviceAccount. |
getServiceAccountBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccount. |
getSourceModelCase()
public abstract TuningJob.SourceModelCase getSourceModelCase()| Returns | |
|---|---|
| Type | Description |
TuningJob.SourceModelCase |
|
getStartTime()
public abstract Timestamp getStartTime() Output only. Time when the
TuningJob for the first time
entered the JOB_STATE_RUNNING state.
.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The startTime. |
getStartTimeOrBuilder()
public abstract TimestampOrBuilder getStartTimeOrBuilder() Output only. Time when the
TuningJob for the first time
entered the JOB_STATE_RUNNING state.
.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getState()
public abstract JobState getState()Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
JobState |
The state. |
getStateValue()
public abstract int getStateValue()Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getSupervisedTuningSpec()
public abstract SupervisedTuningSpec getSupervisedTuningSpec()Tuning Spec for Supervised Fine Tuning.
.google.cloud.aiplatform.v1.SupervisedTuningSpec supervised_tuning_spec = 5;
| Returns | |
|---|---|
| Type | Description |
SupervisedTuningSpec |
The supervisedTuningSpec. |
getSupervisedTuningSpecOrBuilder()
public abstract SupervisedTuningSpecOrBuilder getSupervisedTuningSpecOrBuilder()Tuning Spec for Supervised Fine Tuning.
.google.cloud.aiplatform.v1.SupervisedTuningSpec supervised_tuning_spec = 5;
| Returns | |
|---|---|
| Type | Description |
SupervisedTuningSpecOrBuilder |
|
getTunedModel()
public abstract TunedModel getTunedModel()Output only. The tuned model resources assiociated with this TuningJob.
.google.cloud.aiplatform.v1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TunedModel |
The tunedModel. |
getTunedModelDisplayName()
public abstract String getTunedModelDisplayName()Optional. The display name of the TunedModel. 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];
| Returns | |
|---|---|
| Type | Description |
String |
The tunedModelDisplayName. |
getTunedModelDisplayNameBytes()
public abstract ByteString getTunedModelDisplayNameBytes()Optional. The display name of the TunedModel. 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for tunedModelDisplayName. |
getTunedModelOrBuilder()
public abstract TunedModelOrBuilder getTunedModelOrBuilder()Output only. The tuned model resources assiociated with this TuningJob.
.google.cloud.aiplatform.v1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TunedModelOrBuilder |
|
getTuningDataStats()
public abstract TuningDataStats getTuningDataStats()Output only. The tuning data statistics associated with this TuningJob.
.google.cloud.aiplatform.v1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TuningDataStats |
The tuningDataStats. |
getTuningDataStatsOrBuilder()
public abstract TuningDataStatsOrBuilder getTuningDataStatsOrBuilder()Output only. The tuning data statistics associated with this TuningJob.
.google.cloud.aiplatform.v1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TuningDataStatsOrBuilder |
|
getTuningSpecCase()
public abstract TuningJob.TuningSpecCase getTuningSpecCase()| Returns | |
|---|---|
| Type | Description |
TuningJob.TuningSpecCase |
|
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. Time when the TuningJob was most recently updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Time when the TuningJob was most recently updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasBaseModel()
public abstract boolean hasBaseModel()The base model that is being tuned, e.g., "gemini-1.0-pro-002".
string base_model = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the baseModel field is set. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Time when the TuningJob was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasEncryptionSpec()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionSpec field is set. |
hasEndTime()
public abstract boolean hasEndTime() Output only. Time when the TuningJob entered any of the following
JobStates: 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 | |
|---|---|
| Type | Description |
boolean |
Whether the endTime field is set. |
hasError()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the error field is set. |
hasStartTime()
public abstract boolean hasStartTime() Output only. Time when the
TuningJob for the first time
entered the JOB_STATE_RUNNING state.
.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the startTime field is set. |
hasSupervisedTuningSpec()
public abstract boolean hasSupervisedTuningSpec()Tuning Spec for Supervised Fine Tuning.
.google.cloud.aiplatform.v1.SupervisedTuningSpec supervised_tuning_spec = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the supervisedTuningSpec field is set. |
hasTunedModel()
public abstract boolean hasTunedModel()Output only. The tuned model resources assiociated with this TuningJob.
.google.cloud.aiplatform.v1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the tunedModel field is set. |
hasTuningDataStats()
public abstract boolean hasTuningDataStats()Output only. The tuning data statistics associated with this TuningJob.
.google.cloud.aiplatform.v1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the tuningDataStats field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. Time when the TuningJob was most recently updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |