Google Cloud Deploy v1 API - Class CloudDeploy.CloudDeployBase (3.1.0)

[BindServiceMethod(typeof(CloudDeploy), "BindService")]
public abstract class CloudDeploy.CloudDeployBase

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

Base class for server-side implementations of CloudDeploy

Inheritance

object > CloudDeploy.CloudDeployBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Methods

AbandonRelease(AbandonReleaseRequest, ServerCallContext)

public virtual Task<AbandonReleaseResponse> AbandonRelease(AbandonReleaseRequest request, ServerCallContext context)

Abandons a Release in the Delivery Pipeline.

Parameters
Name	Description
`request`	`AbandonReleaseRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskAbandonReleaseResponse`	The response to send back to the client (wrapped by a task).

AdvanceRollout(AdvanceRolloutRequest, ServerCallContext)

public virtual Task<AdvanceRolloutResponse> AdvanceRollout(AdvanceRolloutRequest request, ServerCallContext context)

Advances a Rollout in a given project and location.

Parameters
Name	Description
`request`	`AdvanceRolloutRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskAdvanceRolloutResponse`	The response to send back to the client (wrapped by a task).

ApproveRollout(ApproveRolloutRequest, ServerCallContext)

public virtual Task<ApproveRolloutResponse> ApproveRollout(ApproveRolloutRequest request, ServerCallContext context)

Approves a Rollout.

Parameters
Name	Description
`request`	`ApproveRolloutRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskApproveRolloutResponse`	The response to send back to the client (wrapped by a task).

CancelAutomationRun(CancelAutomationRunRequest, ServerCallContext)

public virtual Task<CancelAutomationRunResponse> CancelAutomationRun(CancelAutomationRunRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`CancelAutomationRunRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskCancelAutomationRunResponse`	The response to send back to the client (wrapped by a task).

CancelRollout(CancelRolloutRequest, ServerCallContext)

public virtual Task<CancelRolloutResponse> CancelRollout(CancelRolloutRequest request, ServerCallContext context)

Cancels a Rollout in a given project and location.

Parameters
Name	Description
`request`	`CancelRolloutRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskCancelRolloutResponse`	The response to send back to the client (wrapped by a task).

CreateAutomation(CreateAutomationRequest, ServerCallContext)

public virtual Task<Operation> CreateAutomation(CreateAutomationRequest request, ServerCallContext context)

Creates a new Automation in a given project and location.

Parameters
Name	Description
`request`	`CreateAutomationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateCustomTargetType(CreateCustomTargetTypeRequest, ServerCallContext)

public virtual Task<Operation> CreateCustomTargetType(CreateCustomTargetTypeRequest request, ServerCallContext context)

Creates a new CustomTargetType in a given project and location.

Parameters
Name	Description
`request`	`CreateCustomTargetTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateDeliveryPipeline(CreateDeliveryPipelineRequest, ServerCallContext)

public virtual Task<Operation> CreateDeliveryPipeline(CreateDeliveryPipelineRequest request, ServerCallContext context)

Creates a new DeliveryPipeline in a given project and location.

Parameters
Name	Description
`request`	`CreateDeliveryPipelineRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateDeployPolicy(CreateDeployPolicyRequest, ServerCallContext)

public virtual Task<Operation> CreateDeployPolicy(CreateDeployPolicyRequest request, ServerCallContext context)

Creates a new DeployPolicy in a given project and location.

Parameters
Name	Description
`request`	`CreateDeployPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateRelease(CreateReleaseRequest, ServerCallContext)

public virtual Task<Operation> CreateRelease(CreateReleaseRequest request, ServerCallContext context)

Creates a new Release in a given project and location.

Parameters
Name	Description
`request`	`CreateReleaseRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateRollout(CreateRolloutRequest, ServerCallContext)

public virtual Task<Operation> CreateRollout(CreateRolloutRequest request, ServerCallContext context)

Creates a new Rollout in a given project and location.

Parameters
Name	Description
`request`	`CreateRolloutRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateTarget(CreateTargetRequest, ServerCallContext)

public virtual Task<Operation> CreateTarget(CreateTargetRequest request, ServerCallContext context)

Creates a new Target in a given project and location.

Parameters
Name	Description
`request`	`CreateTargetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteAutomation(DeleteAutomationRequest, ServerCallContext)

public virtual Task<Operation> DeleteAutomation(DeleteAutomationRequest request, ServerCallContext context)

Deletes a single Automation resource.

Parameters
Name	Description
`request`	`DeleteAutomationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteCustomTargetType(DeleteCustomTargetTypeRequest, ServerCallContext)

public virtual Task<Operation> DeleteCustomTargetType(DeleteCustomTargetTypeRequest request, ServerCallContext context)

Deletes a single CustomTargetType.

Parameters
Name	Description
`request`	`DeleteCustomTargetTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteDeliveryPipeline(DeleteDeliveryPipelineRequest, ServerCallContext)

public virtual Task<Operation> DeleteDeliveryPipeline(DeleteDeliveryPipelineRequest request, ServerCallContext context)

Deletes a single DeliveryPipeline.

Parameters
Name	Description
`request`	`DeleteDeliveryPipelineRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteDeployPolicy(DeleteDeployPolicyRequest, ServerCallContext)

public virtual Task<Operation> DeleteDeployPolicy(DeleteDeployPolicyRequest request, ServerCallContext context)

Deletes a single DeployPolicy.

Parameters
Name	Description
`request`	`DeleteDeployPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteTarget(DeleteTargetRequest, ServerCallContext)

public virtual Task<Operation> DeleteTarget(DeleteTargetRequest request, ServerCallContext context)

Deletes a single Target.

Parameters
Name	Description
`request`	`DeleteTargetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetAutomation(GetAutomationRequest, ServerCallContext)

public virtual Task<Automation> GetAutomation(GetAutomationRequest request, ServerCallContext context)

Gets details of a single Automation.

Parameters
Name	Description
`request`	`GetAutomationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskAutomation`	The response to send back to the client (wrapped by a task).

GetAutomationRun(GetAutomationRunRequest, ServerCallContext)

public virtual Task<AutomationRun> GetAutomationRun(GetAutomationRunRequest request, ServerCallContext context)

Gets details of a single AutomationRun.

Parameters
Name	Description
`request`	`GetAutomationRunRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskAutomationRun`	The response to send back to the client (wrapped by a task).

GetConfig(GetConfigRequest, ServerCallContext)

public virtual Task<Config> GetConfig(GetConfigRequest request, ServerCallContext context)

Gets the configuration for a location.

Parameters
Name	Description
`request`	`GetConfigRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskConfig`	The response to send back to the client (wrapped by a task).

GetCustomTargetType(GetCustomTargetTypeRequest, ServerCallContext)

public virtual Task<CustomTargetType> GetCustomTargetType(GetCustomTargetTypeRequest request, ServerCallContext context)

Gets details of a single CustomTargetType.

Parameters
Name	Description
`request`	`GetCustomTargetTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskCustomTargetType`	The response to send back to the client (wrapped by a task).

GetDeliveryPipeline(GetDeliveryPipelineRequest, ServerCallContext)

public virtual Task<DeliveryPipeline> GetDeliveryPipeline(GetDeliveryPipelineRequest request, ServerCallContext context)

Gets details of a single DeliveryPipeline.

Parameters
Name	Description
`request`	`GetDeliveryPipelineRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDeliveryPipeline`	The response to send back to the client (wrapped by a task).

GetDeployPolicy(GetDeployPolicyRequest, ServerCallContext)

public virtual Task<DeployPolicy> GetDeployPolicy(GetDeployPolicyRequest request, ServerCallContext context)

Gets details of a single DeployPolicy.

Parameters
Name	Description
`request`	`GetDeployPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDeployPolicy`	The response to send back to the client (wrapped by a task).

GetJobRun(GetJobRunRequest, ServerCallContext)

public virtual Task<JobRun> GetJobRun(GetJobRunRequest request, ServerCallContext context)

Gets details of a single JobRun.

Parameters
Name	Description
`request`	`GetJobRunRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskJobRun`	The response to send back to the client (wrapped by a task).

GetRelease(GetReleaseRequest, ServerCallContext)

public virtual Task<Release> GetRelease(GetReleaseRequest request, ServerCallContext context)

Gets details of a single Release.

Parameters
Name	Description
`request`	`GetReleaseRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRelease`	The response to send back to the client (wrapped by a task).

GetRollout(GetRolloutRequest, ServerCallContext)

public virtual Task<Rollout> GetRollout(GetRolloutRequest request, ServerCallContext context)

Gets details of a single Rollout.

Parameters
Name	Description
`request`	`GetRolloutRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRollout`	The response to send back to the client (wrapped by a task).

GetTarget(GetTargetRequest, ServerCallContext)

public virtual Task<Target> GetTarget(GetTargetRequest request, ServerCallContext context)

Gets details of a single Target.

Parameters
Name	Description
`request`	`GetTargetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTarget`	The response to send back to the client (wrapped by a task).

IgnoreJob(IgnoreJobRequest, ServerCallContext)

public virtual Task<IgnoreJobResponse> IgnoreJob(IgnoreJobRequest request, ServerCallContext context)

Ignores the specified Job in a Rollout.

Parameters
Name	Description
`request`	`IgnoreJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskIgnoreJobResponse`	The response to send back to the client (wrapped by a task).

ListAutomationRuns(ListAutomationRunsRequest, ServerCallContext)

public virtual Task<ListAutomationRunsResponse> ListAutomationRuns(ListAutomationRunsRequest request, ServerCallContext context)

Lists AutomationRuns in a given project and location.

Parameters
Name	Description
`request`	`ListAutomationRunsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListAutomationRunsResponse`	The response to send back to the client (wrapped by a task).

ListAutomations(ListAutomationsRequest, ServerCallContext)

public virtual Task<ListAutomationsResponse> ListAutomations(ListAutomationsRequest request, ServerCallContext context)

Lists Automations in a given project and location.

Parameters
Name	Description
`request`	`ListAutomationsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListAutomationsResponse`	The response to send back to the client (wrapped by a task).

ListCustomTargetTypes(ListCustomTargetTypesRequest, ServerCallContext)

public virtual Task<ListCustomTargetTypesResponse> ListCustomTargetTypes(ListCustomTargetTypesRequest request, ServerCallContext context)

Lists CustomTargetTypes in a given project and location.

Parameters
Name	Description
`request`	`ListCustomTargetTypesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListCustomTargetTypesResponse`	The response to send back to the client (wrapped by a task).

ListDeliveryPipelines(ListDeliveryPipelinesRequest, ServerCallContext)

public virtual Task<ListDeliveryPipelinesResponse> ListDeliveryPipelines(ListDeliveryPipelinesRequest request, ServerCallContext context)

Lists DeliveryPipelines in a given project and location.

Parameters
Name	Description
`request`	`ListDeliveryPipelinesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListDeliveryPipelinesResponse`	The response to send back to the client (wrapped by a task).

ListDeployPolicies(ListDeployPoliciesRequest, ServerCallContext)

public virtual Task<ListDeployPoliciesResponse> ListDeployPolicies(ListDeployPoliciesRequest request, ServerCallContext context)

Lists DeployPolicies in a given project and location.

Parameters
Name	Description
`request`	`ListDeployPoliciesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListDeployPoliciesResponse`	The response to send back to the client (wrapped by a task).

ListJobRuns(ListJobRunsRequest, ServerCallContext)

public virtual Task<ListJobRunsResponse> ListJobRuns(ListJobRunsRequest request, ServerCallContext context)

Lists JobRuns in a given project and location.

Parameters
Name	Description
`request`	`ListJobRunsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListJobRunsResponse`	The response to send back to the client (wrapped by a task).

ListReleases(ListReleasesRequest, ServerCallContext)

public virtual Task<ListReleasesResponse> ListReleases(ListReleasesRequest request, ServerCallContext context)

Lists Releases in a given project and location.

Parameters
Name	Description
`request`	`ListReleasesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListReleasesResponse`	The response to send back to the client (wrapped by a task).

ListRollouts(ListRolloutsRequest, ServerCallContext)

public virtual Task<ListRolloutsResponse> ListRollouts(ListRolloutsRequest request, ServerCallContext context)

Lists Rollouts in a given project and location.

Parameters
Name	Description
`request`	`ListRolloutsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListRolloutsResponse`	The response to send back to the client (wrapped by a task).

ListTargets(ListTargetsRequest, ServerCallContext)

public virtual Task<ListTargetsResponse> ListTargets(ListTargetsRequest request, ServerCallContext context)

Lists Targets in a given project and location.

Parameters
Name	Description
`request`	`ListTargetsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListTargetsResponse`	The response to send back to the client (wrapped by a task).

RetryJob(RetryJobRequest, ServerCallContext)

public virtual Task<RetryJobResponse> RetryJob(RetryJobRequest request, ServerCallContext context)

Retries the specified Job in a Rollout.

Parameters
Name	Description
`request`	`RetryJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRetryJobResponse`	The response to send back to the client (wrapped by a task).

RollbackTarget(RollbackTargetRequest, ServerCallContext)

public virtual Task<RollbackTargetResponse> RollbackTarget(RollbackTargetRequest request, ServerCallContext context)

Creates a Rollout to roll back the specified target.

Parameters
Name	Description
`request`	`RollbackTargetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRollbackTargetResponse`	The response to send back to the client (wrapped by a task).

TerminateJobRun(TerminateJobRunRequest, ServerCallContext)

public virtual Task<TerminateJobRunResponse> TerminateJobRun(TerminateJobRunRequest request, ServerCallContext context)

Terminates a Job Run in a given project and location.

Parameters
Name	Description
`request`	`TerminateJobRunRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTerminateJobRunResponse`	The response to send back to the client (wrapped by a task).

UpdateAutomation(UpdateAutomationRequest, ServerCallContext)

public virtual Task<Operation> UpdateAutomation(UpdateAutomationRequest request, ServerCallContext context)

Updates the parameters of a single Automation resource.

Parameters
Name	Description
`request`	`UpdateAutomationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateCustomTargetType(UpdateCustomTargetTypeRequest, ServerCallContext)

public virtual Task<Operation> UpdateCustomTargetType(UpdateCustomTargetTypeRequest request, ServerCallContext context)

Updates a single CustomTargetType.

Parameters
Name	Description
`request`	`UpdateCustomTargetTypeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateDeliveryPipeline(UpdateDeliveryPipelineRequest, ServerCallContext)

public virtual Task<Operation> UpdateDeliveryPipeline(UpdateDeliveryPipelineRequest request, ServerCallContext context)

Updates the parameters of a single DeliveryPipeline.

Parameters
Name	Description
`request`	`UpdateDeliveryPipelineRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateDeployPolicy(UpdateDeployPolicyRequest, ServerCallContext)

public virtual Task<Operation> UpdateDeployPolicy(UpdateDeployPolicyRequest request, ServerCallContext context)

Updates the parameters of a single DeployPolicy.

Parameters
Name	Description
`request`	`UpdateDeployPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateTarget(UpdateTargetRequest, ServerCallContext)

public virtual Task<Operation> UpdateTarget(UpdateTargetRequest request, ServerCallContext context)

Updates the parameters of a single Target.

Parameters
Name	Description
`request`	`UpdateTargetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).