Google Cloud Deploy v1 API - Class CloudDeployClient (2.4.0)

public abstract class CloudDeployClient

Reference documentation and code samples for the Google Cloud Deploy v1 API class CloudDeployClient.

CloudDeploy client wrapper, for convenient use.

Inheritance

object > CloudDeployClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

CloudDeployClientImpl

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Remarks

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

Properties

CreateDeliveryPipelineOperationsClient

public virtual OperationsClient CreateDeliveryPipelineOperationsClient { get; }

The long-running operations client for CreateDeliveryPipeline.

Property Value
Type	Description
OperationsClient

CreateReleaseOperationsClient

public virtual OperationsClient CreateReleaseOperationsClient { get; }

The long-running operations client for CreateRelease.

Property Value
Type	Description
OperationsClient

CreateRolloutOperationsClient

public virtual OperationsClient CreateRolloutOperationsClient { get; }

The long-running operations client for CreateRollout.

Property Value
Type	Description
OperationsClient

CreateTargetOperationsClient

public virtual OperationsClient CreateTargetOperationsClient { get; }

The long-running operations client for CreateTarget.

Property Value
Type	Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the CloudDeploy service, which is a host of "clouddeploy.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default CloudDeploy scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default CloudDeploy scopes are:

• https://www.googleapis.com/auth/cloud-platform

DeleteDeliveryPipelineOperationsClient

public virtual OperationsClient DeleteDeliveryPipelineOperationsClient { get; }

The long-running operations client for DeleteDeliveryPipeline.

Property Value
Type	Description
OperationsClient

DeleteTargetOperationsClient

public virtual OperationsClient DeleteTargetOperationsClient { get; }

The long-running operations client for DeleteTarget.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual CloudDeploy.CloudDeployClient GrpcClient { get; }

The underlying gRPC CloudDeploy client

Property Value
Type	Description
CloudDeployCloudDeployClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

UpdateDeliveryPipelineOperationsClient

public virtual OperationsClient UpdateDeliveryPipelineOperationsClient { get; }

The long-running operations client for UpdateDeliveryPipeline.

Property Value
Type	Description
OperationsClient

UpdateTargetOperationsClient

public virtual OperationsClient UpdateTargetOperationsClient { get; }

The long-running operations client for UpdateTarget.

Property Value
Type	Description
OperationsClient

Methods

AbandonRelease(AbandonReleaseRequest, CallSettings)

public virtual AbandonReleaseResponse AbandonRelease(AbandonReleaseRequest request, CallSettings callSettings = null)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
request	AbandonReleaseRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AbandonReleaseResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
AbandonReleaseRequest request = new AbandonReleaseRequest
{
    ReleaseName = ReleaseName.FromProjectLocationDeliveryPipelineRelease("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]"),
};
// Make the request
AbandonReleaseResponse response = cloudDeployClient.AbandonRelease(request);

AbandonRelease(ReleaseName, CallSettings)

public virtual AbandonReleaseResponse AbandonRelease(ReleaseName name, CallSettings callSettings = null)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
name	ReleaseName Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AbandonReleaseResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
ReleaseName name = ReleaseName.FromProjectLocationDeliveryPipelineRelease("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]");
// Make the request
AbandonReleaseResponse response = cloudDeployClient.AbandonRelease(name);

AbandonRelease(string, CallSettings)

public virtual AbandonReleaseResponse AbandonRelease(string name, CallSettings callSettings = null)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
name	string Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AbandonReleaseResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]";
// Make the request
AbandonReleaseResponse response = cloudDeployClient.AbandonRelease(name);

AbandonReleaseAsync(AbandonReleaseRequest, CallSettings)

public virtual Task<AbandonReleaseResponse> AbandonReleaseAsync(AbandonReleaseRequest request, CallSettings callSettings = null)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
request	AbandonReleaseRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAbandonReleaseResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
AbandonReleaseRequest request = new AbandonReleaseRequest
{
    ReleaseName = ReleaseName.FromProjectLocationDeliveryPipelineRelease("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]"),
};
// Make the request
AbandonReleaseResponse response = await cloudDeployClient.AbandonReleaseAsync(request);

AbandonReleaseAsync(AbandonReleaseRequest, CancellationToken)

public virtual Task<AbandonReleaseResponse> AbandonReleaseAsync(AbandonReleaseRequest request, CancellationToken cancellationToken)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
request	AbandonReleaseRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAbandonReleaseResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
AbandonReleaseRequest request = new AbandonReleaseRequest
{
    ReleaseName = ReleaseName.FromProjectLocationDeliveryPipelineRelease("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]"),
};
// Make the request
AbandonReleaseResponse response = await cloudDeployClient.AbandonReleaseAsync(request);

AbandonReleaseAsync(ReleaseName, CallSettings)

public virtual Task<AbandonReleaseResponse> AbandonReleaseAsync(ReleaseName name, CallSettings callSettings = null)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
name	ReleaseName Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAbandonReleaseResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
ReleaseName name = ReleaseName.FromProjectLocationDeliveryPipelineRelease("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]");
// Make the request
AbandonReleaseResponse response = await cloudDeployClient.AbandonReleaseAsync(name);

AbandonReleaseAsync(ReleaseName, CancellationToken)

public virtual Task<AbandonReleaseResponse> AbandonReleaseAsync(ReleaseName name, CancellationToken cancellationToken)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
name	ReleaseName Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAbandonReleaseResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
ReleaseName name = ReleaseName.FromProjectLocationDeliveryPipelineRelease("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]");
// Make the request
AbandonReleaseResponse response = await cloudDeployClient.AbandonReleaseAsync(name);

AbandonReleaseAsync(string, CallSettings)

public virtual Task<AbandonReleaseResponse> AbandonReleaseAsync(string name, CallSettings callSettings = null)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
name	string Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAbandonReleaseResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]";
// Make the request
AbandonReleaseResponse response = await cloudDeployClient.AbandonReleaseAsync(name);

AbandonReleaseAsync(string, CancellationToken)

public virtual Task<AbandonReleaseResponse> AbandonReleaseAsync(string name, CancellationToken cancellationToken)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
name	string Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAbandonReleaseResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]";
// Make the request
AbandonReleaseResponse response = await cloudDeployClient.AbandonReleaseAsync(name);

AdvanceRollout(AdvanceRolloutRequest, CallSettings)

public virtual AdvanceRolloutResponse AdvanceRollout(AdvanceRolloutRequest request, CallSettings callSettings = null)

Advances a Rollout in a given project and location.

Parameters
Name	Description
request	AdvanceRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AdvanceRolloutResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
AdvanceRolloutRequest request = new AdvanceRolloutRequest
{
    RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
    PhaseId = "",
};
// Make the request
AdvanceRolloutResponse response = cloudDeployClient.AdvanceRollout(request);

AdvanceRollout(RolloutName, string, CallSettings)

public virtual AdvanceRolloutResponse AdvanceRollout(RolloutName name, string phaseId, CallSettings callSettings = null)

Advances a Rollout in a given project and location.

Parameters
Name	Description
name	RolloutName 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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AdvanceRolloutResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
RolloutName name = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
string phaseId = "";
// Make the request
AdvanceRolloutResponse response = cloudDeployClient.AdvanceRollout(name, phaseId);

AdvanceRollout(string, string, CallSettings)

public virtual AdvanceRolloutResponse AdvanceRollout(string name, string phaseId, CallSettings callSettings = null)

Advances a Rollout in a given project and location.

Parameters
Name	Description
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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AdvanceRolloutResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]/rollouts/[ROLLOUT]";
string phaseId = "";
// Make the request
AdvanceRolloutResponse response = cloudDeployClient.AdvanceRollout(name, phaseId);

AdvanceRolloutAsync(AdvanceRolloutRequest, CallSettings)

public virtual Task<AdvanceRolloutResponse> AdvanceRolloutAsync(AdvanceRolloutRequest request, CallSettings callSettings = null)

Advances a Rollout in a given project and location.

Parameters
Name	Description
request	AdvanceRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAdvanceRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
AdvanceRolloutRequest request = new AdvanceRolloutRequest
{
    RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
    PhaseId = "",
};
// Make the request
AdvanceRolloutResponse response = await cloudDeployClient.AdvanceRolloutAsync(request);

AdvanceRolloutAsync(AdvanceRolloutRequest, CancellationToken)

public virtual Task<AdvanceRolloutResponse> AdvanceRolloutAsync(AdvanceRolloutRequest request, CancellationToken cancellationToken)

Advances a Rollout in a given project and location.

Parameters
Name	Description
request	AdvanceRolloutRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAdvanceRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
AdvanceRolloutRequest request = new AdvanceRolloutRequest
{
    RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
    PhaseId = "",
};
// Make the request
AdvanceRolloutResponse response = await cloudDeployClient.AdvanceRolloutAsync(request);

AdvanceRolloutAsync(RolloutName, string, CallSettings)

public virtual Task<AdvanceRolloutResponse> AdvanceRolloutAsync(RolloutName name, string phaseId, CallSettings callSettings = null)

Advances a Rollout in a given project and location.

Parameters
Name	Description
name	RolloutName 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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAdvanceRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
RolloutName name = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
string phaseId = "";
// Make the request
AdvanceRolloutResponse response = await cloudDeployClient.AdvanceRolloutAsync(name, phaseId);

AdvanceRolloutAsync(RolloutName, string, CancellationToken)

public virtual Task<AdvanceRolloutResponse> AdvanceRolloutAsync(RolloutName name, string phaseId, CancellationToken cancellationToken)

Advances a Rollout in a given project and location.

Parameters
Name	Description
name	RolloutName 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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAdvanceRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
RolloutName name = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
string phaseId = "";
// Make the request
AdvanceRolloutResponse response = await cloudDeployClient.AdvanceRolloutAsync(name, phaseId);

AdvanceRolloutAsync(string, string, CallSettings)

public virtual Task<AdvanceRolloutResponse> AdvanceRolloutAsync(string name, string phaseId, CallSettings callSettings = null)

Advances a Rollout in a given project and location.

Parameters
Name	Description
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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAdvanceRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]/rollouts/[ROLLOUT]";
string phaseId = "";
// Make the request
AdvanceRolloutResponse response = await cloudDeployClient.AdvanceRolloutAsync(name, phaseId);

AdvanceRolloutAsync(string, string, CancellationToken)

public virtual Task<AdvanceRolloutResponse> AdvanceRolloutAsync(string name, string phaseId, CancellationToken cancellationToken)

Advances a Rollout in a given project and location.

Parameters
Name	Description
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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskAdvanceRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]/rollouts/[ROLLOUT]";
string phaseId = "";
// Make the request
AdvanceRolloutResponse response = await cloudDeployClient.AdvanceRolloutAsync(name, phaseId);

ApproveRollout(ApproveRolloutRequest, CallSettings)

public virtual ApproveRolloutResponse ApproveRollout(ApproveRolloutRequest request, CallSettings callSettings = null)

Approves a Rollout.

Parameters
Name	Description
request	ApproveRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ApproveRolloutResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
ApproveRolloutRequest request = new ApproveRolloutRequest
{
    RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
    Approved = false,
};
// Make the request
ApproveRolloutResponse response = cloudDeployClient.ApproveRollout(request);

ApproveRollout(RolloutName, CallSettings)

public virtual ApproveRolloutResponse ApproveRollout(RolloutName name, CallSettings callSettings = null)

Approves a Rollout.

Parameters
Name	Description
name	RolloutName Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ApproveRolloutResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
RolloutName name = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
// Make the request
ApproveRolloutResponse response = cloudDeployClient.ApproveRollout(name);

ApproveRollout(string, CallSettings)

public virtual ApproveRolloutResponse ApproveRollout(string name, CallSettings callSettings = null)

Approves a Rollout.

Parameters
Name	Description
name	string Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ApproveRolloutResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]/rollouts/[ROLLOUT]";
// Make the request
ApproveRolloutResponse response = cloudDeployClient.ApproveRollout(name);

ApproveRolloutAsync(ApproveRolloutRequest, CallSettings)

public virtual Task<ApproveRolloutResponse> ApproveRolloutAsync(ApproveRolloutRequest request, CallSettings callSettings = null)

Approves a Rollout.

Parameters
Name	Description
request	ApproveRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskApproveRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
ApproveRolloutRequest request = new ApproveRolloutRequest
{
    RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
    Approved = false,
};
// Make the request
ApproveRolloutResponse response = await cloudDeployClient.ApproveRolloutAsync(request);

ApproveRolloutAsync(ApproveRolloutRequest, CancellationToken)

public virtual Task<ApproveRolloutResponse> ApproveRolloutAsync(ApproveRolloutRequest request, CancellationToken cancellationToken)

Approves a Rollout.

Parameters
Name	Description
request	ApproveRolloutRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskApproveRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
ApproveRolloutRequest request = new ApproveRolloutRequest
{
    RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
    Approved = false,
};
// Make the request
ApproveRolloutResponse response = await cloudDeployClient.ApproveRolloutAsync(request);

ApproveRolloutAsync(RolloutName, CallSettings)

public virtual Task<ApproveRolloutResponse> ApproveRolloutAsync(RolloutName name, CallSettings callSettings = null)

Approves a Rollout.

Parameters
Name	Description
name	RolloutName Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskApproveRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
RolloutName name = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
// Make the request
ApproveRolloutResponse response = await cloudDeployClient.ApproveRolloutAsync(name);

ApproveRolloutAsync(RolloutName, CancellationToken)

public virtual Task<ApproveRolloutResponse> ApproveRolloutAsync(RolloutName name, CancellationToken cancellationToken)

Approves a Rollout.

Parameters
Name	Description
name	RolloutName Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskApproveRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
RolloutName name = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
// Make the request
ApproveRolloutResponse response = await cloudDeployClient.ApproveRolloutAsync(name);

ApproveRolloutAsync(string, CallSettings)

public virtual Task<ApproveRolloutResponse> ApproveRolloutAsync(string name, CallSettings callSettings = null)

Approves a Rollout.

Parameters
Name	Description
name	string Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskApproveRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]/rollouts/[ROLLOUT]";
// Make the request
ApproveRolloutResponse response = await cloudDeployClient.ApproveRolloutAsync(name);

ApproveRolloutAsync(string, CancellationToken)

public virtual Task<ApproveRolloutResponse> ApproveRolloutAsync(string name, CancellationToken cancellationToken)

Approves a Rollout.

Parameters
Name	Description
name	string Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskApproveRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]/rollouts/[ROLLOUT]";
// Make the request
ApproveRolloutResponse response = await cloudDeployClient.ApproveRolloutAsync(name);

CancelRollout(CancelRolloutRequest, CallSettings)

public virtual CancelRolloutResponse CancelRollout(CancelRolloutRequest request, CallSettings callSettings = null)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
request	CancelRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CancelRolloutResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
CancelRolloutRequest request = new CancelRolloutRequest
{
    RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
};
// Make the request
CancelRolloutResponse response = cloudDeployClient.CancelRollout(request);

CancelRollout(RolloutName, CallSettings)

public virtual CancelRolloutResponse CancelRollout(RolloutName name, CallSettings callSettings = null)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
name	RolloutName Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CancelRolloutResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
RolloutName name = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
// Make the request
CancelRolloutResponse response = cloudDeployClient.CancelRollout(name);

CancelRollout(string, CallSettings)

public virtual CancelRolloutResponse CancelRollout(string name, CallSettings callSettings = null)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
name	string Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CancelRolloutResponse	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]/rollouts/[ROLLOUT]";
// Make the request
CancelRolloutResponse response = cloudDeployClient.CancelRollout(name);

CancelRolloutAsync(CancelRolloutRequest, CallSettings)

public virtual Task<CancelRolloutResponse> CancelRolloutAsync(CancelRolloutRequest request, CallSettings callSettings = null)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
request	CancelRolloutRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCancelRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
CancelRolloutRequest request = new CancelRolloutRequest
{
    RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
};
// Make the request
CancelRolloutResponse response = await cloudDeployClient.CancelRolloutAsync(request);

CancelRolloutAsync(CancelRolloutRequest, CancellationToken)

public virtual Task<CancelRolloutResponse> CancelRolloutAsync(CancelRolloutRequest request, CancellationToken cancellationToken)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
request	CancelRolloutRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCancelRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
CancelRolloutRequest request = new CancelRolloutRequest
{
    RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
};
// Make the request
CancelRolloutResponse response = await cloudDeployClient.CancelRolloutAsync(request);

CancelRolloutAsync(RolloutName, CallSettings)

public virtual Task<CancelRolloutResponse> CancelRolloutAsync(RolloutName name, CallSettings callSettings = null)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
name	RolloutName Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCancelRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
RolloutName name = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
// Make the request
CancelRolloutResponse response = await cloudDeployClient.CancelRolloutAsync(name);

CancelRolloutAsync(RolloutName, CancellationToken)

public virtual Task<CancelRolloutResponse> CancelRolloutAsync(RolloutName name, CancellationToken cancellationToken)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
name	RolloutName Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCancelRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
RolloutName name = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]");
// Make the request
CancelRolloutResponse response = await cloudDeployClient.CancelRolloutAsync(name);

CancelRolloutAsync(string, CallSettings)

public virtual Task<CancelRolloutResponse> CancelRolloutAsync(string name, CallSettings callSettings = null)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
name	string Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCancelRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]/rollouts/[ROLLOUT]";
// Make the request
CancelRolloutResponse response = await cloudDeployClient.CancelRolloutAsync(name);

CancelRolloutAsync(string, CancellationToken)

public virtual Task<CancelRolloutResponse> CancelRolloutAsync(string name, CancellationToken cancellationToken)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
name	string Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCancelRolloutResponse	A Task containing the RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/deliveryPipelines/[DELIVERY_PIPELINE]/releases/[RELEASE]/rollouts/[ROLLOUT]";
// Make the request
CancelRolloutResponse response = await cloudDeployClient.CancelRolloutAsync(name);

Create()

public static CloudDeployClient Create()

Synchronously creates a CloudDeployClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudDeployClientBuilder.

Returns
Type	Description
CloudDeployClient	The created CloudDeployClient.

CreateAsync(CancellationToken)

public static Task<CloudDeployClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a CloudDeployClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudDeployClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskCloudDeployClient	The task representing the created CloudDeployClient.

CreateDeliveryPipeline(LocationName, DeliveryPipeline, string, CallSettings)

public virtual Operation<DeliveryPipeline, OperationMetadata> CreateDeliveryPipeline(LocationName parent, DeliveryPipeline deliveryPipeline, string deliveryPipelineId, CallSettings callSettings = null)

Creates a new DeliveryPipeline in a given project and location.

Parameters
Name	Description
parent	LocationName Required. The parent collection in which the DeliveryPipeline should be created. Format should be projects/{project_id}/locations/{location_name}.
deliveryPipeline	DeliveryPipeline Required. The DeliveryPipeline to create.
deliveryPipelineId	string Required. ID of the DeliveryPipeline.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationDeliveryPipelineOperationMetadata	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
DeliveryPipeline deliveryPipeline = new DeliveryPipeline();
string deliveryPipelineId = "";
// Make the request
Operation<DeliveryPipeline, OperationMetadata> response = cloudDeployClient.CreateDeliveryPipeline(parent, deliveryPipeline, deliveryPipelineId);

// Poll until the returned long-running operation is complete
Operation<DeliveryPipeline, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeliveryPipeline result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeliveryPipeline, OperationMetadata> retrievedResponse = cloudDeployClient.PollOnceCreateDeliveryPipeline(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeliveryPipeline retrievedResult = retrievedResponse.Result;
}

CreateDeliveryPipeline(CreateDeliveryPipelineRequest, CallSettings)

public virtual Operation<DeliveryPipeline, OperationMetadata> CreateDeliveryPipeline(CreateDeliveryPipelineRequest request, CallSettings callSettings = null)

Creates a new DeliveryPipeline in a given project and location.

Parameters
Name	Description
request	CreateDeliveryPipelineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationDeliveryPipelineOperationMetadata	The RPC response.

Example

// Create client
CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
// Initialize request argument(s)
CreateDeliveryPipelineRequest request = new CreateDeliveryPipelineRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DeliveryPipelineId = "",
    DeliveryPipeline = new DeliveryPipeline(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<DeliveryPipeline, OperationMetadata> response = cloudDeployClient.CreateDeliveryPipeline(request);

// Poll until the returned long-running operation is complete
Operation<DeliveryPipeline, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeliveryPipeline result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeliveryPipeline, OperationMetadata> retrievedResponse = cloudDeployClient.PollOnceCreateDeliveryPipeline(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeliveryPipeline retrievedResult = retrievedResponse.Result;
}