# Google Cloud Ai Platform V1 Client - Class HyperparameterTuningJob (1.60.0)

1.60.0 (latest) 1.59.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.1 1.31.0 1.30.0 1.26.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.1 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.39.0 0.38.0 0.37.1 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.1 0.10.0 Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class HyperparameterTuningJob.

Represents a HyperparameterTuningJob. A HyperparameterTuningJob
has a Study specification and multiple CustomJobs with identical
CustomJob specification.

Generated from protobuf message `google.cloud.aiplatform.v1.HyperparameterTuningJob`

## Namespace

Google \\ Cloud \\ AIPlatform \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Output only. Resource name of the HyperparameterTuningJob. |
| `↳ display_name` | `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. |
| `↳ study_spec` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.StudySpec` Required. Study configuration of the HyperparameterTuningJob. |
| `↳ max_trial_count` | `int` Required. The desired total number of Trials. |
| `↳ parallel_trial_count` | `int` Required. The desired number of Trials to run in parallel. |
| `↳ max_failed_trial_count` | `int` The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails. |
| `↳ trial_job_spec` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.CustomJobSpec` Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials. |
| `↳ trials` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Trial>` Output only. Trials of the HyperparameterTuningJob. |
| `↳ state` | `int` Output only. The detailed state of the job. |
| `↳ create_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Time when the HyperparameterTuningJob was created. |
| `↳ start_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state. |
| `↳ end_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. |
| `↳ update_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. Time when the HyperparameterTuningJob was most recently updated. |
| `↳ error` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Status.html` Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. |
| `↳ labels` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` 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. See <https://goo.gl/xmQnxf> for more information and examples of labels. |
| `↳ encryption_spec` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EncryptionSpec` 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. |
| `↳ satisfies_pzs` | `bool` Output only. Reserved for future use. |
| `↳ satisfies_pzi` | `bool` Output only. Reserved for future use. |

### getName

Output only. Resource name of the HyperparameterTuningJob.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Output only. Resource name of the HyperparameterTuningJob.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDisplayName

Required. The display name of the HyperparameterTuningJob.

The name can be up to 128 characters long and can consist of any UTF-8
characters.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDisplayName

Required. The display name of the HyperparameterTuningJob.

The name can be up to 128 characters long and can consist of any UTF-8
characters.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStudySpec

Required. Study configuration of the HyperparameterTuningJob.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.StudySpec|null` |   |

### hasStudySpec

### clearStudySpec

### setStudySpec

Required. Study configuration of the HyperparameterTuningJob.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.StudySpec` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getMaxTrialCount

Required. The desired total number of Trials.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setMaxTrialCount

Required. The desired total number of Trials.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getParallelTrialCount

Required. The desired number of Trials to run in parallel.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setParallelTrialCount

Required. The desired number of Trials to run in parallel.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getMaxFailedTrialCount

The number of failed Trials that need to be seen before failing
the HyperparameterTuningJob.

If set to 0, Vertex AI decides how many Trials must fail
before the whole job fails.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setMaxFailedTrialCount

The number of failed Trials that need to be seen before failing
the HyperparameterTuningJob.

If set to 0, Vertex AI decides how many Trials must fail
before the whole job fails.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTrialJobSpec

Required. The spec of a trial job. The same spec applies to the CustomJobs
created in all the trials.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.CustomJobSpec|null` |   |

### hasTrialJobSpec

### clearTrialJobSpec

### setTrialJobSpec

Required. The spec of a trial job. The same spec applies to the CustomJobs
created in all the trials.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.CustomJobSpec` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTrials

Output only. Trials of the HyperparameterTuningJob.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Trial>` |   |

### setTrials

Output only. Trials of the HyperparameterTuningJob.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Trial>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getState

Output only. The detailed state of the job.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [JobState](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.JobState). |

### setState

Output only. The detailed state of the job.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [JobState](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.JobState). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCreateTime

Output only. Time when the HyperparameterTuningJob was created.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasCreateTime

### clearCreateTime

### setCreateTime

Output only. Time when the HyperparameterTuningJob was created.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStartTime

Output only. Time when the HyperparameterTuningJob for the first time
entered the `JOB_STATE_RUNNING` state.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasStartTime

### clearStartTime

### setStartTime

Output only. Time when the HyperparameterTuningJob for the first time
entered the `JOB_STATE_RUNNING` state.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEndTime

Output only. Time when the HyperparameterTuningJob entered any of the
following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
`JOB_STATE_CANCELLED`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasEndTime

### clearEndTime

### setEndTime

Output only. Time when the HyperparameterTuningJob entered any of the
following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
`JOB_STATE_CANCELLED`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getUpdateTime

Output only. Time when the HyperparameterTuningJob was most recently
updated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasUpdateTime

### clearUpdateTime

### setUpdateTime

Output only. Time when the HyperparameterTuningJob was most recently
updated.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getError

Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Status.html|null` |   |

### hasError

### clearError

### setError

Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Status.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLabels

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.
See <https://goo.gl/xmQnxf> for more information and examples of labels.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setLabels

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.
See <https://goo.gl/xmQnxf> for more information and examples of labels.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEncryptionSpec

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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EncryptionSpec|null` |   |

### hasEncryptionSpec

### clearEncryptionSpec

### setEncryptionSpec

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.EncryptionSpec` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSatisfiesPzs

Output only. Reserved for future use.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setSatisfiesPzs

Output only. Reserved for future use.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSatisfiesPzi

Output only. Reserved for future use.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setSatisfiesPzi

Output only. Reserved for future use.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |