Class protos.google.cloud.deploy.v1.CloudDeploy (2.1.1)

Represents a CloudDeploy

Inheritance

$protobuf.rpc.Service > protos.google.cloud.deploy.v1.CloudDeploy

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new CloudDeploy service.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Methods

approveRollout(request, callback)

public approveRollout(request: google.cloud.deploy.v1.IApproveRolloutRequest, callback: google.cloud.deploy.v1.CloudDeploy.ApproveRolloutCallback): void;

Calls ApproveRollout.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IApproveRolloutRequest` ApproveRolloutRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.ApproveRolloutCallback` Node-style callback called with the error, if any, and ApproveRolloutResponse

Returns

Type	Description
void

approveRollout(request)

public approveRollout(request: google.cloud.deploy.v1.IApproveRolloutRequest): Promise<google.cloud.deploy.v1.ApproveRolloutResponse>;

Calls ApproveRollout.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IApproveRolloutRequest` ApproveRolloutRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.ApproveRolloutResponse>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CloudDeploy;

Creates new CloudDeploy service using the specified rpc implementation.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Returns

Type	Description
CloudDeploy	RPC service. Useful where requests and/or responses are streamed.

createDeliveryPipeline(request, callback)

public createDeliveryPipeline(request: google.cloud.deploy.v1.ICreateDeliveryPipelineRequest, callback: google.cloud.deploy.v1.CloudDeploy.CreateDeliveryPipelineCallback): void;

Calls CreateDeliveryPipeline.

Parameters

Name	Description
request	`google.cloud.deploy.v1.ICreateDeliveryPipelineRequest` CreateDeliveryPipelineRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.CreateDeliveryPipelineCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

createDeliveryPipeline(request)

public createDeliveryPipeline(request: google.cloud.deploy.v1.ICreateDeliveryPipelineRequest): Promise<google.longrunning.Operation>;

Calls CreateDeliveryPipeline.

Parameter

Name	Description
request	`google.cloud.deploy.v1.ICreateDeliveryPipelineRequest` CreateDeliveryPipelineRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

createRelease(request, callback)

public createRelease(request: google.cloud.deploy.v1.ICreateReleaseRequest, callback: google.cloud.deploy.v1.CloudDeploy.CreateReleaseCallback): void;

Calls CreateRelease.

Parameters

Name	Description
request	`google.cloud.deploy.v1.ICreateReleaseRequest` CreateReleaseRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.CreateReleaseCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

createRelease(request)

public createRelease(request: google.cloud.deploy.v1.ICreateReleaseRequest): Promise<google.longrunning.Operation>;

Calls CreateRelease.

Parameter

Name	Description
request	`google.cloud.deploy.v1.ICreateReleaseRequest` CreateReleaseRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

createRollout(request, callback)

public createRollout(request: google.cloud.deploy.v1.ICreateRolloutRequest, callback: google.cloud.deploy.v1.CloudDeploy.CreateRolloutCallback): void;

Calls CreateRollout.

Parameters

Name	Description
request	`google.cloud.deploy.v1.ICreateRolloutRequest` CreateRolloutRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.CreateRolloutCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

createRollout(request)

public createRollout(request: google.cloud.deploy.v1.ICreateRolloutRequest): Promise<google.longrunning.Operation>;

Calls CreateRollout.

Parameter

Name	Description
request	`google.cloud.deploy.v1.ICreateRolloutRequest` CreateRolloutRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

createTarget(request, callback)

public createTarget(request: google.cloud.deploy.v1.ICreateTargetRequest, callback: google.cloud.deploy.v1.CloudDeploy.CreateTargetCallback): void;

Calls CreateTarget.

Parameters

Name	Description
request	`ICreateTargetRequest` CreateTargetRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.CreateTargetCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

createTarget(request)

public createTarget(request: google.cloud.deploy.v1.ICreateTargetRequest): Promise<google.longrunning.Operation>;

Calls CreateTarget.

Parameter

Name	Description
request	`ICreateTargetRequest` CreateTargetRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

deleteDeliveryPipeline(request, callback)

public deleteDeliveryPipeline(request: google.cloud.deploy.v1.IDeleteDeliveryPipelineRequest, callback: google.cloud.deploy.v1.CloudDeploy.DeleteDeliveryPipelineCallback): void;

Calls DeleteDeliveryPipeline.

Parameters

Name	Description
request	`IDeleteDeliveryPipelineRequest` DeleteDeliveryPipelineRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.DeleteDeliveryPipelineCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

deleteDeliveryPipeline(request)

public deleteDeliveryPipeline(request: google.cloud.deploy.v1.IDeleteDeliveryPipelineRequest): Promise<google.longrunning.Operation>;

Calls DeleteDeliveryPipeline.

Parameter

Name	Description
request	`IDeleteDeliveryPipelineRequest` DeleteDeliveryPipelineRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

deleteTarget(request, callback)

public deleteTarget(request: google.cloud.deploy.v1.IDeleteTargetRequest, callback: google.cloud.deploy.v1.CloudDeploy.DeleteTargetCallback): void;

Calls DeleteTarget.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IDeleteTargetRequest` DeleteTargetRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.DeleteTargetCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

deleteTarget(request)

public deleteTarget(request: google.cloud.deploy.v1.IDeleteTargetRequest): Promise<google.longrunning.Operation>;

Calls DeleteTarget.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IDeleteTargetRequest` DeleteTargetRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

getConfig(request, callback)

public getConfig(request: google.cloud.deploy.v1.IGetConfigRequest, callback: google.cloud.deploy.v1.CloudDeploy.GetConfigCallback): void;

Calls GetConfig.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IGetConfigRequest` GetConfigRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.GetConfigCallback` Node-style callback called with the error, if any, and Config

Returns

Type	Description
void

getConfig(request)

public getConfig(request: google.cloud.deploy.v1.IGetConfigRequest): Promise<google.cloud.deploy.v1.Config>;

Calls GetConfig.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IGetConfigRequest` GetConfigRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.Config>	Promise

getDeliveryPipeline(request, callback)

public getDeliveryPipeline(request: google.cloud.deploy.v1.IGetDeliveryPipelineRequest, callback: google.cloud.deploy.v1.CloudDeploy.GetDeliveryPipelineCallback): void;

Calls GetDeliveryPipeline.

Parameters

Name	Description
request	`IGetDeliveryPipelineRequest` GetDeliveryPipelineRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.GetDeliveryPipelineCallback` Node-style callback called with the error, if any, and DeliveryPipeline

Returns

Type	Description
void

getDeliveryPipeline(request)

public getDeliveryPipeline(request: google.cloud.deploy.v1.IGetDeliveryPipelineRequest): Promise<google.cloud.deploy.v1.DeliveryPipeline>;

Calls GetDeliveryPipeline.

Parameter

Name	Description
request	`IGetDeliveryPipelineRequest` GetDeliveryPipelineRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.DeliveryPipeline>	Promise

getRelease(request, callback)

public getRelease(request: google.cloud.deploy.v1.IGetReleaseRequest, callback: google.cloud.deploy.v1.CloudDeploy.GetReleaseCallback): void;

Calls GetRelease.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IGetReleaseRequest` GetReleaseRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.GetReleaseCallback` Node-style callback called with the error, if any, and Release

Returns

Type	Description
void

getRelease(request)

public getRelease(request: google.cloud.deploy.v1.IGetReleaseRequest): Promise<google.cloud.deploy.v1.Release>;

Calls GetRelease.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IGetReleaseRequest` GetReleaseRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.Release>	Promise

getRollout(request, callback)

public getRollout(request: google.cloud.deploy.v1.IGetRolloutRequest, callback: google.cloud.deploy.v1.CloudDeploy.GetRolloutCallback): void;

Calls GetRollout.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IGetRolloutRequest` GetRolloutRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.GetRolloutCallback` Node-style callback called with the error, if any, and Rollout

Returns

Type	Description
void

getRollout(request)

public getRollout(request: google.cloud.deploy.v1.IGetRolloutRequest): Promise<google.cloud.deploy.v1.Rollout>;

Calls GetRollout.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IGetRolloutRequest` GetRolloutRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.Rollout>	Promise

getTarget(request, callback)

public getTarget(request: google.cloud.deploy.v1.IGetTargetRequest, callback: google.cloud.deploy.v1.CloudDeploy.GetTargetCallback): void;

Calls GetTarget.

Parameters

Name	Description
request	`IGetTargetRequest` GetTargetRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.GetTargetCallback` Node-style callback called with the error, if any, and Target

Returns

Type	Description
void

getTarget(request)

public getTarget(request: google.cloud.deploy.v1.IGetTargetRequest): Promise<google.cloud.deploy.v1.Target>;

Calls GetTarget.

