Class TuningJob (3.47.0)

public final class TuningJob extends GeneratedMessageV3 implements TuningJobOrBuilder

Represents a TuningJob that runs with Google owned models.

Protobuf type google.cloud.aiplatform.v1beta1.TuningJob

Implements

TuningJobOrBuilder

Static Fields

BASE_MODEL_FIELD_NUMBER

public static final int BASE_MODEL_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_SPEC_FIELD_NUMBER

public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

EXPERIMENT_FIELD_NUMBER

public static final int EXPERIMENT_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

SUPERVISED_TUNING_SPEC_FIELD_NUMBER

public static final int SUPERVISED_TUNING_SPEC_FIELD_NUMBER
Field Value
Type Description
int

TUNED_MODEL_DISPLAY_NAME_FIELD_NUMBER

public static final int TUNED_MODEL_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

TUNED_MODEL_FIELD_NUMBER

public static final int TUNED_MODEL_FIELD_NUMBER
Field Value
Type Description
int

TUNING_DATA_STATS_FIELD_NUMBER

public static final int TUNING_DATA_STATS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TuningJob getDefaultInstance()
Returns
Type Description
TuningJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TuningJob.Builder newBuilder()
Returns
Type Description
TuningJob.Builder

newBuilder(TuningJob prototype)

public static TuningJob.Builder newBuilder(TuningJob prototype)
Parameter
Name Description
prototype TuningJob
Returns
Type Description
TuningJob.Builder

parseDelimitedFrom(InputStream input)

public static TuningJob parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TuningJob
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TuningJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TuningJob
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TuningJob parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TuningJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TuningJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TuningJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TuningJob parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TuningJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TuningJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TuningJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TuningJob parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TuningJob
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TuningJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TuningJob
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TuningJob parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TuningJob
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TuningJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TuningJob
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TuningJob parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TuningJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TuningJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TuningJob
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TuningJob> parser()
Returns
Type Description
Parser<TuningJob>

Methods

containsLabels(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBaseModel()

public 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 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 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 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

getDefaultInstanceForType()

public TuningJob getDefaultInstanceForType()
Returns
Type Description
TuningJob

getDescription()

public String getDescription()

Optional. The description of the TuningJob.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public 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 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;

Returns
Type Description
EncryptionSpec

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;

Returns
Type Description
EncryptionSpecOrBuilder

getEndTime()

public 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 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 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 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 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

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

getParserForType()

public Parser<TuningJob> getParserForType()
Returns
Type Description
Parser<TuningJob>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceModelCase()

public TuningJob.SourceModelCase getSourceModelCase()
Returns
Type Description
TuningJob.SourceModelCase

getStartTime()

public 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 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 JobState getState()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1beta1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
JobState

The state.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getSupervisedTuningSpec()

public SupervisedTuningSpec getSupervisedTuningSpec()

Tuning Spec for Supervised Fine Tuning.

.google.cloud.aiplatform.v1beta1.SupervisedTuningSpec supervised_tuning_spec = 5;

Returns
Type Description
SupervisedTuningSpec

The supervisedTuningSpec.

getSupervisedTuningSpecOrBuilder()

public SupervisedTuningSpecOrBuilder getSupervisedTuningSpecOrBuilder()

Tuning Spec for Supervised Fine Tuning.

.google.cloud.aiplatform.v1beta1.SupervisedTuningSpec supervised_tuning_spec = 5;

Returns
Type Description
SupervisedTuningSpecOrBuilder

getTunedModel()

public TunedModel getTunedModel()

Output only. The tuned model resources assiociated with this TuningJob.

.google.cloud.aiplatform.v1beta1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TunedModel

The tunedModel.

getTunedModelDisplayName()

public 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 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 TunedModelOrBuilder getTunedModelOrBuilder()

Output only. The tuned model resources assiociated with this TuningJob.

.google.cloud.aiplatform.v1beta1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TunedModelOrBuilder

getTuningDataStats()

public TuningDataStats getTuningDataStats()

Output only. The tuning data statistics associated with this TuningJob.

.google.cloud.aiplatform.v1beta1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TuningDataStats

The tuningDataStats.

getTuningDataStatsOrBuilder()

public TuningDataStatsOrBuilder getTuningDataStatsOrBuilder()

Output only. The tuning data statistics associated with this TuningJob.

.google.cloud.aiplatform.v1beta1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TuningDataStatsOrBuilder

getTuningSpecCase()

public TuningJob.TuningSpecCase getTuningSpecCase()
Returns
Type Description
TuningJob.TuningSpecCase

getUpdateTime()

public 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 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 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 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 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;

Returns
Type Description
boolean

Whether the encryptionSpec field is set.

hasEndTime()

public 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 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 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 boolean hasSupervisedTuningSpec()

Tuning Spec for Supervised Fine Tuning.

.google.cloud.aiplatform.v1beta1.SupervisedTuningSpec supervised_tuning_spec = 5;

Returns
Type Description
boolean

Whether the supervisedTuningSpec field is set.

hasTunedModel()

public boolean hasTunedModel()

Output only. The tuned model resources assiociated with this TuningJob.

.google.cloud.aiplatform.v1beta1.TunedModel tuned_model = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the tunedModel field is set.

hasTuningDataStats()

public boolean hasTuningDataStats()

Output only. The tuning data statistics associated with this TuningJob.

.google.cloud.aiplatform.v1beta1.TuningDataStats tuning_data_stats = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the tuningDataStats field is set.

hasUpdateTime()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TuningJob.Builder newBuilderForType()
Returns
Type Description
TuningJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TuningJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TuningJob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TuningJob.Builder toBuilder()
Returns
Type Description
TuningJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException