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

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

Service Description: A service for creating and managing Vertex AI's jobs.

This class is currently experimental and may be subject to changes.

Methods

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

batchPredictionJobName

Formats a string containing the fully-qualified path to represent a batch_prediction_job resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`batchPredictionJob`	`string`

Returns
Type	Description
`string`	The formatted batch_prediction_job resource.

contextName

Formats a string containing the fully-qualified path to represent a context resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`metadataStore`	`string`
`context`	`string`

Returns
Type	Description
`string`	The formatted context resource.

customJobName

Formats a string containing the fully-qualified path to represent a custom_job resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`customJob`	`string`

Returns
Type	Description
`string`	The formatted custom_job resource.

dataLabelingJobName

Formats a string containing the fully-qualified path to represent a data_labeling_job resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataLabelingJob`	`string`

Returns
Type	Description
`string`	The formatted data_labeling_job resource.

datasetName

Formats a string containing the fully-qualified path to represent a dataset resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataset`	`string`

Returns
Type	Description
`string`	The formatted dataset resource.

endpointName

Formats a string containing the fully-qualified path to represent a endpoint resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`endpoint`	`string`

Returns
Type	Description
`string`	The formatted endpoint resource.

hyperparameterTuningJobName

Formats a string containing the fully-qualified path to represent a hyperparameter_tuning_job resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`hyperparameterTuningJob`	`string`

Returns
Type	Description
`string`	The formatted hyperparameter_tuning_job resource.

locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

modelName

Formats a string containing the fully-qualified path to represent a model resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`model`	`string`

Returns
Type	Description
`string`	The formatted model resource.

modelDeploymentMonitoringJobName

Formats a string containing the fully-qualified path to represent a model_deployment_monitoring_job resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`modelDeploymentMonitoringJob`	`string`

Returns
Type	Description
`string`	The formatted model_deployment_monitoring_job resource.

nasJobName

Formats a string containing the fully-qualified path to represent a nas_job resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`nasJob`	`string`

Returns
Type	Description
`string`	The formatted nas_job resource.

nasTrialDetailName

Formats a string containing the fully-qualified path to represent a nas_trial_detail resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`nasJob`	`string`
`nasTrialDetail`	`string`

Returns
Type	Description
`string`	The formatted nas_trial_detail resource.

networkName

Formats a string containing the fully-qualified path to represent a network resource.

Parameters
Name	Description
`project`	`string`
`network`	`string`

Returns
Type	Description
`string`	The formatted network resource.

projectLocationEndpointName

Formats a string containing the fully-qualified path to represent a project_location_endpoint resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`endpoint`	`string`

Returns
Type	Description
`string`	The formatted project_location_endpoint resource.

projectLocationPublisherModelName

Formats a string containing the fully-qualified path to represent a project_location_publisher_model resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`publisher`	`string`
`model`	`string`

Returns
Type	Description
`string`	The formatted project_location_publisher_model resource.

tensorboardName

Formats a string containing the fully-qualified path to represent a tensorboard resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`tensorboard`	`string`

Returns
Type	Description
`string`	The formatted tensorboard resource.

parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

batchPredictionJob: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}
context: projects/{project}/locations/{location}/metadataStores/{metadata_store}/contexts/{context}
customJob: projects/{project}/locations/{location}/customJobs/{custom_job}
dataLabelingJob: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}
dataset: projects/{project}/locations/{location}/datasets/{dataset}
endpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
hyperparameterTuningJob: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}
location: projects/{project}/locations/{location}
model: projects/{project}/locations/{location}/models/{model}
modelDeploymentMonitoringJob: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}
nasJob: projects/{project}/locations/{location}/nasJobs/{nas_job}
nasTrialDetail: projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}
network: projects/{project}/global/networks/{network}
projectLocationEndpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
projectLocationPublisherModel: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}
tensorboard: projects/{project}/locations/{location}/tensorboards/{tensorboard}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

__call

Handles execution of the async variants for each documented method.

Parameters
Name	Description
`method`	`mixed`
`args`	`mixed`

cancelBatchPredictionJob

Cancels a BatchPredictionJob.

Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::cancelBatchPredictionJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CancelBatchPredictionJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

cancelCustomJob

Cancels a CustomJob.

Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and CustomJob.state is set to CANCELLED.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::cancelCustomJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CancelCustomJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

cancelDataLabelingJob

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::cancelDataLabelingJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CancelDataLabelingJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

cancelHyperparameterTuningJob

