Google Cloud Ai Platform V1 Client - Class PipelineServiceClient (0.24.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 provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$pipelineServiceClient = new PipelineServiceClient();
try {
    $formattedName = $pipelineServiceClient->pipelineJobName('[PROJECT]', '[LOCATION]', '[PIPELINE_JOB]');
    $pipelineServiceClient->cancelPipelineJob($formattedName);
} finally {
    $pipelineServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This service has a new (beta) implementation. See Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient to use the new surface.

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__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.

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.

Parameters
Name	Description
`name`	`string` Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
`optionalArgs`	`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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\CancelPipelineJobRequest;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;

/**
 * @param string $formattedName The name of the PipelineJob to cancel.
 *                              Format:
 *                              `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
 *                              Please see {@see PipelineServiceClient::pipelineJobName()} for help formatting this field.
 */
function cancel_pipeline_job_sample(string $formattedName): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = (new CancelPipelineJobRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $pipelineServiceClient->cancelPipelineJob($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PipelineServiceClient::pipelineJobName(
        '[PROJECT]',
        '[LOCATION]',
        '[PIPELINE_JOB]'
    );

    cancel_pipeline_job_sample($formattedName);
}

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.

Parameters
Name	Description
`name`	`string` Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
`optionalArgs`	`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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\CancelTrainingPipelineRequest;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;

/**
 * @param string $formattedName The name of the TrainingPipeline to cancel.
 *                              Format:
 *                              `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
 *                              Please see {@see PipelineServiceClient::trainingPipelineName()} for help formatting this field.
 */
function cancel_training_pipeline_sample(string $formattedName): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = (new CancelTrainingPipelineRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $pipelineServiceClient->cancelTrainingPipeline($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PipelineServiceClient::trainingPipelineName(
        '[PROJECT]',
        '[LOCATION]',
        '[TRAINING_PIPELINE]'
    );

    cancel_training_pipeline_sample($formattedName);
}

createPipelineJob

Creates a PipelineJob. A PipelineJob will run immediately when created.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
`pipelineJob`	`Google\Cloud\AIPlatform\V1\PipelineJob` Required. The PipelineJob to create.
`optionalArgs`	`array` Optional.
`↳ pipelineJobId`	`string` The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are /[a-z][0-9]-/.
`↳ 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\PipelineJob`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\AIPlatform\V1\CreatePipelineJobRequest;
use Google\Cloud\AIPlatform\V1\PipelineJob;

/**
 * @param string $formattedParent The resource name of the Location to create the PipelineJob in.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see PipelineServiceClient::locationName()} for help formatting this field.
 */
function create_pipeline_job_sample(string $formattedParent): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $pipelineJob = new PipelineJob();
    $request = (new CreatePipelineJobRequest())
        ->setParent($formattedParent)
        ->setPipelineJob($pipelineJob);

    // Call the API and handle any network failures.
    try {
        /** @var PipelineJob $response */
        $response = $pipelineServiceClient->createPipelineJob($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = PipelineServiceClient::locationName('[PROJECT]', '[LOCATION]');

    create_pipeline_job_sample($formattedParent);
}

createTrainingPipeline

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

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`
`trainingPipeline`	`Google\Cloud\AIPlatform\V1\TrainingPipeline` Required. The TrainingPipeline to create.
`optionalArgs`	`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\TrainingPipeline`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\AIPlatform\V1\CreateTrainingPipelineRequest;
use Google\Cloud\AIPlatform\V1\TrainingPipeline;
use Google\Protobuf\Value;

/**
 * @param string $formattedParent                        The resource name of the Location to create the TrainingPipeline
 *                                                       in. Format: `projects/{project}/locations/{location}`
 *                                                       Please see {@see PipelineServiceClient::locationName()} for help formatting this field.
 * @param string $trainingPipelineDisplayName            The user-defined name of this TrainingPipeline.
 * @param string $trainingPipelineTrainingTaskDefinition A Google Cloud Storage path to the YAML file that defines the
 *                                                       training task which is responsible for producing the model artifact, and
 *                                                       may also include additional auxiliary work. The definition files that can
 *                                                       be used here are found in
 *                                                       gs://google-cloud-aiplatform/schema/trainingjob/definition/.
 *                                                       Note: The URI given on output will be immutable and probably different,
 *                                                       including the URI scheme, than the one given on input. The output URI will
 *                                                       point to a location where the user only has a read access.
 */
function create_training_pipeline_sample(
    string $formattedParent,
    string $trainingPipelineDisplayName,
    string $trainingPipelineTrainingTaskDefinition
): void {
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $trainingPipelineTrainingTaskInputs = new Value();
    $trainingPipeline = (new TrainingPipeline())
        ->setDisplayName($trainingPipelineDisplayName)
        ->setTrainingTaskDefinition($trainingPipelineTrainingTaskDefinition)
        ->setTrainingTaskInputs($trainingPipelineTrainingTaskInputs);
    $request = (new CreateTrainingPipelineRequest())
        ->setParent($formattedParent)
        ->setTrainingPipeline($trainingPipeline);

    // Call the API and handle any network failures.
    try {
        /** @var TrainingPipeline $response */
        $response = $pipelineServiceClient->createTrainingPipeline($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = PipelineServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $trainingPipelineDisplayName = '[DISPLAY_NAME]';
    $trainingPipelineTrainingTaskDefinition = '[TRAINING_TASK_DEFINITION]';

    create_training_pipeline_sample(
        $formattedParent,
        $trainingPipelineDisplayName,
        $trainingPipelineTrainingTaskDefinition
    );
}

deletePipelineJob

Deletes a PipelineJob.

Parameters
Name	Description
`name`	`string` Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
`optionalArgs`	`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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\AIPlatform\V1\DeletePipelineJobRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the PipelineJob resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
 *                              Please see {@see PipelineServiceClient::pipelineJobName()} for help formatting this field.
 */
function delete_pipeline_job_sample(string $formattedName): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = (new DeletePipelineJobRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $pipelineServiceClient->deletePipelineJob($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PipelineServiceClient::pipelineJobName(
        '[PROJECT]',
        '[LOCATION]',
        '[PIPELINE_JOB]'
    );

    delete_pipeline_job_sample($formattedName);
}

deleteTrainingPipeline

Deletes a TrainingPipeline.

Parameters
Name	Description
`name`	`string` Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
`optionalArgs`	`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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteTrainingPipelineRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the TrainingPipeline resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
 *                              Please see {@see PipelineServiceClient::trainingPipelineName()} for help formatting this field.
 */
function delete_training_pipeline_sample(string $formattedName): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = (new DeleteTrainingPipelineRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $pipelineServiceClient->deleteTrainingPipeline($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PipelineServiceClient::trainingPipelineName(
        '[PROJECT]',
        '[LOCATION]',
        '[TRAINING_PIPELINE]'
    );

    delete_training_pipeline_sample($formattedName);
}

getPipelineJob

Gets a PipelineJob.

Parameters
Name	Description
`name`	`string` Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
`optionalArgs`	`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\PipelineJob`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\AIPlatform\V1\GetPipelineJobRequest;
use Google\Cloud\AIPlatform\V1\PipelineJob;

/**
 * @param string $formattedName The name of the PipelineJob resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`
 *                              Please see {@see PipelineServiceClient::pipelineJobName()} for help formatting this field.
 */
function get_pipeline_job_sample(string $formattedName): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = (new GetPipelineJobRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var PipelineJob $response */
        $response = $pipelineServiceClient->getPipelineJob($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PipelineServiceClient::pipelineJobName(
        '[PROJECT]',
        '[LOCATION]',
        '[PIPELINE_JOB]'
    );

    get_pipeline_job_sample($formattedName);
}

getTrainingPipeline

Gets a TrainingPipeline.

Parameters
Name	Description
`name`	`string` Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
`optionalArgs`	`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\TrainingPipeline`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\AIPlatform\V1\GetTrainingPipelineRequest;
use Google\Cloud\AIPlatform\V1\TrainingPipeline;

/**
 * @param string $formattedName The name of the TrainingPipeline resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
 *                              Please see {@see PipelineServiceClient::trainingPipelineName()} for help formatting this field.
 */
function get_training_pipeline_sample(string $formattedName): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = (new GetTrainingPipelineRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var TrainingPipeline $response */
        $response = $pipelineServiceClient->getTrainingPipeline($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = PipelineServiceClient::trainingPipelineName(
        '[PROJECT]',
        '[LOCATION]',
        '[TRAINING_PIPELINE]'
    );

    get_training_pipeline_sample($formattedName);
}

listPipelineJobs

Lists PipelineJobs in a Location.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`
`optionalArgs`	`array` Optional.
`↳ filter`	`string` Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains step by doing display_name:"step" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time>"2021-05-18T00:00:00Z" OR update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod".
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ orderBy`	`string` A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`
`↳ readMask`	`FieldMask` Mask specifying which fields to read.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\AIPlatform\V1\ListPipelineJobsRequest;
use Google\Cloud\AIPlatform\V1\PipelineJob;

/**
 * @param string $formattedParent The resource name of the Location to list the PipelineJobs from.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see PipelineServiceClient::locationName()} for help formatting this field.
 */
function list_pipeline_jobs_sample(string $formattedParent): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = (new ListPipelineJobsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $pipelineServiceClient->listPipelineJobs($request);

        /** @var PipelineJob $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = PipelineServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_pipeline_jobs_sample($formattedParent);
}

listTrainingPipelines

Lists TrainingPipelines in a Location.

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`
`optionalArgs`	`array` Optional.
`↳ filter`	`string` The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_"``state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"``NOT display_name="my_pipeline"``create_time>"2021-05-18T00:00:00Z"``training_task_definition:"automl_text_classification"`
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ readMask`	`FieldMask` Mask specifying which fields to read.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\AIPlatform\V1\ListTrainingPipelinesRequest;
use Google\Cloud\AIPlatform\V1\TrainingPipeline;

/**
 * @param string $formattedParent The resource name of the Location to list the TrainingPipelines
 *                                from. Format: `projects/{project}/locations/{location}`
 *                                Please see {@see PipelineServiceClient::locationName()} for help formatting this field.
 */
function list_training_pipelines_sample(string $formattedParent): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = (new ListTrainingPipelinesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $pipelineServiceClient->listTrainingPipelines($request);

        /** @var TrainingPipeline $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = PipelineServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_training_pipelines_sample($formattedParent);
}

getLocation

Gets information about a location.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` Resource name for the location.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_location_sample(): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $pipelineServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` The resource that owns the locations collection, if applicable.
`↳ filter`	`string` The standard list filter.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_locations_sample(): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $pipelineServiceClient->listLocations($request);

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getIamPolicy

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

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
`optionalArgs`	`array` Optional.
`↳ options`	`GetPolicyOptions` OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $pipelineServiceClient->getIamPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

setIamPolicy

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`Google\Cloud\Iam\V1\Policy` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
`↳ 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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $pipelineServiceClient->setIamPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

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.

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`string[]` The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
`optionalArgs`	`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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\PipelineServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $pipelineServiceClient = new PipelineServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $pipelineServiceClient->testIamPermissions($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

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`

static::artifactName

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

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

Returns
Type	Description
`string`	The formatted artifact resource.

static::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.

static::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.

static::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.

static::executionName

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

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

Returns
Type	Description
`string`	The formatted execution resource.

static::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.

static::metadataStoreName

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

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

Returns
Type	Description
`string`	The formatted metadata_store resource.

static::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.

static::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.

static::pipelineJobName

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

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

Returns
Type	Description
`string`	The formatted pipeline_job resource.

static::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.

static::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.

static::trainingPipelineName

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

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

Returns
Type	Description
`string`	The formatted training_pipeline resource.

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.

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.

Constants

SERVICE_NAME

Value: 'google.cloud.aiplatform.v1.PipelineService'

The name of the service.

SERVICE_ADDRESS

Value: 'aiplatform.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.