Google Cloud Deploy V1 Client - Class CloudDeployClient (0.9.0)

Version 0.9.0

• 2.0.0 (latest)
• 1.5.1
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.0
• 0.19.1
• 0.18.1
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.1
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.4

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Deploy V1 Client class CloudDeployClient.

Service Description: CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).

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

Namespace

Google \ Cloud \ Deploy \ V1 \ Client

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.

abandonRelease

Abandons a Release in the Delivery Pipeline.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::abandonReleaseAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\AbandonReleaseResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\AbandonReleaseRequest;
use Google\Cloud\Deploy\V1\AbandonReleaseResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;

/**
 * @param string $formattedName Name of the Release. Format is
 *                              projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
 *                              releases/{release}. Please see
 *                              {@see CloudDeployClient::releaseName()} for help formatting this field.
 */
function abandon_release_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AbandonReleaseResponse $response */
        $response = $cloudDeployClient->abandonRelease($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 = CloudDeployClient::releaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]'
    );

    abandon_release_sample($formattedName);
}

advanceRollout

Advances a Rollout in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::advanceRolloutAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\AdvanceRolloutResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\AdvanceRolloutRequest;
use Google\Cloud\Deploy\V1\AdvanceRolloutResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;

/**
 * @param string $formattedName Name of the Rollout. Format is
 *                              projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
 *                              releases/{release}/rollouts/{rollout}. Please see
 *                              {@see CloudDeployClient::rolloutName()} for help formatting this field.
 * @param string $phaseId       The phase ID to advance the `Rollout` to.
 */
function advance_rollout_sample(string $formattedName, string $phaseId): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AdvanceRolloutResponse $response */
        $response = $cloudDeployClient->advanceRollout($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 = CloudDeployClient::rolloutName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]',
        '[ROLLOUT]'
    );
    $phaseId = '[PHASE_ID]';

    advance_rollout_sample($formattedName, $phaseId);
}

approveRollout

Approves a Rollout.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::approveRolloutAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\ApproveRolloutResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\ApproveRolloutRequest;
use Google\Cloud\Deploy\V1\ApproveRolloutResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;

/**
 * @param string $formattedName Name of the Rollout. Format is
 *                              projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
 *                              releases/{release}/rollouts/{rollout}. Please see
 *                              {@see CloudDeployClient::rolloutName()} for help formatting this field.
 * @param bool   $approved      True = approve; false = reject
 */
function approve_rollout_sample(string $formattedName, bool $approved): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ApproveRolloutResponse $response */
        $response = $cloudDeployClient->approveRollout($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 = CloudDeployClient::rolloutName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]',
        '[ROLLOUT]'
    );
    $approved = false;

    approve_rollout_sample($formattedName, $approved);
}

cancelRollout

Cancels a Rollout in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::cancelRolloutAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\CancelRolloutResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CancelRolloutRequest;
use Google\Cloud\Deploy\V1\CancelRolloutResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;

/**
 * @param string $formattedName Name of the Rollout. Format is
 *                              projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
 *                              releases/{release}/rollouts/{rollout}. Please see
 *                              {@see CloudDeployClient::rolloutName()} for help formatting this field.
 */
function cancel_rollout_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var CancelRolloutResponse $response */
        $response = $cloudDeployClient->cancelRollout($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 = CloudDeployClient::rolloutName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]',
        '[ROLLOUT]'
    );

    cancel_rollout_sample($formattedName);
}

createDeliveryPipeline

Creates a new DeliveryPipeline in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createDeliveryPipelineAsync() .

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

Returns
Type	Description
Google\ApiCore\OperationResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\CreateDeliveryPipelineRequest;
use Google\Cloud\Deploy\V1\DeliveryPipeline;
use Google\Rpc\Status;

/**
 * @param string $formattedParent    The parent collection in which the `DeliveryPipeline` should be
 *                                   created. Format should be projects/{project_id}/locations/{location_name}. Please see
 *                                   {@see CloudDeployClient::locationName()} for help formatting this field.
 * @param string $deliveryPipelineId ID of the `DeliveryPipeline`.
 */
function create_delivery_pipeline_sample(
    string $formattedParent,
    string $deliveryPipelineId
): void {
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

    // Prepare the request message.
    $deliveryPipeline = new DeliveryPipeline();
    $request = (new CreateDeliveryPipelineRequest())
        ->setParent($formattedParent)
        ->setDeliveryPipelineId($deliveryPipelineId)
        ->setDeliveryPipeline($deliveryPipeline);

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

        if ($response->operationSucceeded()) {
            /** @var DeliveryPipeline $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } 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
{
    $formattedParent = CloudDeployClient::locationName('[PROJECT]', '[LOCATION]');
    $deliveryPipelineId = '[DELIVERY_PIPELINE_ID]';

    create_delivery_pipeline_sample($formattedParent, $deliveryPipelineId);
}

createRelease

Creates a new Release in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createReleaseAsync() .

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

Returns
Type	Description
Google\ApiCore\OperationResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\CreateReleaseRequest;
use Google\Cloud\Deploy\V1\Release;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent collection in which the `Release` should be created.
 *                                Format should be
 *                                projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. Please see
 *                                {@see CloudDeployClient::deliveryPipelineName()} for help formatting this field.
 * @param string $releaseId       ID of the `Release`.
 */
function create_release_sample(string $formattedParent, string $releaseId): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

    // Prepare the request message.
    $release = new Release();
    $request = (new CreateReleaseRequest())
        ->setParent($formattedParent)
        ->setReleaseId($releaseId)
        ->setRelease($release);

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

        if ($response->operationSucceeded()) {
            /** @var Release $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } 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
{
    $formattedParent = CloudDeployClient::deliveryPipelineName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]'
    );
    $releaseId = '[RELEASE_ID]';

    create_release_sample($formattedParent, $releaseId);
}

createRollout

Creates a new Rollout in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createRolloutAsync() .

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

Returns
Type	Description
Google\ApiCore\OperationResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\CreateRolloutRequest;
use Google\Cloud\Deploy\V1\Rollout;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent collection in which the `Rollout` should be created.
 *                                Format should be
 *                                projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}. Please see
 *                                {@see CloudDeployClient::releaseName()} for help formatting this field.
 * @param string $rolloutId       ID of the `Rollout`.
 * @param string $rolloutTargetId The ID of Target to which this `Rollout` is deploying.
 */
function create_rollout_sample(
    string $formattedParent,
    string $rolloutId,
    string $rolloutTargetId
): void {
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

    // Prepare the request message.
    $rollout = (new Rollout())
        ->setTargetId($rolloutTargetId);
    $request = (new CreateRolloutRequest())
        ->setParent($formattedParent)
        ->setRolloutId($rolloutId)
        ->setRollout($rollout);

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

        if ($response->operationSucceeded()) {
            /** @var Rollout $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } 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
{
    $formattedParent = CloudDeployClient::releaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]'
    );
    $rolloutId = '[ROLLOUT_ID]';
    $rolloutTargetId = '[TARGET_ID]';

    create_rollout_sample($formattedParent, $rolloutId, $rolloutTargetId);
}

createTarget

Creates a new Target in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createTargetAsync() .

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

Returns
Type	Description
Google\ApiCore\OperationResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\CreateTargetRequest;
use Google\Cloud\Deploy\V1\Target;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent collection in which the `Target` should be created.
 *                                Format should be
 *                                projects/{project_id}/locations/{location_name}. Please see
 *                                {@see CloudDeployClient::locationName()} for help formatting this field.
 * @param string $targetId        ID of the `Target`.
 */
function create_target_sample(string $formattedParent, string $targetId): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

    // Prepare the request message.
    $target = new Target();
    $request = (new CreateTargetRequest())
        ->setParent($formattedParent)
        ->setTargetId($targetId)
        ->setTarget($target);

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

        if ($response->operationSucceeded()) {
            /** @var Target $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } 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
{
    $formattedParent = CloudDeployClient::locationName('[PROJECT]', '[LOCATION]');
    $targetId = '[TARGET_ID]';

    create_target_sample($formattedParent, $targetId);
}

deleteDeliveryPipeline

Deletes a single DeliveryPipeline.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::deleteDeliveryPipelineAsync() .

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

Returns
Type	Description
Google\ApiCore\OperationResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\DeleteDeliveryPipelineRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the `DeliveryPipeline` to delete. Format should be
 *                              projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. Please see
 *                              {@see CloudDeployClient::deliveryPipelineName()} for help formatting this field.
 */
function delete_delivery_pipeline_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $cloudDeployClient->deleteDeliveryPipeline($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 = CloudDeployClient::deliveryPipelineName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]'
    );

    delete_delivery_pipeline_sample($formattedName);
}

deleteTarget

Deletes a single Target.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::deleteTargetAsync() .

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

Returns
Type	Description
Google\ApiCore\OperationResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\DeleteTargetRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the `Target` to delete. Format should be
 *                              projects/{project_id}/locations/{location_name}/targets/{target_name}. Please see
 *                              {@see CloudDeployClient::targetName()} for help formatting this field.
 */
function delete_target_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $cloudDeployClient->deleteTarget($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 = CloudDeployClient::targetName('[PROJECT]', '[LOCATION]', '[TARGET]');

    delete_target_sample($formattedName);
}

getConfig

Gets the configuration for a location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getConfigAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\Config

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\Config;
use Google\Cloud\Deploy\V1\GetConfigRequest;

/**
 * @param string $formattedName Name of requested configuration. Please see
 *                              {@see CloudDeployClient::configName()} for help formatting this field.
 */
function get_config_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Config $response */
        $response = $cloudDeployClient->getConfig($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 = CloudDeployClient::configName('[PROJECT]', '[LOCATION]');

    get_config_sample($formattedName);
}

getDeliveryPipeline

Gets details of a single DeliveryPipeline.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getDeliveryPipelineAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\DeliveryPipeline

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\DeliveryPipeline;
use Google\Cloud\Deploy\V1\GetDeliveryPipelineRequest;

/**
 * @param string $formattedName Name of the `DeliveryPipeline`. Format must be
 *                              projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. Please see
 *                              {@see CloudDeployClient::deliveryPipelineName()} for help formatting this field.
 */
function get_delivery_pipeline_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DeliveryPipeline $response */
        $response = $cloudDeployClient->getDeliveryPipeline($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 = CloudDeployClient::deliveryPipelineName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]'
    );

    get_delivery_pipeline_sample($formattedName);
}

getJobRun

Gets details of a single JobRun.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getJobRunAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\JobRun

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\GetJobRunRequest;
use Google\Cloud\Deploy\V1\JobRun;

/**
 * @param string $formattedName Name of the `JobRun`. Format must be
 *                              projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}. Please see
 *                              {@see CloudDeployClient::jobRunName()} for help formatting this field.
 */
function get_job_run_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var JobRun $response */
        $response = $cloudDeployClient->getJobRun($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 = CloudDeployClient::jobRunName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]',
        '[ROLLOUT]',
        '[JOB_RUN]'
    );

    get_job_run_sample($formattedName);
}

