Stay organized with collections
Save and categorize content based on your preferences.
Resource: HyperparameterTuningJob
Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.
Fields
name
string
Output only. Resource name of the HyperparameterTuningJob.
displayName
string
Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Output only. time when the HyperparameterTuningJob was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. time when the HyperparameterTuningJob was most recently updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
labels
map (key: string, value: string)
The labels with user-defined metadata to organize HyperparameterTuningJobs.
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.
Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# REST Resource: projects.locations.hyperparameterTuningJobs\n\nResource: HyperparameterTuningJob\n---------------------------------\n\nRepresents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.\nFields `name` `string` \nOutput only. Resource name of the HyperparameterTuningJob.\n`displayName` `string` \nRequired. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n`studySpec` `object (`[StudySpec](/vertex-ai/docs/reference/rest/v1/StudySpec)`)` \nRequired. Study configuration of the HyperparameterTuningJob.\n`maxTrialCount` `integer` \nRequired. The desired total number of Trials.\n`parallelTrialCount` `integer` \nRequired. The desired number of Trials to run in parallel.\n`maxFailedTrialCount` `integer` \nThe number of failed Trials that need to be seen before failing the HyperparameterTuningJob.\n\nIf set to 0, Vertex AI decides how many Trials must fail before the whole job fails.\n`trialJobSpec` `object (`[CustomJobSpec](/vertex-ai/docs/reference/rest/v1/CustomJobSpec)`)` \nRequired. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.\n`trials[]` `object (`[Trial](/vertex-ai/docs/reference/rest/v1/projects.locations.studies.trials#Trial)`)` \nOutput only. Trials of the HyperparameterTuningJob.\n`state` `enum (`[JobState](/vertex-ai/docs/reference/rest/v1/JobState)`)` \nOutput only. The detailed state of the job.\n`createTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. time when the HyperparameterTuningJob was created.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`startTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`endTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`updateTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. time when the HyperparameterTuningJob was most recently updated.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`error` `object (`[Status](/vertex-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Status)`)` \nOutput only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.\n`labels` `map (key: string, value: string)` \nThe labels with user-defined metadata to organize HyperparameterTuningJobs.\n\nlabel 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.\n\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels.\n`encryptionSpec` `object (`[EncryptionSpec](/vertex-ai/docs/reference/rest/v1/EncryptionSpec)`)` \nCustomer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.\n`satisfiesPzs` `boolean` \nOutput only. reserved for future use.\n`satisfiesPzi` `boolean` \nOutput only. reserved for future use."]]
