Google Cloud Deploy v1 API - Class CloudDeploy.CloudDeployBase (2.5.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).

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).

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).

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).

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).

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).

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).

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).

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).

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).

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).

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).

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).

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).