Cancels a HyperparameterTuningJob.

Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::cancelHyperparameterTuningJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CancelHyperparameterTuningJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

cancelNasJob

Cancels a NasJob.

Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::cancelNasJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CancelNasJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

createBatchPredictionJob

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createBatchPredictionJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateBatchPredictionJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\BatchPredictionJob`

createCustomJob

Creates a CustomJob. A created CustomJob right away will be attempted to be run.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createCustomJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateCustomJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\CustomJob`

createDataLabelingJob

Creates a DataLabelingJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createDataLabelingJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateDataLabelingJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\DataLabelingJob`

createHyperparameterTuningJob

Creates a HyperparameterTuningJob

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createHyperparameterTuningJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateHyperparameterTuningJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\HyperparameterTuningJob`

createModelDeploymentMonitoringJob

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createModelDeploymentMonitoringJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateModelDeploymentMonitoringJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\ModelDeploymentMonitoringJob`

createNasJob

Creates a NasJob

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createNasJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateNasJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\NasJob`

deleteBatchPredictionJob

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteBatchPredictionJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteBatchPredictionJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteCustomJob

Deletes a CustomJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteCustomJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteCustomJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteDataLabelingJob

Deletes a DataLabelingJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteDataLabelingJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteDataLabelingJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteHyperparameterTuningJob

Deletes a HyperparameterTuningJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteHyperparameterTuningJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteHyperparameterTuningJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteModelDeploymentMonitoringJob

Deletes a ModelDeploymentMonitoringJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteModelDeploymentMonitoringJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteModelDeploymentMonitoringJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteNasJob

Deletes a NasJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteNasJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteNasJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

getBatchPredictionJob

Gets a BatchPredictionJob

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getBatchPredictionJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetBatchPredictionJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\BatchPredictionJob`

getCustomJob

Gets a CustomJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getCustomJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetCustomJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\CustomJob`

getDataLabelingJob

Gets a DataLabelingJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getDataLabelingJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetDataLabelingJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\DataLabelingJob`

getHyperparameterTuningJob

Gets a HyperparameterTuningJob

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getHyperparameterTuningJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetHyperparameterTuningJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\HyperparameterTuningJob`

getModelDeploymentMonitoringJob

Gets a ModelDeploymentMonitoringJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getModelDeploymentMonitoringJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetModelDeploymentMonitoringJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\ModelDeploymentMonitoringJob`

getNasJob

Gets a NasJob

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getNasJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetNasJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\NasJob`

getNasTrialDetail

Gets a NasTrialDetail.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getNasTrialDetailAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetNasTrialDetailRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\NasTrialDetail`

listBatchPredictionJobs

Lists BatchPredictionJobs in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listBatchPredictionJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListBatchPredictionJobsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listCustomJobs

Lists CustomJobs in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listCustomJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListCustomJobsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listDataLabelingJobs

Lists DataLabelingJobs in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listDataLabelingJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListDataLabelingJobsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listHyperparameterTuningJobs

Lists HyperparameterTuningJobs in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listHyperparameterTuningJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListHyperparameterTuningJobsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listModelDeploymentMonitoringJobs

Lists ModelDeploymentMonitoringJobs in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listModelDeploymentMonitoringJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListModelDeploymentMonitoringJobsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listNasJobs

Lists NasJobs in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listNasJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListNasJobsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listNasTrialDetails

List top NasTrialDetails of a NasJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listNasTrialDetailsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListNasTrialDetailsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

pauseModelDeploymentMonitoringJob

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::pauseModelDeploymentMonitoringJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\PauseModelDeploymentMonitoringJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

resumeModelDeploymentMonitoringJob

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::resumeModelDeploymentMonitoringJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ResumeModelDeploymentMonitoringJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

searchModelDeploymentMonitoringStatsAnomalies

Searches Model Monitoring Statistics generated within a given time window.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::searchModelDeploymentMonitoringStatsAnomaliesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\SearchModelDeploymentMonitoringStatsAnomaliesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

updateModelDeploymentMonitoringJob

Updates a ModelDeploymentMonitoringJob.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::updateModelDeploymentMonitoringJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\UpdateModelDeploymentMonitoringJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

getLocation

Gets information about a location.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Location\Location`

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::setIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\TestIamPermissionsResponse`