- 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 PipelineServiceClient.
Service Description: A service for creating and managing Vertex AI's pipelines. This includes both TrainingPipeline
resources (used for AutoML and custom training) and PipelineJob
resources (used for Vertex AI Pipelines).
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.
cancelPipelineJob
Cancels a PipelineJob.
Starts asynchronous cancellation on the PipelineJob. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use PipelineService.GetPipelineJob
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the PipelineJob is not deleted; instead it becomes a pipeline with
a PipelineJob.error
value
with a google.rpc.Status.code
of 1, corresponding
to Code.CANCELLED
, and PipelineJob.state
is set to CANCELLED
.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::cancelPipelineJobAsync() .
request
Google\Cloud\AIPlatform\V1\CancelPipelineJobRequest
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.
cancelTrainingPipeline
Cancels a TrainingPipeline.
Starts asynchronous cancellation on the TrainingPipeline. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use PipelineService.GetTrainingPipeline
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the TrainingPipeline is not deleted; instead it becomes a pipeline with
a TrainingPipeline.error
value with a google.rpc.Status.code
of 1,
corresponding to Code.CANCELLED
, and TrainingPipeline.state
is set to CANCELLED
.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::cancelTrainingPipelineAsync() .
request
Google\Cloud\AIPlatform\V1\CancelTrainingPipelineRequest
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.
createPipelineJob
Creates a PipelineJob. A PipelineJob will run immediately when created.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createPipelineJobAsync() .
request
Google\Cloud\AIPlatform\V1\CreatePipelineJobRequest
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.
createTrainingPipeline
Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createTrainingPipelineAsync() .
request
Google\Cloud\AIPlatform\V1\CreateTrainingPipelineRequest
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.
deletePipelineJob
Deletes a PipelineJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deletePipelineJobAsync() .
request
Google\Cloud\AIPlatform\V1\DeletePipelineJobRequest
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.
deleteTrainingPipeline
Deletes a TrainingPipeline.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteTrainingPipelineAsync() .
request
Google\Cloud\AIPlatform\V1\DeleteTrainingPipelineRequest
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.
getPipelineJob
Gets a PipelineJob.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getPipelineJobAsync() .
request
Google\Cloud\AIPlatform\V1\GetPipelineJobRequest
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.
getTrainingPipeline
Gets a TrainingPipeline.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getTrainingPipelineAsync() .
request
Google\Cloud\AIPlatform\V1\GetTrainingPipelineRequest
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.
listPipelineJobs
Lists PipelineJobs in a Location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listPipelineJobsAsync() .
request
Google\Cloud\AIPlatform\V1\ListPipelineJobsRequest
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.
listTrainingPipelines
Lists TrainingPipelines in a Location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listTrainingPipelinesAsync() .
request
Google\Cloud\AIPlatform\V1\ListTrainingPipelinesRequest
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.
cancelPipelineJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
cancelTrainingPipelineAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createPipelineJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createTrainingPipelineAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deletePipelineJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteTrainingPipelineAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getPipelineJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getTrainingPipelineAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listPipelineJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listTrainingPipelinesAsync
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::artifactName
Formats a string containing the fully-qualified path to represent a artifact resource.
project
string
location
string
metadataStore
string
artifact
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::endpointName
Formats a string containing the fully-qualified path to represent a endpoint resource.
project
string
location
string
endpoint
string
string
static::executionName
Formats a string containing the fully-qualified path to represent a execution resource.
project
string
location
string
metadataStore
string
execution
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::metadataStoreName
Formats a string containing the fully-qualified path to represent a metadata_store resource.
project
string
location
string
metadataStore
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::networkName
Formats a string containing the fully-qualified path to represent a network resource.
project
string
network
string
string
static::pipelineJobName
Formats a string containing the fully-qualified path to represent a pipeline_job resource.
project
string
location
string
pipelineJob
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::trainingPipelineName
Formats a string containing the fully-qualified path to represent a training_pipeline resource.
project
string
location
string
trainingPipeline
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
- artifact: projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}
- context: projects/{project}/locations/{location}/metadataStores/{metadata_store}/contexts/{context}
- customJob: projects/{project}/locations/{location}/customJobs/{custom_job}
- endpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
- execution: projects/{project}/locations/{location}/metadataStores/{metadata_store}/executions/{execution}
- location: projects/{project}/locations/{location}
- metadataStore: projects/{project}/locations/{location}/metadataStores/{metadata_store}
- model: projects/{project}/locations/{location}/models/{model}
- network: projects/{project}/global/networks/{network}
- pipelineJob: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
- projectLocationEndpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
- projectLocationPublisherModel: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}
- trainingPipeline: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}
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