getRelease

Gets details of a single Release.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getReleaseAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\Release

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\GetReleaseRequest;
use Google\Cloud\Deploy\V1\Release;

/**
 * @param string $formattedName Name of the `Release`. Format must be
 *                              projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}. Please see
 *                              {@see CloudDeployClient::releaseName()} for help formatting this field.
 */
function get_release_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Release $response */
        $response = $cloudDeployClient->getRelease($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 = CloudDeployClient::releaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]'
    );

    get_release_sample($formattedName);
}

getRollout

Gets details of a single Rollout.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getRolloutAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\Rollout

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\GetRolloutRequest;
use Google\Cloud\Deploy\V1\Rollout;

/**
 * @param string $formattedName Name of the `Rollout`. Format must be
 *                              projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}. Please see
 *                              {@see CloudDeployClient::rolloutName()} for help formatting this field.
 */
function get_rollout_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Rollout $response */
        $response = $cloudDeployClient->getRollout($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 = CloudDeployClient::rolloutName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]',
        '[ROLLOUT]'
    );

    get_rollout_sample($formattedName);
}

getTarget

Gets details of a single Target.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getTargetAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\Target

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\GetTargetRequest;
use Google\Cloud\Deploy\V1\Target;

/**
 * @param string $formattedName Name of the `Target`. Format must be
 *                              projects/{project_id}/locations/{location_name}/targets/{target_name}. Please see
 *                              {@see CloudDeployClient::targetName()} for help formatting this field.
 */
