- 1.35.0 (latest)
- 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 JobServiceClient.
Service Description: A service for creating and managing Vertex AI's jobs.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ AIPlatform \ V1 \ ClientMethods
__construct
Constructor.
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.
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() .
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() .
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() .
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() .
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() .
request
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() .
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.
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() .
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.
createDataLabelingJob
Creates a DataLabelingJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createDataLabelingJobAsync() .
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.
createHyperparameterTuningJob
Creates a HyperparameterTuningJob
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createHyperparameterTuningJobAsync() .
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.
createModelDeploymentMonitoringJob
Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createModelDeploymentMonitoringJobAsync() .
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.
createNasJob
Creates a NasJob
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createNasJobAsync() .
request
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.
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() .
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.
deleteCustomJob
Deletes a CustomJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteCustomJobAsync() .
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.
deleteDataLabelingJob
Deletes a DataLabelingJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteDataLabelingJobAsync() .
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.
deleteHyperparameterTuningJob
Deletes a HyperparameterTuningJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteHyperparameterTuningJobAsync() .
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.
deleteModelDeploymentMonitoringJob
Deletes a ModelDeploymentMonitoringJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteModelDeploymentMonitoringJobAsync() .
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.
deleteNasJob
Deletes a NasJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteNasJobAsync() .
request
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.
getBatchPredictionJob
Gets a BatchPredictionJob
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getBatchPredictionJobAsync() .
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.
getCustomJob
Gets a CustomJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getCustomJobAsync() .
request
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.
getDataLabelingJob
Gets a DataLabelingJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getDataLabelingJobAsync() .
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.
getHyperparameterTuningJob
Gets a HyperparameterTuningJob
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getHyperparameterTuningJobAsync() .
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.
getModelDeploymentMonitoringJob
Gets a ModelDeploymentMonitoringJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getModelDeploymentMonitoringJobAsync() .
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.
getNasJob
Gets a NasJob
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getNasJobAsync() .
request
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.
getNasTrialDetail
Gets a NasTrialDetail.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getNasTrialDetailAsync() .
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.
listBatchPredictionJobs
Lists BatchPredictionJobs in a Location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listBatchPredictionJobsAsync() .
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.
listCustomJobs
Lists CustomJobs in a Location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listCustomJobsAsync() .
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.
listDataLabelingJobs
Lists DataLabelingJobs in a Location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listDataLabelingJobsAsync() .
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.
listHyperparameterTuningJobs
Lists HyperparameterTuningJobs in a Location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listHyperparameterTuningJobsAsync() .
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.
listModelDeploymentMonitoringJobs
Lists ModelDeploymentMonitoringJobs in a Location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listModelDeploymentMonitoringJobsAsync() .
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.
listNasJobs
Lists NasJobs in a Location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listNasJobsAsync() .
request
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.
listNasTrialDetails
List top NasTrialDetails of a NasJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listNasTrialDetailsAsync() .
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.
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() .
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() .
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() .
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.
updateModelDeploymentMonitoringJob
Updates a ModelDeploymentMonitoringJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::updateModelDeploymentMonitoringJobAsync() .
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getLocationAsync() .
request
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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listLocationsAsync() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
cancelBatchPredictionJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
cancelCustomJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
cancelDataLabelingJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
cancelHyperparameterTuningJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
cancelNasJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createBatchPredictionJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createCustomJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createDataLabelingJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createHyperparameterTuningJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createModelDeploymentMonitoringJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createNasJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteBatchPredictionJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteCustomJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteDataLabelingJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteHyperparameterTuningJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteModelDeploymentMonitoringJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteNasJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getBatchPredictionJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getCustomJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getDataLabelingJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getHyperparameterTuningJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getModelDeploymentMonitoringJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getNasJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getNasTrialDetailAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listBatchPredictionJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listCustomJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listDataLabelingJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listHyperparameterTuningJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listModelDeploymentMonitoringJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listNasJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listNasTrialDetailsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
pauseModelDeploymentMonitoringJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
resumeModelDeploymentMonitoringJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
searchModelDeploymentMonitoringStatsAnomaliesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateModelDeploymentMonitoringJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLocationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLocationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getIamPolicyAsync
GuzzleHttp\Promise\PromiseInterface
setIamPolicyAsync
GuzzleHttp\Promise\PromiseInterface
testIamPermissionsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::batchPredictionJobName
Formats a string containing the fully-qualified path to represent a batch_prediction_job resource.
project
string
location
string
batchPredictionJob
string
string
static::contextName
Formats a string containing the fully-qualified path to represent a context resource.
project
string
location
string
metadataStore
string
context
string
string
static::customJobName
Formats a string containing the fully-qualified path to represent a custom_job resource.
project
string
location
string
customJob
string
string
static::dataLabelingJobName
Formats a string containing the fully-qualified path to represent a data_labeling_job resource.
project
string
location
string
dataLabelingJob
string
string
static::datasetName
Formats a string containing the fully-qualified path to represent a dataset resource.
project
string
location
string
dataset
string
string
static::endpointName
Formats a string containing the fully-qualified path to represent a endpoint resource.
project
string
location
string
endpoint
string
string
static::hyperparameterTuningJobName
Formats a string containing the fully-qualified path to represent a hyperparameter_tuning_job resource.
project
string
location
string
hyperparameterTuningJob
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::modelName
Formats a string containing the fully-qualified path to represent a model resource.
project
string
location
string
model
string
string
static::modelDeploymentMonitoringJobName
Formats a string containing the fully-qualified path to represent a model_deployment_monitoring_job resource.
project
string
location
string
modelDeploymentMonitoringJob
string
string
static::nasJobName
Formats a string containing the fully-qualified path to represent a nas_job resource.
project
string
location
string
nasJob
string
string
static::nasTrialDetailName
Formats a string containing the fully-qualified path to represent a nas_trial_detail resource.
project
string
location
string
nasJob
string
nasTrialDetail
string
string
static::networkName
Formats a string containing the fully-qualified path to represent a network resource.
project
string
network
string
string
static::projectLocationEndpointName
Formats a string containing the fully-qualified path to represent a project_location_endpoint resource.
project
string
location
string
endpoint
string
string
static::projectLocationPublisherModelName
Formats a string containing the fully-qualified path to represent a project_location_publisher_model resource.
project
string
location
string
publisher
string
model
string
string
static::tensorboardName
Formats a string containing the fully-qualified path to represent a tensorboard resource.
project
string
location
string
tensorboard
string
string
static::trialName
Formats a string containing the fully-qualified path to represent a trial resource.
project
string
location
string
study
string
trial
string
string
static::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}
- trial: projects/{project}/locations/{location}/studies/{study}/trials/{trial}
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