Parameter

Name	Description
request	`IGetTargetRequest` GetTargetRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.Target>	Promise

listDeliveryPipelines(request, callback)

public listDeliveryPipelines(request: google.cloud.deploy.v1.IListDeliveryPipelinesRequest, callback: google.cloud.deploy.v1.CloudDeploy.ListDeliveryPipelinesCallback): void;

Calls ListDeliveryPipelines.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IListDeliveryPipelinesRequest` ListDeliveryPipelinesRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.ListDeliveryPipelinesCallback` Node-style callback called with the error, if any, and ListDeliveryPipelinesResponse

Returns

Type	Description
void

listDeliveryPipelines(request)

public listDeliveryPipelines(request: google.cloud.deploy.v1.IListDeliveryPipelinesRequest): Promise<google.cloud.deploy.v1.ListDeliveryPipelinesResponse>;

Calls ListDeliveryPipelines.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IListDeliveryPipelinesRequest` ListDeliveryPipelinesRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.ListDeliveryPipelinesResponse>	Promise

listReleases(request, callback)

public listReleases(request: google.cloud.deploy.v1.IListReleasesRequest, callback: google.cloud.deploy.v1.CloudDeploy.ListReleasesCallback): void;

Calls ListReleases.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IListReleasesRequest` ListReleasesRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.ListReleasesCallback` Node-style callback called with the error, if any, and ListReleasesResponse

Returns

Type	Description
void

listReleases(request)

public listReleases(request: google.cloud.deploy.v1.IListReleasesRequest): Promise<google.cloud.deploy.v1.ListReleasesResponse>;

Calls ListReleases.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IListReleasesRequest` ListReleasesRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.ListReleasesResponse>	Promise

listRollouts(request, callback)

public listRollouts(request: google.cloud.deploy.v1.IListRolloutsRequest, callback: google.cloud.deploy.v1.CloudDeploy.ListRolloutsCallback): void;

Calls ListRollouts.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IListRolloutsRequest` ListRolloutsRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.ListRolloutsCallback` Node-style callback called with the error, if any, and ListRolloutsResponse

Returns

Type	Description
void

listRollouts(request)

public listRollouts(request: google.cloud.deploy.v1.IListRolloutsRequest): Promise<google.cloud.deploy.v1.ListRolloutsResponse>;

Calls ListRollouts.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IListRolloutsRequest` ListRolloutsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.ListRolloutsResponse>	Promise

listTargets(request, callback)

public listTargets(request: google.cloud.deploy.v1.IListTargetsRequest, callback: google.cloud.deploy.v1.CloudDeploy.ListTargetsCallback): void;

Calls ListTargets.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IListTargetsRequest` ListTargetsRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.ListTargetsCallback` Node-style callback called with the error, if any, and ListTargetsResponse

Returns

Type	Description
void

listTargets(request)

public listTargets(request: google.cloud.deploy.v1.IListTargetsRequest): Promise<google.cloud.deploy.v1.ListTargetsResponse>;

Calls ListTargets.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IListTargetsRequest` ListTargetsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.deploy.v1.ListTargetsResponse>	Promise

updateDeliveryPipeline(request, callback)

public updateDeliveryPipeline(request: google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest, callback: google.cloud.deploy.v1.CloudDeploy.UpdateDeliveryPipelineCallback): void;

Calls UpdateDeliveryPipeline.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest` UpdateDeliveryPipelineRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.UpdateDeliveryPipelineCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

updateDeliveryPipeline(request)

public updateDeliveryPipeline(request: google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest): Promise<google.longrunning.Operation>;

Calls UpdateDeliveryPipeline.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest` UpdateDeliveryPipelineRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

updateTarget(request, callback)

public updateTarget(request: google.cloud.deploy.v1.IUpdateTargetRequest, callback: google.cloud.deploy.v1.CloudDeploy.UpdateTargetCallback): void;

Calls UpdateTarget.

Parameters

Name	Description
request	`google.cloud.deploy.v1.IUpdateTargetRequest` UpdateTargetRequest message or plain object
callback	`google.cloud.deploy.v1.CloudDeploy.UpdateTargetCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

updateTarget(request)

public updateTarget(request: google.cloud.deploy.v1.IUpdateTargetRequest): Promise<google.longrunning.Operation>;

Calls UpdateTarget.

Parameter

Name	Description
request	`google.cloud.deploy.v1.IUpdateTargetRequest` UpdateTargetRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise