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.
This service has a new (beta) implementation. See Google\Cloud\Deploy\V1\Client\CloudDeployClient to use the new surface.
Namespace
Google \ Cloud \ Deploy \ V1Methods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
abandonRelease
Abandons a Release in the Delivery Pipeline.
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.
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.
name
string
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}
.
phaseId
string
Required. The phase ID to advance the Rollout
to.
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.
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.
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.
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);
}
cancelAutomationRun
Cancels an AutomationRun. The state
of the AutomationRun
after
cancelling is CANCELLED
. CancelAutomationRun
can be called on
AutomationRun in the state IN_PROGRESS
and PENDING
; AutomationRun
in a different state returns an FAILED_PRECONDITION
error.
name
string
Required. Name of the AutomationRun
. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}
.
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\CancelAutomationRunRequest;
use Google\Cloud\Deploy\V1\CancelAutomationRunResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
/**
* @param string $formattedName Name of the `AutomationRun`. Format is
* `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`. Please see
* {@see CloudDeployClient::automationRunName()} for help formatting this field.
*/
function cancel_automation_run_sample(string $formattedName): void
{
// Create a client.
$cloudDeployClient = new CloudDeployClient();
// Prepare the request message.
$request = (new CancelAutomationRunRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var CancelAutomationRunResponse $response */
$response = $cloudDeployClient->cancelAutomationRun($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::automationRunName(
'[PROJECT]',
'[LOCATION]',
'[DELIVERY_PIPELINE]',
'[AUTOMATION_RUN]'
);
cancel_automation_run_sample($formattedName);
}
cancelRollout
Cancels a Rollout in a given project and location.
name
string
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}
.
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.
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);
}
createAutomation
Creates a new Automation in a given project and location.
parent
string
Required. The parent collection in which the Automation
should be
created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}
.
automationId
string
Required. ID of the Automation
.
automation
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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Automation;
use Google\Cloud\Deploy\V1\AutomationResourceSelector;
use Google\Cloud\Deploy\V1\AutomationRule;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\CreateAutomationRequest;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent collection in which the `Automation` 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 $automationId ID of the `Automation`.
* @param string $automationServiceAccount Email address of the user-managed IAM service account that
* creates Cloud Deploy release and rollout resources.
*/
function create_automation_sample(
string $formattedParent,
string $automationId,
string $automationServiceAccount
): void {
// Create a client.
$cloudDeployClient = new CloudDeployClient();
// Prepare the request message.
$automationSelector = new AutomationResourceSelector();
$automationRules = [new AutomationRule()];
$automation = (new Automation())
->setServiceAccount($automationServiceAccount)
->setSelector($automationSelector)
->setRules($automationRules);
$request = (new CreateAutomationRequest())
->setParent($formattedParent)
->setAutomationId($automationId)
->setAutomation($automation);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->createAutomation($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Automation $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]'
);
$automationId = '[AUTOMATION_ID]';
$automationServiceAccount = '[SERVICE_ACCOUNT]';
create_automation_sample($formattedParent, $automationId, $automationServiceAccount);
}
createDeliveryPipeline
Creates a new DeliveryPipeline in a given project and location.
parent
string
Required. The parent collection in which the DeliveryPipeline
should be
created. Format should be projects/{project_id}/locations/{location_name}
.
deliveryPipelineId
string
Required. ID of the DeliveryPipeline
.
deliveryPipeline
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.
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.
parent
string
Required. The parent collection in which the Release
should be created.
Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}
.
releaseId
string
Required. ID of the Release
.
release
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.
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.
parent
string
Required. 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}
.
rolloutId
string
Required. ID of the Rollout
.
rollout
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.
↳ startingPhaseId
string
Optional. The starting phase ID for the Rollout
. If empty the Rollout
will start at the first phase.
↳ 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.
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.
parent
string
Required. The parent collection in which the Target
should be created.
Format should be projects/{project_id}/locations/{location_name}
.
targetId
string
Required. ID of the Target
.
target
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.
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);
}
deleteAutomation
Deletes a single Automation resource.
name
string
Required. The name of the Automation
to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}
.
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 Automation
will succeed.
↳ validateOnly
bool
Optional. If set, validate the request and verify whether the resource exists, but do not actually post it.
↳ etag
string
Optional. The weak etag of the request. 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\DeleteAutomationRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the `Automation` to delete. Format should be
* `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`. Please see
* {@see CloudDeployClient::automationName()} for help formatting this field.
*/
function delete_automation_sample(string $formattedName): void
{
// Create a client.
$cloudDeployClient = new CloudDeployClient();
// Prepare the request message.
$request = (new DeleteAutomationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->deleteAutomation($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::automationName(
'[PROJECT]',
'[LOCATION]',
'[DELIVERY_PIPELINE]',
'[AUTOMATION]'
);
delete_automation_sample($formattedName);
}
deleteDeliveryPipeline
Deletes a single DeliveryPipeline.
name
string
Required. The name of the DeliveryPipeline
to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}
.
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.
↳ 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.
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.
name
string
Required. The name of the Target
to delete. Format should be projects/{project_id}/locations/{location_name}/targets/{target_name}
.
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 Target
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.
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);
}
getAutomation
Gets details of a single Automation.
name
string
Required. Name of the Automation
. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}
.
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Automation;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\GetAutomationRequest;
/**
* @param string $formattedName Name of the `Automation`. Format must be
* `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`. Please see
* {@see CloudDeployClient::automationName()} for help formatting this field.
*/
function get_automation_sample(string $formattedName): void
{
// Create a client.
$cloudDeployClient = new CloudDeployClient();
// Prepare the request message.
$request = (new GetAutomationRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Automation $response */
$response = $cloudDeployClient->getAutomation($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::automationName(
'[PROJECT]',
'[LOCATION]',
'[DELIVERY_PIPELINE]',
'[AUTOMATION]'
);
get_automation_sample($formattedName);
}
getAutomationRun
Gets details of a single AutomationRun.
name
string
Required. Name of the AutomationRun
. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}
.
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.
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\AutomationRun;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\GetAutomationRunRequest;
/**
* @param string $formattedName Name of the `AutomationRun`. Format must be
* `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`. Please see
* {@see CloudDeployClient::automationRunName()} for help formatting this field.
*/
function get_automation_run_sample(string $formattedName): void
{
// Create a client.
$cloudDeployClient = new CloudDeployClient();
// Prepare the request message.
$request = (new GetAutomationRunRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var AutomationRun $response */
$response = $cloudDeployClient->getAutomationRun($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::automationRunName(
'[PROJECT]',
'[LOCATION]',
'[DELIVERY_PIPELINE]',
'[AUTOMATION_RUN]'
);
get_automation_run_sample($formattedName);
}
getConfig
Gets the configuration for a location.
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.
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.
name
string
Required. Name of the DeliveryPipeline
. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}
.
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.
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.
name
string
Required. 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}
.
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.
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.
name
string
Required. Name of the Release
. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}
.
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.
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.
name
string
Required. Name of the Rollout
. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}
.
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.
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.
name
string
Required. Name of the Target
. Format must be projects/{project_id}/locations/{location_name}/targets/{target_name}
.
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.
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.
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 ignore belongs to.
jobId
string
Required. The job ID for the Job to ignore.
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.
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);
}
listAutomationRuns
Lists AutomationRuns in a given project and location.
parent
string
Required. The parent, which owns this collection of automationRuns. Format
must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}
.
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 automationRuns to be returned. All fields can be used in the filter.
↳ orderBy
string
Field to sort by.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\AutomationRun;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\ListAutomationRunsRequest;
/**
* @param string $formattedParent The parent, which owns this collection of automationRuns. Format
* must be
* `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`. Please see
* {@see CloudDeployClient::deliveryPipelineName()} for help formatting this field.
*/
function list_automation_runs_sample(string $formattedParent): void
{
// Create a client.
$cloudDeployClient = new CloudDeployClient();
// Prepare the request message.
$request = (new ListAutomationRunsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cloudDeployClient->listAutomationRuns($request);
/** @var AutomationRun $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_automation_runs_sample($formattedParent);
}
listAutomations
Lists Automations in a given project and location.
parent
string
Required. The parent, which owns this collection of automations. Format
must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_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 automations to be returned. All fields can be used in the filter.
↳ orderBy
string
Field to sort by.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Deploy\V1\Automation;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\ListAutomationsRequest;
/**
* @param string $formattedParent The parent, which owns this collection of automations. Format
* must be
* `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. Please see
* {@see CloudDeployClient::deliveryPipelineName()} for help formatting this field.
*/
function list_automations_sample(string $formattedParent): void
{
// Create a client.
$cloudDeployClient = new CloudDeployClient();
// Prepare the request message.
$request = (new ListAutomationsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cloudDeployClient->listAutomations($request);
/** @var Automation $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_automations_sample($formattedParent);
}
listDeliveryPipelines
Lists DeliveryPipelines in a given project and location.
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
↳ orderBy
↳ 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.
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.
parent
string
Required. The Rollout
which owns this collection of JobRun
objects.
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
↳ orderBy
↳ 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.
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.
parent
string
Required. The DeliveryPipeline
which owns this collection of Release
objects.
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
↳ orderBy
↳ 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.
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.
parent
string
Required. The Release
which owns this collection of Rollout
objects.
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
↳ orderBy
↳ 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.
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.
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
↳ orderBy
↳ 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.
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.
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.
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);
}
rollbackTarget
Creates a Rollout
to roll back the specified target.
name
string
Required. The DeliveryPipeline
for which the rollback Rollout
should be
created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}
.
targetId
string
Required. ID of the Target
that is being rolled back.
rolloutId
string
Required. ID of the rollback Rollout
to create.
optionalArgs
array
Optional.
↳ releaseId
string
Optional. ID of the Release
to roll back to. If this isn't specified, the previous successful Rollout
to the specified target will be used to determine the Release
.
↳ rolloutToRollBack
string
Optional. If provided, this must be the latest Rollout
that is on the Target
.
↳ rollbackConfig
RollbackTargetConfig
Optional. Configs for the rollback Rollout
.
↳ validateOnly
bool
Optional. If set to true, the request is validated and the user is provided with a RollbackTargetResponse
.
↳ 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.
use Google\ApiCore\ApiException;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\RollbackTargetRequest;
use Google\Cloud\Deploy\V1\RollbackTargetResponse;
/**
* @param string $formattedName The `DeliveryPipeline` for which the rollback `Rollout` 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 $targetId ID of the `Target` that is being rolled back.
* @param string $rolloutId ID of the rollback `Rollout` to create.
*/
function rollback_target_sample(string $formattedName, string $targetId, string $rolloutId): void
{
// Create a client.
$cloudDeployClient = new CloudDeployClient();
// Prepare the request message.
$request = (new RollbackTargetRequest())
->setName($formattedName)
->setTargetId($targetId)
->setRolloutId($rolloutId);
// Call the API and handle any network failures.
try {
/** @var RollbackTargetResponse $response */
$response = $cloudDeployClient->rollbackTarget($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]'
);
$targetId = '[TARGET_ID]';
$rolloutId = '[ROLLOUT_ID]';
rollback_target_sample($formattedName, $targetId, $rolloutId);
}
terminateJobRun
Terminates a Job Run in a given project and location.
name
string
Required. Name of the JobRun
. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}
.
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.
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);
}
updateAutomation
Updates the parameters of a single Automation resource.
updateMask
Google\Protobuf\FieldMask
Required. Field mask is used to specify the fields to be overwritten in the Automation
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.
automation
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 Automation
that does not exist will result in the creation of a new Automation
.
↳ 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.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Deploy\V1\Automation;
use Google\Cloud\Deploy\V1\AutomationResourceSelector;
use Google\Cloud\Deploy\V1\AutomationRule;
use Google\Cloud\Deploy\V1\Client\CloudDeployClient;
use Google\Cloud\Deploy\V1\UpdateAutomationRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* @param string $automationServiceAccount Email address of the user-managed IAM service account that
* creates Cloud Deploy release and rollout resources.
*/
function update_automation_sample(string $automationServiceAccount): void
{
// Create a client.
$cloudDeployClient = new CloudDeployClient();
// Prepare the request message.
$updateMask = new FieldMask();
$automationSelector = new AutomationResourceSelector();
$automationRules = [new AutomationRule()];
$automation = (new Automation())
->setServiceAccount($automationServiceAccount)
->setSelector($automationSelector)
->setRules($automationRules);
$request = (new UpdateAutomationRequest())
->setUpdateMask($updateMask)
->setAutomation($automation);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudDeployClient->updateAutomation($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Automation $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
{
$automationServiceAccount = '[SERVICE_ACCOUNT]';
update_automation_sample($automationServiceAccount);
}
updateDeliveryPipeline
Updates the parameters of a single DeliveryPipeline.
updateMask
Google\Protobuf\FieldMask
Required. Field mask is used to specify the fields to be overwritten in the DeliveryPipeline
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.
deliveryPipeline
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 DeliveryPipeline
that does not exist will result in the creation of a new DeliveryPipeline
.
↳ 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.
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.
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
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 Target
that does not exist will result in the creation of a new Target
.
↳ 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.
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.
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.
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.
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.
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.
resource
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
optionalArgs
array
Optional.
↳ options
GetPolicyOptions
OPTIONAL: A GetPolicyOptions
object for specifying options to GetIamPolicy
.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
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.
resource
string
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy
Google\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the resource
. The size of
the policy is limited to a few 10s of KB. An empty policy is a
valid policy but certain Cloud Platform services (such as Projects)
might reject them.
optionalArgs
array
Optional.
↳ updateMask
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
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.
resource
string
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions
string[]
The set of permissions to check for the resource
. Permissions with
wildcards (such as ' ' or 'storage.
') are not allowed. For more
information see IAM Overview
.
optionalArgs
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
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);
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::automationName
Formats a string containing the fully-qualified path to represent a automation resource.
project
string
location
string
deliveryPipeline
string
automation
string
string
static::automationRunName
Formats a string containing the fully-qualified path to represent a automation_run resource.
project
string
location
string
deliveryPipeline
string
automationRun
string
string
static::buildName
Formats a string containing the fully-qualified path to represent a build resource.
project
string
location
string
build
string
string
static::clusterName
Formats a string containing the fully-qualified path to represent a cluster resource.
project
string
location
string
cluster
string
string
static::configName
Formats a string containing the fully-qualified path to represent a config resource.
project
string
location
string
string
static::deliveryPipelineName
Formats a string containing the fully-qualified path to represent a delivery_pipeline resource.
project
string
location
string
deliveryPipeline
string
string
static::jobName
Formats a string containing the fully-qualified path to represent a job resource.
project
string
location
string
job
string
string
static::jobRunName
Formats a string containing the fully-qualified path to represent a job_run resource.
project
string
location
string
deliveryPipeline
string
release
string
rollout
string
jobRun
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::membershipName
Formats a string containing the fully-qualified path to represent a membership resource.
project
string
location
string
membership
string
string
static::releaseName
Formats a string containing the fully-qualified path to represent a release resource.
project
string
location
string
deliveryPipeline
string
release
string
string
static::rolloutName
Formats a string containing the fully-qualified path to represent a rollout resource.
project
string
location
string
deliveryPipeline
string
release
string
rollout
string
string
static::serviceName
Formats a string containing the fully-qualified path to represent a service resource.
project
string
location
string
service
string
string
static::targetName
Formats a string containing the fully-qualified path to represent a target resource.
project
string
location
string
target
string
string
static::workerPoolName
Formats a string containing the fully-qualified path to represent a worker_pool resource.
project
string
location
string
workerPool
string
string
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- automation: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}
- automationRun: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}
- 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}
- job: projects/{project}/locations/{location}/jobs/{job}
- 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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
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: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.