function get_target_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Target $response */
        $response = $cloudDeployClient->getTarget($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 = CloudDeployClient::targetName('[PROJECT]', '[LOCATION]', '[TARGET]');

    get_target_sample($formattedName);
}

ignoreJob

Ignores the specified Job in a Rollout.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::ignoreJobAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\IgnoreJobResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\IgnoreJobRequest;
use Google\Cloud\Deploy\V1\IgnoreJobResponse;

/**
 * @param string $formattedRollout Name of the Rollout. Format is
 *                                 projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
 *                                 releases/{release}/rollouts/{rollout}. Please see
 *                                 {@see CloudDeployClient::rolloutName()} for help formatting this field.
 * @param string $phaseId          The phase ID the Job to ignore belongs to.
 * @param string $jobId            The job ID for the Job to ignore.
 */
function ignore_job_sample(string $formattedRollout, string $phaseId, string $jobId): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

    // Prepare the request message.
    $request = (new IgnoreJobRequest())
        ->setRollout($formattedRollout)
        ->setPhaseId($phaseId)
        ->setJobId($jobId);

    // Call the API and handle any network failures.
    try {
        /** @var IgnoreJobResponse $response */
        $response = $cloudDeployClient->ignoreJob($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
{
    $formattedRollout = CloudDeployClient::rolloutName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]',
        '[ROLLOUT]'
    );
    $phaseId = '[PHASE_ID]';
    $jobId = '[JOB_ID]';

    ignore_job_sample($formattedRollout, $phaseId, $jobId);
}

listDeliveryPipelines

Lists DeliveryPipelines in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listDeliveryPipelinesAsync() .

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

Returns
Type	Description
Google\ApiCore\PagedListResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\DeliveryPipeline;
use Google\Cloud\Deploy\V1\ListDeliveryPipelinesRequest;

/**
 * @param string $formattedParent The parent, which owns this collection of pipelines. Format must
 *                                be projects/{project_id}/locations/{location_name}. Please see
 *                                {@see CloudDeployClient::locationName()} for help formatting this field.
 */
function list_delivery_pipelines_sample(string $formattedParent): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

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

        /** @var DeliveryPipeline $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 = CloudDeployClient::locationName('[PROJECT]', '[LOCATION]');

    list_delivery_pipelines_sample($formattedParent);
}

listJobRuns

Lists JobRuns in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listJobRunsAsync() .

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

Returns
Type	Description
Google\ApiCore\PagedListResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\JobRun;
use Google\Cloud\Deploy\V1\ListJobRunsRequest;

/**
 * @param string $formattedParent The `Rollout` which owns this collection of `JobRun` objects. Please see
 *                                {@see CloudDeployClient::rolloutName()} for help formatting this field.
 */
function list_job_runs_sample(string $formattedParent): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

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

        /** @var JobRun $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 = CloudDeployClient::rolloutName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]',
        '[ROLLOUT]'
    );

    list_job_runs_sample($formattedParent);
}

listReleases

Lists Releases in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listReleasesAsync() .

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

Returns
Type	Description
Google\ApiCore\PagedListResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\ListReleasesRequest;
use Google\Cloud\Deploy\V1\Release;

/**
 * @param string $formattedParent The `DeliveryPipeline` which owns this collection of `Release`
 *                                objects. Please see
 *                                {@see CloudDeployClient::deliveryPipelineName()} for help formatting this field.
 */
function list_releases_sample(string $formattedParent): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

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

        /** @var Release $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 = CloudDeployClient::deliveryPipelineName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]'
    );

    list_releases_sample($formattedParent);
}

listRollouts

Lists Rollouts in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listRolloutsAsync() .

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

Returns
Type	Description
Google\ApiCore\PagedListResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\ListRolloutsRequest;
use Google\Cloud\Deploy\V1\Rollout;

/**
 * @param string $formattedParent The `Release` which owns this collection of `Rollout` objects. Please see
 *                                {@see CloudDeployClient::releaseName()} for help formatting this field.
 */
