Google Cloud Ai Platform V1 Client - Class CancelHyperparameterTuningJobRequest (0.17.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class CancelHyperparameterTuningJobRequest.

Request message for JobService.CancelHyperparameterTuningJob.

Generated from protobuf message google.cloud.aiplatform.v1.CancelHyperparameterTuningJobRequest

Methods

build

Parameter
NameDescription
name string

Required. The name of the HyperparameterTuningJob to cancel. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job} Please see {@see \Google\Cloud\AIPlatform\V1\JobServiceClient::hyperparameterTuningJobName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\CancelHyperparameterTuningJobRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the HyperparameterTuningJob to cancel. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

getName

Required. The name of the HyperparameterTuningJob to cancel.

Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Returns
TypeDescription
string

setName

Required. The name of the HyperparameterTuningJob to cancel.

Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Parameter
NameDescription
var string
Returns
TypeDescription
$this