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 provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$cloudDeployClient = new CloudDeployClient();
try {
$formattedName = $cloudDeployClient->releaseName('[PROJECT]', '[LOCATION]', '[DELIVERY_PIPELINE]', '[RELEASE]');
$response = $cloudDeployClient->abandonRelease($formattedName);
} finally {
$cloudDeployClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Methods
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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}
- 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}
- release: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}
- rollout: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}
- target: projects/{project}/locations/{location}/targets/{target}
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. |
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 | |
__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 |
↳ 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 |
↳ 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\AbandonReleaseResponse | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\AbandonReleaseResponse;
use Google\Cloud\Deploy\V1\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();
// Call the API and handle any network failures.
try {
/** @var AbandonReleaseResponse $response */
$response = $cloudDeployClient->abandonRelease($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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);
}
approveRollout
Approves a Rollout.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. |
approved |
bool
Required. True = approve; false = reject |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\ApproveRolloutResponse | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\ApproveRolloutResponse;
use Google\Cloud\Deploy\V1\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();
// Call the API and handle any network failures.
try {
/** @var ApproveRolloutResponse $response */
$response = $cloudDeployClient->approveRollout($formattedName, $approved);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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);
}
createDeliveryPipeline
Creates a new DeliveryPipeline in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent collection in which the |
deliveryPipelineId |
string
Required. ID of the |
deliveryPipeline |
Google\Cloud\Deploy\V1\DeliveryPipeline
Required. The |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validateOnly |
bool
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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 any non-scalar elements to be passed along with the request.
$deliveryPipeline = new DeliveryPipeline();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->createDeliveryPipeline(
$formattedParent,
$deliveryPipelineId,
$deliveryPipeline
);
$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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent collection in which the |
releaseId |
string
Required. ID of the |
release |
Google\Cloud\Deploy\V1\Release
Required. The |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validateOnly |
bool
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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 any non-scalar elements to be passed along with the request.
$release = new Release();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->createRelease($formattedParent, $releaseId, $release);
$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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent collection in which the |
rolloutId |
string
Required. ID of the |
rollout |
Google\Cloud\Deploy\V1\Rollout
Required. The |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validateOnly |
bool
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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 any non-scalar elements to be passed along with the request.
$rollout = (new Rollout())
->setTargetId($rolloutTargetId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->createRollout($formattedParent, $rolloutId, $rollout);
$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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent collection in which the |
targetId |
string
Required. ID of the |
target |
Google\Cloud\Deploy\V1\Target
Required. The |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ validateOnly |
bool
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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 any non-scalar elements to be passed along with the request.
$target = new Target();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->createTarget($formattedParent, $targetId, $target);
$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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ allowMissing |
bool
Optional. If set to true, then deleting an already deleted or non-existing |
↳ validateOnly |
bool
Optional. If set, validate the request and preview the review, but do not actually post it. |
↳ force |
bool
Optional. If set to true, all child resources under this pipeline will also be deleted. Otherwise, the request will only work if the pipeline has no child resources. |
↳ etag |
string
Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->deleteDeliveryPipeline($formattedName);
$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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ allowMissing |
bool
Optional. If set to true, then deleting an already deleted or non-existing DeliveryPipeline will succeed. |
↳ validateOnly |
bool
Optional. If set, validate the request and preview the review, but do not actually post it. |
↳ etag |
string
Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->deleteTarget($formattedName);
$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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of requested configuration. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\Config | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
use Google\Cloud\Deploy\V1\Config;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var Config $response */
$response = $cloudDeployClient->getConfig($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\DeliveryPipeline | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
use Google\Cloud\Deploy\V1\DeliveryPipeline;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var DeliveryPipeline $response */
$response = $cloudDeployClient->getDeliveryPipeline($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\JobRun | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var JobRun $response */
$response = $cloudDeployClient->getJobRun($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\Release | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var Release $response */
$response = $cloudDeployClient->getRelease($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\Rollout | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var Rollout $response */
$response = $cloudDeployClient->getRollout($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Name of the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\Target | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var Target $response */
$response = $cloudDeployClient->getTarget($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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);
}
listDeliveryPipelines
Lists DeliveryPipelines in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Filter pipelines to be returned. See https://google.aip.dev/160 for more details. |
↳ orderBy |
string
Field to sort by. See https://google.aip.dev/132#ordering for more details. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
use Google\Cloud\Deploy\V1\DeliveryPipeline;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cloudDeployClient->listDeliveryPipelines($formattedParent);
/** @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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Optional. Filter results to be returned. See https://google.aip.dev/160 for more details. |
↳ orderBy |
string
Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
use Google\Cloud\Deploy\V1\JobRun;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cloudDeployClient->listJobRuns($formattedParent);
/** @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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Optional. Filter releases to be returned. See https://google.aip.dev/160 for more details. |
↳ orderBy |
string
Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cloudDeployClient->listReleases($formattedParent);
/** @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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details. |
↳ orderBy |
string
Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cloudDeployClient->listRollouts($formattedParent);
/** @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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details. |
↳ orderBy |
string
Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cloudDeployClient->listTargets($formattedParent);
/** @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());
}
}
/**
* 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.
| Parameters | |
|---|---|
| Name | Description |
rollout |
string
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. |
phaseId |
string
Required. The phase ID the Job to retry belongs to. |
jobId |
string
Required. The job ID for the Job to retry. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\RetryJobResponse | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var RetryJobResponse $response */
$response = $cloudDeployClient->retryJob($formattedRollout, $phaseId, $jobId);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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);
}
updateDeliveryPipeline
Updates the parameters of a single DeliveryPipeline.
| Parameters | |
|---|---|
| Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. Field mask is used to specify the fields to be overwritten in the
|
deliveryPipeline |
Google\Cloud\Deploy\V1\DeliveryPipeline
Required. The |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ allowMissing |
bool
Optional. If set to true, updating a |
↳ validateOnly |
bool
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
use Google\Cloud\Deploy\V1\DeliveryPipeline;
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 any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$deliveryPipeline = new DeliveryPipeline();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->updateDeliveryPipeline($updateMask, $deliveryPipeline);
$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.
| Parameters | |
|---|---|
| Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. Field mask is used to specify the fields to be overwritten in the Target resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
target |
Google\Cloud\Deploy\V1\Target
Required. The |
optionalArgs |
array
Optional. |
↳ requestId |
string
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
↳ allowMissing |
bool
Optional. If set to true, updating a |
↳ validateOnly |
bool
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
use Google\Cloud\Deploy\V1\Target;
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 any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$target = new Target();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->updateTarget($updateMask, $target);
$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.
| Parameters | |
|---|---|
| Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Location\Location | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $cloudDeployClient->getLocation();
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cloudDeployClient->listLocations();
/** @var Location $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
| Parameters | |
|---|---|
| Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
optionalArgs |
array
Optional. |
↳ options |
GetPolicyOptions
OPTIONAL: A |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $cloudDeployClient->getIamPolicy($resource);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
errors.
| Parameters | |
|---|---|
| Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
Google\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
use Google\Cloud\Iam\V1\Policy;
/**
* @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 any non-scalar elements to be passed along with the request.
$policy = new Policy();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $cloudDeployClient->setIamPolicy($resource, $policy);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
| Parameters | |
|---|---|
| Name | Description |
resource |
string
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
string[]
The set of permissions to check for the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse | |
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CloudDeployClient;
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 any non-scalar elements to be passed along with the request.
$permissions = [$permissionsElement,];
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $cloudDeployClient->testIamPermissions($resource, $permissions);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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);
}
Constants
SERVICE_NAME
Value: 'google.cloud.deploy.v1.CloudDeploy'The name of the service.
SERVICE_ADDRESS
Value: 'clouddeploy.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.