function list_rollouts_sample(string $formattedParent): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

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

        /** @var Rollout $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 = CloudDeployClient::releaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]'
    );

    list_rollouts_sample($formattedParent);
}

listTargets

Lists Targets in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listTargetsAsync() .

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

Returns
Type	Description
Google\ApiCore\PagedListResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\ListTargetsRequest;
use Google\Cloud\Deploy\V1\Target;

/**
 * @param string $formattedParent The parent, which owns this collection of targets. Format must be
 *                                projects/{project_id}/locations/{location_name}. Please see
 *                                {@see CloudDeployClient::locationName()} for help formatting this field.
 */
function list_targets_sample(string $formattedParent): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

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

        /** @var Target $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 = CloudDeployClient::locationName('[PROJECT]', '[LOCATION]');

    list_targets_sample($formattedParent);
}

retryJob

Retries the specified Job in a Rollout.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::retryJobAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\RetryJobResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\RetryJobRequest;
use Google\Cloud\Deploy\V1\RetryJobResponse;

/**
 * @param string $formattedRollout Name of the Rollout. Format is
 *                                 projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
 *                                 releases/{release}/rollouts/{rollout}. Please see
 *                                 {@see CloudDeployClient::rolloutName()} for help formatting this field.
 * @param string $phaseId          The phase ID the Job to retry belongs to.
 * @param string $jobId            The job ID for the Job to retry.
 */
function retry_job_sample(string $formattedRollout, string $phaseId, string $jobId): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

    // Prepare the request message.
    $request = (new RetryJobRequest())
        ->setRollout($formattedRollout)
        ->setPhaseId($phaseId)
        ->setJobId($jobId);

    // Call the API and handle any network failures.
    try {
        /** @var RetryJobResponse $response */
        $response = $cloudDeployClient->retryJob($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
{
    $formattedRollout = CloudDeployClient::rolloutName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]',
        '[ROLLOUT]'
    );
    $phaseId = '[PHASE_ID]';
    $jobId = '[JOB_ID]';

    retry_job_sample($formattedRollout, $phaseId, $jobId);
}

terminateJobRun

Terminates a Job Run in a given project and location.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::terminateJobRunAsync() .

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

Returns
Type	Description
Google\Cloud\Deploy\V1\TerminateJobRunResponse

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\TerminateJobRunRequest;
use Google\Cloud\Deploy\V1\TerminateJobRunResponse;

/**
 * @param string $formattedName Name of the `JobRun`. Format must be
 *                              projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/
 *                              releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}. Please see
 *                              {@see CloudDeployClient::jobRunName()} for help formatting this field.
 */
function terminate_job_run_sample(string $formattedName): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var TerminateJobRunResponse $response */
        $response = $cloudDeployClient->terminateJobRun($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 = CloudDeployClient::jobRunName(
        '[PROJECT]',
        '[LOCATION]',
        '[DELIVERY_PIPELINE]',
        '[RELEASE]',
        '[ROLLOUT]',
        '[JOB_RUN]'
    );

    terminate_job_run_sample($formattedName);
}

updateDeliveryPipeline

Updates the parameters of a single DeliveryPipeline.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::updateDeliveryPipelineAsync() .

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

Returns
Type	Description
Google\ApiCore\OperationResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\DeliveryPipeline;
use Google\Cloud\Deploy\V1\UpdateDeliveryPipelineRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * 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 update_delivery_pipeline_sample(): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $deliveryPipeline = new DeliveryPipeline();
    $request = (new UpdateDeliveryPipelineRequest())
        ->setUpdateMask($updateMask)
        ->setDeliveryPipeline($deliveryPipeline);

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

        if ($response->operationSucceeded()) {
            /** @var DeliveryPipeline $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } 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());
    }
}

updateTarget

Updates the parameters of a single Target.

The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::updateTargetAsync() .

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

Returns
Type	Description
Google\ApiCore\OperationResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\Target;
use Google\Cloud\Deploy\V1\UpdateTargetRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * 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 update_target_sample(): void
{
    // Create a client.
    $cloudDeployClient = new CloudDeployClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $target = new Target();
    $request = (new UpdateTargetRequest())
        ->setUpdateMask($updateMask)
        ->setTarget($target);

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

        if ($response->operationSucceeded()) {
            /** @var Target $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } 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());
    }
}

getLocation

Gets information about a location.

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

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

Returns
Type	Description
Google\Cloud\Location\Location

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
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.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $cloudDeployClient->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.

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

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

Returns
Type	Description
Google\ApiCore\PagedListResponse

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
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.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $cloudDeployClient->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.

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

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

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
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.
    $cloudDeployClient = new CloudDeployClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $cloudDeployClient->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.

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

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

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
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.
    $cloudDeployClient = new CloudDeployClient();

    // 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 = $cloudDeployClient->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.

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

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

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
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.
    $cloudDeployClient = new CloudDeployClient();

    // 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 = $cloudDeployClient->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);
}

abandonReleaseAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\AbandonReleaseRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

advanceRolloutAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\AdvanceRolloutRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

approveRolloutAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\ApproveRolloutRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

cancelRolloutAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\CancelRolloutRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createDeliveryPipelineAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\CreateDeliveryPipelineRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createReleaseAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\CreateReleaseRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createRolloutAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\CreateRolloutRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createTargetAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\CreateTargetRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteDeliveryPipelineAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\DeleteDeliveryPipelineRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteTargetAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\DeleteTargetRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getConfigAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\GetConfigRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getDeliveryPipelineAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\GetDeliveryPipelineRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getJobRunAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\GetJobRunRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getReleaseAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\GetReleaseRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getRolloutAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\GetRolloutRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getTargetAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\GetTargetRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

ignoreJobAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\IgnoreJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listDeliveryPipelinesAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\ListDeliveryPipelinesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listJobRunsAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\ListJobRunsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listReleasesAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\ListReleasesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listRolloutsAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\ListRolloutsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listTargetsAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\ListTargetsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

retryJobAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\RetryJobRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

terminateJobRunAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\TerminateJobRunRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateDeliveryPipelineAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\UpdateDeliveryPipelineRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateTargetAsync

Parameters
Name	Description
request	Google\Cloud\Deploy\V1\UpdateTargetRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name	Description
request	Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

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::buildName

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

Parameters
Name	Description
project	string
location	string
build	string

Returns
Type	Description
string	The formatted build resource.

static::clusterName

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

Parameters
Name	Description
project	string
location	string
cluster	string

Returns
Type	Description
string	The formatted cluster resource.

static::configName

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

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	The formatted config resource.

static::deliveryPipelineName

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

Parameters
Name	Description
project	string
location	string
deliveryPipeline	string

Returns
Type	Description
string	The formatted delivery_pipeline resource.

static::jobRunName

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

Parameters
Name	Description
project	string
location	string
deliveryPipeline	string
release	string
rollout	string
jobRun	string

Returns
Type	Description
string	The formatted job_run 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::membershipName

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

Parameters
Name	Description
project	string
location	string
membership	string

Returns
Type	Description
string	The formatted membership resource.

static::releaseName

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

Parameters
Name	Description
project	string
location	string
deliveryPipeline	string
release	string

Returns
Type	Description
string	The formatted release resource.

static::rolloutName

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

Parameters
Name	Description
project	string
location	string
deliveryPipeline	string
release	string
rollout	string

Returns
Type	Description
string	The formatted rollout resource.

static::serviceName

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

Parameters
Name	Description
project	string
location	string
service	string

Returns
Type	Description
string	The formatted service resource.

static::targetName

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

Parameters
Name	Description
project	string
location	string
target	string

Returns
Type	Description
string	The formatted target resource.

static::workerPoolName

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

Parameters
Name	Description
project	string
location	string
workerPool	string

Returns
Type	Description
string	The formatted worker_pool 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

• build: projects/{project}/locations/{location}/builds/{build}
• cluster: projects/{project}/locations/{location}/clusters/{cluster}
• config: projects/{project}/locations/{location}/config
• deliveryPipeline: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}
• jobRun: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run}
• location: projects/{project}/locations/{location}
• membership: projects/{project}/locations/{location}/memberships/{membership}
• release: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}
• rollout: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}
• service: projects/{project}/locations/{location}/services/{service}
• target: projects/{project}/locations/{location}/targets/{target}
• workerPool: projects/{project}/locations/{location}/workerPools/{worker_pool}

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.