Class v1.CloudDeployClient (3.5.0)

Package

@google-cloud/deploy

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);

Construct an instance of CloudDeployClient.

Parameters
NameDescription
optsClientOptions
gaxInstancetypeofgax | typeoffallback

: loaded instance ofgoogle-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new CloudDeployClient({fallback: true}, gax); ```

Properties

apiEndpoint

getapiEndpoint():string;

The DNS address for this API service.

apiEndpoint

staticgetapiEndpoint():string;

The DNS address for this API service - same as servicePath.

auth

auth:gax.GoogleAuth;

cloudDeployStub

cloudDeployStub?:Promise<{[name:string]:Function;}>;

descriptors

descriptors:Descriptors;

iamClient

iamClient:IamClient;

innerApiCalls

innerApiCalls:{[name:string]:Function;};

locationsClient

locationsClient:LocationsClient;

operationsClient

operationsClient:gax.OperationsClient;

pathTemplates

pathTemplates:{[name:string]:gax.PathTemplate;};

port

staticgetport():number;

The port for this API service.

scopes

staticgetscopes():string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

staticgetservicePath():string;

The DNS address for this API service.

universeDomain

getuniverseDomain():string;

warn

warn:(code:string,message:string,warnType?:string)=>void;

Methods

abandonRelease(request, options)

abandonRelease(request?:protos.google.cloud.deploy.v1.IAbandonReleaseRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IAbandonReleaseResponse,protos.google.cloud.deploy.v1.IAbandonReleaseRequest|undefined,{}|undefined]>;

Abandons a Release in the Delivery Pipeline.

Parameters
NameDescription
requestIAbandonReleaseRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IAbandonReleaseResponse,protos.google.cloud.deploy.v1.IAbandonReleaseRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingAbandonReleaseResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the Release. Format is   *  `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallAbandonRelease(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.abandonRelease(request);console.log(response);}callAbandonRelease();

abandonRelease(request, options, callback)

abandonRelease(request:protos.google.cloud.deploy.v1.IAbandonReleaseRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IAbandonReleaseResponse,protos.google.cloud.deploy.v1.IAbandonReleaseRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIAbandonReleaseRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IAbandonReleaseResponse,protos.google.cloud.deploy.v1.IAbandonReleaseRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

abandonRelease(request, callback)

abandonRelease(request:protos.google.cloud.deploy.v1.IAbandonReleaseRequest,callback:Callback<protos.google.cloud.deploy.v1.IAbandonReleaseResponse,protos.google.cloud.deploy.v1.IAbandonReleaseRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIAbandonReleaseRequest
callbackCallback<protos.google.cloud.deploy.v1.IAbandonReleaseResponse,protos.google.cloud.deploy.v1.IAbandonReleaseRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

advanceRollout(request, options)

advanceRollout(request?:protos.google.cloud.deploy.v1.IAdvanceRolloutRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IAdvanceRolloutResponse,protos.google.cloud.deploy.v1.IAdvanceRolloutRequest|undefined,{}|undefined]>;

Advances a Rollout in a given project and location.

Parameters
NameDescription
requestIAdvanceRolloutRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IAdvanceRolloutResponse,protos.google.cloud.deploy.v1.IAdvanceRolloutRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingAdvanceRolloutResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the Rollout. Format is   *  `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.   */// const name = 'abc123'/**   *  Required. The phase ID to advance the `Rollout` to.   */// const phaseId = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallAdvanceRollout(){// Construct requestconstrequest={name,phaseId,};// Run requestconstresponse=awaitdeployClient.advanceRollout(request);console.log(response);}callAdvanceRollout();

advanceRollout(request, options, callback)

advanceRollout(request:protos.google.cloud.deploy.v1.IAdvanceRolloutRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IAdvanceRolloutResponse,protos.google.cloud.deploy.v1.IAdvanceRolloutRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIAdvanceRolloutRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IAdvanceRolloutResponse,protos.google.cloud.deploy.v1.IAdvanceRolloutRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

advanceRollout(request, callback)

advanceRollout(request:protos.google.cloud.deploy.v1.IAdvanceRolloutRequest,callback:Callback<protos.google.cloud.deploy.v1.IAdvanceRolloutResponse,protos.google.cloud.deploy.v1.IAdvanceRolloutRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIAdvanceRolloutRequest
callbackCallback<protos.google.cloud.deploy.v1.IAdvanceRolloutResponse,protos.google.cloud.deploy.v1.IAdvanceRolloutRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

approveRollout(request, options)

approveRollout(request?:protos.google.cloud.deploy.v1.IApproveRolloutRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IApproveRolloutResponse,protos.google.cloud.deploy.v1.IApproveRolloutRequest|undefined,{}|undefined]>;

Approves a Rollout.

Parameters
NameDescription
requestIApproveRolloutRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IApproveRolloutResponse,protos.google.cloud.deploy.v1.IApproveRolloutRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingApproveRolloutResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the Rollout. Format is   *  `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.   */// const name = 'abc123'/**   *  Required. True = approve; false = reject   */// const approved = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallApproveRollout(){// Construct requestconstrequest={name,approved,};// Run requestconstresponse=awaitdeployClient.approveRollout(request);console.log(response);}callApproveRollout();

approveRollout(request, options, callback)

approveRollout(request:protos.google.cloud.deploy.v1.IApproveRolloutRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IApproveRolloutResponse,protos.google.cloud.deploy.v1.IApproveRolloutRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIApproveRolloutRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IApproveRolloutResponse,protos.google.cloud.deploy.v1.IApproveRolloutRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

approveRollout(request, callback)

approveRollout(request:protos.google.cloud.deploy.v1.IApproveRolloutRequest,callback:Callback<protos.google.cloud.deploy.v1.IApproveRolloutResponse,protos.google.cloud.deploy.v1.IApproveRolloutRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIApproveRolloutRequest
callbackCallback<protos.google.cloud.deploy.v1.IApproveRolloutResponse,protos.google.cloud.deploy.v1.IApproveRolloutRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

automationPath(project, location, deliveryPipeline, automation)

automationPath(project:string,location:string,deliveryPipeline:string,automation:string):string;

Return a fully-qualified automation resource name string.

Parameters
NameDescription
projectstring
locationstring
deliveryPipelinestring
automationstring
Returns
TypeDescription
string

{string} Resource name string.

automationRunPath(project, location, deliveryPipeline, automationRun)

automationRunPath(project:string,location:string,deliveryPipeline:string,automationRun:string):string;

Return a fully-qualified automationRun resource name string.

Parameters
NameDescription
projectstring
locationstring
deliveryPipelinestring
automationRunstring
Returns
TypeDescription
string

{string} Resource name string.

buildPath(project, location, build)

buildPath(project:string,location:string,build:string):string;

Return a fully-qualified build resource name string.

Parameters
NameDescription
projectstring
locationstring
buildstring
Returns
TypeDescription
string

{string} Resource name string.

cancelAutomationRun(request, options)

cancelAutomationRun(request?:protos.google.cloud.deploy.v1.ICancelAutomationRunRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.ICancelAutomationRunResponse,protos.google.cloud.deploy.v1.ICancelAutomationRunRequest|undefined,{}|undefined]>;

Cancels an AutomationRun. Thestate of theAutomationRun after cancelling isCANCELLED.CancelAutomationRun can be called on AutomationRun in the stateIN_PROGRESS andPENDING; AutomationRun in a different state returns anFAILED_PRECONDITION error.

Parameters
NameDescription
requestICancelAutomationRunRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.ICancelAutomationRunResponse,protos.google.cloud.deploy.v1.ICancelAutomationRunRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingCancelAutomationRunResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `AutomationRun`. Format is   *  `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCancelAutomationRun(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.cancelAutomationRun(request);console.log(response);}callCancelAutomationRun();

cancelAutomationRun(request, options, callback)

cancelAutomationRun(request:protos.google.cloud.deploy.v1.ICancelAutomationRunRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.ICancelAutomationRunResponse,protos.google.cloud.deploy.v1.ICancelAutomationRunRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICancelAutomationRunRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.ICancelAutomationRunResponse,protos.google.cloud.deploy.v1.ICancelAutomationRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

cancelAutomationRun(request, callback)

cancelAutomationRun(request:protos.google.cloud.deploy.v1.ICancelAutomationRunRequest,callback:Callback<protos.google.cloud.deploy.v1.ICancelAutomationRunResponse,protos.google.cloud.deploy.v1.ICancelAutomationRunRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICancelAutomationRunRequest
callbackCallback<protos.google.cloud.deploy.v1.ICancelAutomationRunResponse,protos.google.cloud.deploy.v1.ICancelAutomationRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

cancelOperation(request, options, callback)

cancelOperation(request:protos.google.longrunning.CancelOperationRequest,options?:gax.CallOptions|Callback<protos.google.protobuf.Empty,protos.google.longrunning.CancelOperationRequest,{}|undefined|null>,callback?:Callback<protos.google.longrunning.CancelOperationRequest,protos.google.protobuf.Empty,{}|undefined|null>):Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returnsgoogle.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding toCode.CANCELLED.

Parameters
NameDescription
requestCancelOperationRequest

The request object that will be sent.

optionsCallOptions |Callback<protos.google.protobuf.Empty,protos.google.longrunning.CancelOperationRequest, {} | undefined | null>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details.

callbackCallback<protos.google.longrunning.CancelOperationRequest,protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example
constclient=longrunning.operationsClient();awaitclient.cancelOperation({name:''});

cancelRollout(request, options)

cancelRollout(request?:protos.google.cloud.deploy.v1.ICancelRolloutRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.ICancelRolloutResponse,protos.google.cloud.deploy.v1.ICancelRolloutRequest|undefined,{}|undefined]>;

Cancels a Rollout in a given project and location.

Parameters
NameDescription
requestICancelRolloutRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.ICancelRolloutResponse,protos.google.cloud.deploy.v1.ICancelRolloutRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingCancelRolloutResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the Rollout. Format is   *  `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCancelRollout(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.cancelRollout(request);console.log(response);}callCancelRollout();

cancelRollout(request, options, callback)

cancelRollout(request:protos.google.cloud.deploy.v1.ICancelRolloutRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.ICancelRolloutResponse,protos.google.cloud.deploy.v1.ICancelRolloutRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICancelRolloutRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.ICancelRolloutResponse,protos.google.cloud.deploy.v1.ICancelRolloutRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

cancelRollout(request, callback)

cancelRollout(request:protos.google.cloud.deploy.v1.ICancelRolloutRequest,callback:Callback<protos.google.cloud.deploy.v1.ICancelRolloutResponse,protos.google.cloud.deploy.v1.ICancelRolloutRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICancelRolloutRequest
callbackCallback<protos.google.cloud.deploy.v1.ICancelRolloutResponse,protos.google.cloud.deploy.v1.ICancelRolloutRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

checkCreateAutomationProgress(name)

checkCreateAutomationProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.Automation,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bycreateAutomation().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.Automation,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `Automation` should be   *  created. Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `Automation`.   */// const automationId = 'abc123'/**   *  Required. The `Automation` to create.   */// const automation = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateAutomation(){// Construct requestconstrequest={parent,automationId,automation,};// Run requestconst[operation]=awaitdeployClient.createAutomation(request);const[response]=awaitoperation.promise();console.log(response);}callCreateAutomation();

checkCreateCustomTargetTypeProgress(name)

checkCreateCustomTargetTypeProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.CustomTargetType,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bycreateCustomTargetType().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.CustomTargetType,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `CustomTargetType` should be   *  created. Format should be   *  `projects/{project_id}/locations/{location_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `CustomTargetType`.   */// const customTargetTypeId = 'abc123'/**   *  Required. The `CustomTargetType` to create.   */// const customTargetType = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateCustomTargetType(){// Construct requestconstrequest={parent,customTargetTypeId,customTargetType,};// Run requestconst[operation]=awaitdeployClient.createCustomTargetType(request);const[response]=awaitoperation.promise();console.log(response);}callCreateCustomTargetType();

checkCreateDeliveryPipelineProgress(name)

checkCreateDeliveryPipelineProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.DeliveryPipeline,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bycreateDeliveryPipeline().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.DeliveryPipeline,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `DeliveryPipeline` should be   *  created. Format should be   *  `projects/{project_id}/locations/{location_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `DeliveryPipeline`.   */// const deliveryPipelineId = 'abc123'/**   *  Required. The `DeliveryPipeline` to create.   */// const deliveryPipeline = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateDeliveryPipeline(){// Construct requestconstrequest={parent,deliveryPipelineId,deliveryPipeline,};// Run requestconst[operation]=awaitdeployClient.createDeliveryPipeline(request);const[response]=awaitoperation.promise();console.log(response);}callCreateDeliveryPipeline();

checkCreateReleaseProgress(name)

checkCreateReleaseProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.Release,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bycreateRelease().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.Release,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `Release` should be created.   *  Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `Release`.   */// const releaseId = 'abc123'/**   *  Required. The `Release` to create.   */// const release = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateRelease(){// Construct requestconstrequest={parent,releaseId,release,};// Run requestconst[operation]=awaitdeployClient.createRelease(request);const[response]=awaitoperation.promise();console.log(response);}callCreateRelease();

checkCreateRolloutProgress(name)

checkCreateRolloutProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.Rollout,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bycreateRollout().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.Rollout,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `Rollout` should be created.   *  Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `Rollout`.   */// const rolloutId = 'abc123'/**   *  Required. The `Rollout` to create.   */// const rollout = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true/**   *  Optional. The starting phase ID for the `Rollout`. If empty the `Rollout`   *  will start at the first phase.   */// const startingPhaseId = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateRollout(){// Construct requestconstrequest={parent,rolloutId,rollout,};// Run requestconst[operation]=awaitdeployClient.createRollout(request);const[response]=awaitoperation.promise();console.log(response);}callCreateRollout();

checkCreateTargetProgress(name)

checkCreateTargetProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.Target,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bycreateTarget().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.Target,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `Target` should be created.   *  Format should be   *  `projects/{project_id}/locations/{location_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `Target`.   */// const targetId = 'abc123'/**   *  Required. The `Target` to create.   */// const target = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateTarget(){// Construct requestconstrequest={parent,targetId,target,};// Run requestconst[operation]=awaitdeployClient.createTarget(request);const[response]=awaitoperation.promise();console.log(response);}callCreateTarget();

checkDeleteAutomationProgress(name)

checkDeleteAutomationProgress(name:string):Promise<LROperation<protos.google.protobuf.Empty,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bydeleteAutomation().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the `Automation` to delete. Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.   */// const name = 'abc123'/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, then deleting an already deleted or non-existing   *  `Automation` will succeed.   */// const allowMissing = true/**   *  Optional. If set, validate the request and verify whether the resource   *  exists, but do not actually post it.   */// const validateOnly = true/**   *  Optional. The weak etag of the request.   *  This checksum is computed by the server based on the value of other   *  fields, and may be sent on update and delete requests to ensure the   *  client has an up-to-date value before proceeding.   */// const etag = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallDeleteAutomation(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaitdeployClient.deleteAutomation(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteAutomation();

checkDeleteCustomTargetTypeProgress(name)

checkDeleteCustomTargetTypeProgress(name:string):Promise<LROperation<protos.google.protobuf.Empty,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bydeleteCustomTargetType().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the `CustomTargetType` to delete. Format must be   *  `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.   */// const name = 'abc123'/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, then deleting an already deleted or non-existing   *  `CustomTargetType` will succeed.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated but no actual change is   *  made.   */// const validateOnly = true/**   *  Optional. This checksum is computed by the server based on the value of   *  other fields, and may be sent on update and delete requests to ensure the   *  client has an up-to-date value before proceeding.   */// const etag = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallDeleteCustomTargetType(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaitdeployClient.deleteCustomTargetType(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteCustomTargetType();

checkDeleteDeliveryPipelineProgress(name)

checkDeleteDeliveryPipelineProgress(name:string):Promise<LROperation<protos.google.protobuf.Empty,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bydeleteDeliveryPipeline().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the `DeliveryPipeline` to delete. Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.   */// const name = 'abc123'/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, then deleting an already deleted or non-existing   *  `DeliveryPipeline` will succeed.   */// const allowMissing = true/**   *  Optional. If set, validate the request and preview the review, but do not   *  actually post it.   */// const validateOnly = true/**   *  Optional. If set to true, all child resources under this pipeline will also   *  be deleted. Otherwise, the request will only work if the pipeline has no   *  child resources.   */// const force = true/**   *  Optional. This checksum is computed by the server based on the value of   *  other fields, and may be sent on update and delete requests to ensure the   *  client has an up-to-date value before proceeding.   */// const etag = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallDeleteDeliveryPipeline(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaitdeployClient.deleteDeliveryPipeline(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteDeliveryPipeline();

checkDeleteTargetProgress(name)

checkDeleteTargetProgress(name:string):Promise<LROperation<protos.google.protobuf.Empty,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned bydeleteTarget().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the `Target` to delete. Format should be   *  `projects/{project_id}/locations/{location_name}/targets/{target_name}`.   */// const name = 'abc123'/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, then deleting an already deleted or non-existing   *  `Target` will succeed.   */// const allowMissing = true/**   *  Optional. If set, validate the request and preview the review, but do not   *  actually post it.   */// const validateOnly = true/**   *  Optional. This checksum is computed by the server based on the value of   *  other fields, and may be sent on update and delete requests to ensure the   *  client has an up-to-date value before proceeding.   */// const etag = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallDeleteTarget(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaitdeployClient.deleteTarget(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteTarget();

checkUpdateAutomationProgress(name)

checkUpdateAutomationProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.Automation,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned byupdateAutomation().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.Automation,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Field mask is used to specify the fields to be overwritten in the   *  `Automation` resource by the update.   *  The fields specified in the update_mask are relative to the resource, not   *  the full request. A field will be overwritten if it's in the mask. If the   *  user doesn't provide a mask then all fields are overwritten.   */// const updateMask = {}/**   *  Required. The `Automation` to update.   */// const automation = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, updating a `Automation` that does not exist will   *  result in the creation of a new `Automation`.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallUpdateAutomation(){// Construct requestconstrequest={updateMask,automation,};// Run requestconst[operation]=awaitdeployClient.updateAutomation(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateAutomation();

checkUpdateCustomTargetTypeProgress(name)

checkUpdateCustomTargetTypeProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.CustomTargetType,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned byupdateCustomTargetType().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.CustomTargetType,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Field mask is used to specify the fields to be overwritten in the   *  `CustomTargetType` resource by the update.   *  The fields specified in the update_mask are relative to the resource, not   *  the full request. A field will be overwritten if it's in the mask. If the   *  user doesn't provide a mask then all fields are overwritten.   */// const updateMask = {}/**   *  Required. The `CustomTargetType` to update.   */// const customTargetType = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, updating a `CustomTargetType` that does not exist   *  will result in the creation of a new `CustomTargetType`.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallUpdateCustomTargetType(){// Construct requestconstrequest={updateMask,customTargetType,};// Run requestconst[operation]=awaitdeployClient.updateCustomTargetType(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateCustomTargetType();

checkUpdateDeliveryPipelineProgress(name)

checkUpdateDeliveryPipelineProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.DeliveryPipeline,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned byupdateDeliveryPipeline().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.DeliveryPipeline,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Field mask is used to specify the fields to be overwritten in the   *  `DeliveryPipeline` resource by the update.   *  The fields specified in the update_mask are relative to the resource, not   *  the full request. A field will be overwritten if it's in the mask. If the   *  user doesn't provide a mask then all fields are overwritten.   */// const updateMask = {}/**   *  Required. The `DeliveryPipeline` to update.   */// const deliveryPipeline = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, updating a `DeliveryPipeline` that does not exist   *  will result in the creation of a new `DeliveryPipeline`.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallUpdateDeliveryPipeline(){// Construct requestconstrequest={updateMask,deliveryPipeline,};// Run requestconst[operation]=awaitdeployClient.updateDeliveryPipeline(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateDeliveryPipeline();

checkUpdateTargetProgress(name)

checkUpdateTargetProgress(name:string):Promise<LROperation<protos.google.cloud.deploy.v1.Target,protos.google.cloud.deploy.v1.OperationMetadata>>;

Check the status of the long running operation returned byupdateTarget().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.deploy.v1.Target,protos.google.cloud.deploy.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Field mask is used to specify the fields to be overwritten in the   *  Target resource by the update.   *  The fields specified in the update_mask are relative to the resource, not   *  the full request. A field will be overwritten if it's in the mask. If the   *  user doesn't provide a mask then all fields are overwritten.   */// const updateMask = {}/**   *  Required. The `Target` to update.   */// const target = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, updating a `Target` that does not exist will   *  result in the creation of a new `Target`.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallUpdateTarget(){// Construct requestconstrequest={updateMask,target,};// Run requestconst[operation]=awaitdeployClient.updateTarget(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateTarget();

close()

close():Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

clusterPath(project, location, cluster)

clusterPath(project:string,location:string,cluster:string):string;

Return a fully-qualified cluster resource name string.

Parameters
NameDescription
projectstring
locationstring
clusterstring
Returns
TypeDescription
string

{string} Resource name string.

configPath(project, location)

configPath(project:string,location:string):string;

Return a fully-qualified config resource name string.

Parameters
NameDescription
projectstring
locationstring
Returns
TypeDescription
string

{string} Resource name string.

createAutomation(request, options)

createAutomation(request?:protos.google.cloud.deploy.v1.ICreateAutomationRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Creates a new Automation in a given project and location.

Parameters
NameDescription
requestICreateAutomationRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `Automation` should be   *  created. Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `Automation`.   */// const automationId = 'abc123'/**   *  Required. The `Automation` to create.   */// const automation = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateAutomation(){// Construct requestconstrequest={parent,automationId,automation,};// Run requestconst[operation]=awaitdeployClient.createAutomation(request);const[response]=awaitoperation.promise();console.log(response);}callCreateAutomation();

createAutomation(request, options, callback)

createAutomation(request:protos.google.cloud.deploy.v1.ICreateAutomationRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateAutomationRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createAutomation(request, callback)

createAutomation(request:protos.google.cloud.deploy.v1.ICreateAutomationRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateAutomationRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCustomTargetType(request, options)

createCustomTargetType(request?:protos.google.cloud.deploy.v1.ICreateCustomTargetTypeRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Creates a new CustomTargetType in a given project and location.

Parameters
NameDescription
requestICreateCustomTargetTypeRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `CustomTargetType` should be   *  created. Format should be   *  `projects/{project_id}/locations/{location_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `CustomTargetType`.   */// const customTargetTypeId = 'abc123'/**   *  Required. The `CustomTargetType` to create.   */// const customTargetType = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateCustomTargetType(){// Construct requestconstrequest={parent,customTargetTypeId,customTargetType,};// Run requestconst[operation]=awaitdeployClient.createCustomTargetType(request);const[response]=awaitoperation.promise();console.log(response);}callCreateCustomTargetType();

createCustomTargetType(request, options, callback)

createCustomTargetType(request:protos.google.cloud.deploy.v1.ICreateCustomTargetTypeRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateCustomTargetTypeRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCustomTargetType(request, callback)

createCustomTargetType(request:protos.google.cloud.deploy.v1.ICreateCustomTargetTypeRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateCustomTargetTypeRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createDeliveryPipeline(request, options)

createDeliveryPipeline(request?:protos.google.cloud.deploy.v1.ICreateDeliveryPipelineRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Creates a new DeliveryPipeline in a given project and location.

Parameters
NameDescription
requestICreateDeliveryPipelineRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `DeliveryPipeline` should be   *  created. Format should be   *  `projects/{project_id}/locations/{location_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `DeliveryPipeline`.   */// const deliveryPipelineId = 'abc123'/**   *  Required. The `DeliveryPipeline` to create.   */// const deliveryPipeline = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateDeliveryPipeline(){// Construct requestconstrequest={parent,deliveryPipelineId,deliveryPipeline,};// Run requestconst[operation]=awaitdeployClient.createDeliveryPipeline(request);const[response]=awaitoperation.promise();console.log(response);}callCreateDeliveryPipeline();

createDeliveryPipeline(request, options, callback)

createDeliveryPipeline(request:protos.google.cloud.deploy.v1.ICreateDeliveryPipelineRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateDeliveryPipelineRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createDeliveryPipeline(request, callback)

createDeliveryPipeline(request:protos.google.cloud.deploy.v1.ICreateDeliveryPipelineRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateDeliveryPipelineRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createRelease(request, options)

createRelease(request?:protos.google.cloud.deploy.v1.ICreateReleaseRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Creates a new Release in a given project and location.

Parameters
NameDescription
requestICreateReleaseRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `Release` should be created.   *  Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `Release`.   */// const releaseId = 'abc123'/**   *  Required. The `Release` to create.   */// const release = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateRelease(){// Construct requestconstrequest={parent,releaseId,release,};// Run requestconst[operation]=awaitdeployClient.createRelease(request);const[response]=awaitoperation.promise();console.log(response);}callCreateRelease();

createRelease(request, options, callback)

createRelease(request:protos.google.cloud.deploy.v1.ICreateReleaseRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateReleaseRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createRelease(request, callback)

createRelease(request:protos.google.cloud.deploy.v1.ICreateReleaseRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateReleaseRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createRollout(request, options)

createRollout(request?:protos.google.cloud.deploy.v1.ICreateRolloutRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Creates a new Rollout in a given project and location.

Parameters
NameDescription
requestICreateRolloutRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `Rollout` should be created.   *  Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `Rollout`.   */// const rolloutId = 'abc123'/**   *  Required. The `Rollout` to create.   */// const rollout = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true/**   *  Optional. The starting phase ID for the `Rollout`. If empty the `Rollout`   *  will start at the first phase.   */// const startingPhaseId = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateRollout(){// Construct requestconstrequest={parent,rolloutId,rollout,};// Run requestconst[operation]=awaitdeployClient.createRollout(request);const[response]=awaitoperation.promise();console.log(response);}callCreateRollout();

createRollout(request, options, callback)

createRollout(request:protos.google.cloud.deploy.v1.ICreateRolloutRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateRolloutRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createRollout(request, callback)

createRollout(request:protos.google.cloud.deploy.v1.ICreateRolloutRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateRolloutRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createTarget(request, options)

createTarget(request?:protos.google.cloud.deploy.v1.ICreateTargetRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Creates a new Target in a given project and location.

Parameters
NameDescription
requestICreateTargetRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which the `Target` should be created.   *  Format should be   *  `projects/{project_id}/locations/{location_name}`.   */// const parent = 'abc123'/**   *  Required. ID of the `Target`.   */// const targetId = 'abc123'/**   *  Required. The `Target` to create.   */// const target = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallCreateTarget(){// Construct requestconstrequest={parent,targetId,target,};// Run requestconst[operation]=awaitdeployClient.createTarget(request);const[response]=awaitoperation.promise();console.log(response);}callCreateTarget();

createTarget(request, options, callback)

createTarget(request:protos.google.cloud.deploy.v1.ICreateTargetRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateTargetRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createTarget(request, callback)

createTarget(request:protos.google.cloud.deploy.v1.ICreateTargetRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICreateTargetRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

customTargetTypePath(project, location, customTargetType)

customTargetTypePath(project:string,location:string,customTargetType:string):string;

Return a fully-qualified customTargetType resource name string.

Parameters
NameDescription
projectstring
locationstring
customTargetTypestring
Returns
TypeDescription
string

{string} Resource name string.

deleteAutomation(request, options)

deleteAutomation(request?:protos.google.cloud.deploy.v1.IDeleteAutomationRequest,options?:CallOptions):Promise<[LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Deletes a single Automation resource.

Parameters
NameDescription
requestIDeleteAutomationRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the `Automation` to delete. Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.   */// const name = 'abc123'/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, then deleting an already deleted or non-existing   *  `Automation` will succeed.   */// const allowMissing = true/**   *  Optional. If set, validate the request and verify whether the resource   *  exists, but do not actually post it.   */// const validateOnly = true/**   *  Optional. The weak etag of the request.   *  This checksum is computed by the server based on the value of other   *  fields, and may be sent on update and delete requests to ensure the   *  client has an up-to-date value before proceeding.   */// const etag = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallDeleteAutomation(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaitdeployClient.deleteAutomation(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteAutomation();

deleteAutomation(request, options, callback)

deleteAutomation(request:protos.google.cloud.deploy.v1.IDeleteAutomationRequest,options:CallOptions,callback:Callback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteAutomationRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteAutomation(request, callback)

deleteAutomation(request:protos.google.cloud.deploy.v1.IDeleteAutomationRequest,callback:Callback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteAutomationRequest
callbackCallback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCustomTargetType(request, options)

deleteCustomTargetType(request?:protos.google.cloud.deploy.v1.IDeleteCustomTargetTypeRequest,options?:CallOptions):Promise<[LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Deletes a single CustomTargetType.

Parameters
NameDescription
requestIDeleteCustomTargetTypeRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the `CustomTargetType` to delete. Format must be   *  `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.   */// const name = 'abc123'/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, then deleting an already deleted or non-existing   *  `CustomTargetType` will succeed.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated but no actual change is   *  made.   */// const validateOnly = true/**   *  Optional. This checksum is computed by the server based on the value of   *  other fields, and may be sent on update and delete requests to ensure the   *  client has an up-to-date value before proceeding.   */// const etag = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallDeleteCustomTargetType(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaitdeployClient.deleteCustomTargetType(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteCustomTargetType();

deleteCustomTargetType(request, options, callback)

deleteCustomTargetType(request:protos.google.cloud.deploy.v1.IDeleteCustomTargetTypeRequest,options:CallOptions,callback:Callback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteCustomTargetTypeRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteCustomTargetType(request, callback)

deleteCustomTargetType(request:protos.google.cloud.deploy.v1.IDeleteCustomTargetTypeRequest,callback:Callback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteCustomTargetTypeRequest
callbackCallback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteDeliveryPipeline(request, options)

deleteDeliveryPipeline(request?:protos.google.cloud.deploy.v1.IDeleteDeliveryPipelineRequest,options?:CallOptions):Promise<[LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Deletes a single DeliveryPipeline.

Parameters
NameDescription
requestIDeleteDeliveryPipelineRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the `DeliveryPipeline` to delete. Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.   */// const name = 'abc123'/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, then deleting an already deleted or non-existing   *  `DeliveryPipeline` will succeed.   */// const allowMissing = true/**   *  Optional. If set, validate the request and preview the review, but do not   *  actually post it.   */// const validateOnly = true/**   *  Optional. If set to true, all child resources under this pipeline will also   *  be deleted. Otherwise, the request will only work if the pipeline has no   *  child resources.   */// const force = true/**   *  Optional. This checksum is computed by the server based on the value of   *  other fields, and may be sent on update and delete requests to ensure the   *  client has an up-to-date value before proceeding.   */// const etag = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallDeleteDeliveryPipeline(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaitdeployClient.deleteDeliveryPipeline(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteDeliveryPipeline();

deleteDeliveryPipeline(request, options, callback)

deleteDeliveryPipeline(request:protos.google.cloud.deploy.v1.IDeleteDeliveryPipelineRequest,options:CallOptions,callback:Callback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteDeliveryPipelineRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteDeliveryPipeline(request, callback)

deleteDeliveryPipeline(request:protos.google.cloud.deploy.v1.IDeleteDeliveryPipelineRequest,callback:Callback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteDeliveryPipelineRequest
callbackCallback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteOperation(request, options, callback)

deleteOperation(request:protos.google.longrunning.DeleteOperationRequest,options?:gax.CallOptions|Callback<protos.google.protobuf.Empty,protos.google.longrunning.DeleteOperationRequest,{}|null|undefined>,callback?:Callback<protos.google.protobuf.Empty,protos.google.longrunning.DeleteOperationRequest,{}|null|undefined>):Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returnsgoogle.rpc.Code.UNIMPLEMENTED.

Parameters
NameDescription
requestDeleteOperationRequest

The request object that will be sent.

optionsCallOptions |Callback<protos.google.protobuf.Empty,protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details.

callbackCallback<protos.google.protobuf.Empty,protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example
constclient=longrunning.operationsClient();awaitclient.deleteOperation({name:''});

deleteTarget(request, options)

deleteTarget(request?:protos.google.cloud.deploy.v1.IDeleteTargetRequest,options?:CallOptions):Promise<[LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Deletes a single Target.

Parameters
NameDescription
requestIDeleteTargetRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the `Target` to delete. Format should be   *  `projects/{project_id}/locations/{location_name}/targets/{target_name}`.   */// const name = 'abc123'/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, then deleting an already deleted or non-existing   *  `Target` will succeed.   */// const allowMissing = true/**   *  Optional. If set, validate the request and preview the review, but do not   *  actually post it.   */// const validateOnly = true/**   *  Optional. This checksum is computed by the server based on the value of   *  other fields, and may be sent on update and delete requests to ensure the   *  client has an up-to-date value before proceeding.   */// const etag = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallDeleteTarget(){// Construct requestconstrequest={name,};// Run requestconst[operation]=awaitdeployClient.deleteTarget(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteTarget();

deleteTarget(request, options, callback)

deleteTarget(request:protos.google.cloud.deploy.v1.IDeleteTargetRequest,options:CallOptions,callback:Callback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteTargetRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteTarget(request, callback)

deleteTarget(request:protos.google.cloud.deploy.v1.IDeleteTargetRequest,callback:Callback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteTargetRequest
callbackCallback<LROperation<protos.google.protobuf.IEmpty,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deliveryPipelinePath(project, location, deliveryPipeline)

deliveryPipelinePath(project:string,location:string,deliveryPipeline:string):string;

Return a fully-qualified deliveryPipeline resource name string.

Parameters
NameDescription
projectstring
locationstring
deliveryPipelinestring
Returns
TypeDescription
string

{string} Resource name string.

getAutomation(request, options)

getAutomation(request?:protos.google.cloud.deploy.v1.IGetAutomationRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IGetAutomationRequest|undefined,{}|undefined]>;

Gets details of a single Automation.

Parameters
NameDescription
requestIGetAutomationRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IGetAutomationRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingAutomation. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `Automation`. Format must be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallGetAutomation(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.getAutomation(request);console.log(response);}callGetAutomation();

getAutomation(request, options, callback)

getAutomation(request:protos.google.cloud.deploy.v1.IGetAutomationRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IGetAutomationRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetAutomationRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IGetAutomationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAutomation(request, callback)

getAutomation(request:protos.google.cloud.deploy.v1.IGetAutomationRequest,callback:Callback<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IGetAutomationRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetAutomationRequest
callbackCallback<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IGetAutomationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAutomationRun(request, options)

getAutomationRun(request?:protos.google.cloud.deploy.v1.IGetAutomationRunRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IAutomationRun,protos.google.cloud.deploy.v1.IGetAutomationRunRequest|undefined,{}|undefined]>;

Gets details of a single AutomationRun.

Parameters
NameDescription
requestIGetAutomationRunRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IAutomationRun,protos.google.cloud.deploy.v1.IGetAutomationRunRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `AutomationRun`. Format must be   *  `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallGetAutomationRun(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.getAutomationRun(request);console.log(response);}callGetAutomationRun();

getAutomationRun(request, options, callback)

getAutomationRun(request:protos.google.cloud.deploy.v1.IGetAutomationRunRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IAutomationRun,protos.google.cloud.deploy.v1.IGetAutomationRunRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetAutomationRunRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IAutomationRun,protos.google.cloud.deploy.v1.IGetAutomationRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAutomationRun(request, callback)

getAutomationRun(request:protos.google.cloud.deploy.v1.IGetAutomationRunRequest,callback:Callback<protos.google.cloud.deploy.v1.IAutomationRun,protos.google.cloud.deploy.v1.IGetAutomationRunRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetAutomationRunRequest
callbackCallback<protos.google.cloud.deploy.v1.IAutomationRun,protos.google.cloud.deploy.v1.IGetAutomationRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getConfig(request, options)

getConfig(request?:protos.google.cloud.deploy.v1.IGetConfigRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IConfig,protos.google.cloud.deploy.v1.IGetConfigRequest|undefined,{}|undefined]>;

Gets the configuration for a location.

Parameters
NameDescription
requestIGetConfigRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IConfig,protos.google.cloud.deploy.v1.IGetConfigRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingConfig. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of requested configuration.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallGetConfig(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.getConfig(request);console.log(response);}callGetConfig();

getConfig(request, options, callback)

getConfig(request:protos.google.cloud.deploy.v1.IGetConfigRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IConfig,protos.google.cloud.deploy.v1.IGetConfigRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetConfigRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IConfig,protos.google.cloud.deploy.v1.IGetConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getConfig(request, callback)

getConfig(request:protos.google.cloud.deploy.v1.IGetConfigRequest,callback:Callback<protos.google.cloud.deploy.v1.IConfig,protos.google.cloud.deploy.v1.IGetConfigRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetConfigRequest
callbackCallback<protos.google.cloud.deploy.v1.IConfig,protos.google.cloud.deploy.v1.IGetConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCustomTargetType(request, options)

getCustomTargetType(request?:protos.google.cloud.deploy.v1.IGetCustomTargetTypeRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IGetCustomTargetTypeRequest|undefined,{}|undefined]>;

Gets details of a single CustomTargetType.

Parameters
NameDescription
requestIGetCustomTargetTypeRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IGetCustomTargetTypeRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingCustomTargetType. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `CustomTargetType`. Format must be   *  `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallGetCustomTargetType(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.getCustomTargetType(request);console.log(response);}callGetCustomTargetType();

getCustomTargetType(request, options, callback)

getCustomTargetType(request:protos.google.cloud.deploy.v1.IGetCustomTargetTypeRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IGetCustomTargetTypeRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetCustomTargetTypeRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IGetCustomTargetTypeRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCustomTargetType(request, callback)

getCustomTargetType(request:protos.google.cloud.deploy.v1.IGetCustomTargetTypeRequest,callback:Callback<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IGetCustomTargetTypeRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetCustomTargetTypeRequest
callbackCallback<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IGetCustomTargetTypeRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDeliveryPipeline(request, options)

getDeliveryPipeline(request?:protos.google.cloud.deploy.v1.IGetDeliveryPipelineRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IGetDeliveryPipelineRequest|undefined,{}|undefined]>;

Gets details of a single DeliveryPipeline.

Parameters
NameDescription
requestIGetDeliveryPipelineRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IGetDeliveryPipelineRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingDeliveryPipeline. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `DeliveryPipeline`. Format must be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallGetDeliveryPipeline(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.getDeliveryPipeline(request);console.log(response);}callGetDeliveryPipeline();

getDeliveryPipeline(request, options, callback)

getDeliveryPipeline(request:protos.google.cloud.deploy.v1.IGetDeliveryPipelineRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IGetDeliveryPipelineRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetDeliveryPipelineRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IGetDeliveryPipelineRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDeliveryPipeline(request, callback)

getDeliveryPipeline(request:protos.google.cloud.deploy.v1.IGetDeliveryPipelineRequest,callback:Callback<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IGetDeliveryPipelineRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetDeliveryPipelineRequest
callbackCallback<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IGetDeliveryPipelineRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, options, callback)

getIamPolicy(request:IamProtos.google.iam.v1.GetIamPolicyRequest,options?:gax.CallOptions|Callback<IamProtos.google.iam.v1.Policy,IamProtos.google.iam.v1.GetIamPolicyRequest|null|undefined,{}|null|undefined>,callback?:Callback<IamProtos.google.iam.v1.Policy,IamProtos.google.iam.v1.GetIamPolicyRequest|null|undefined,{}|null|undefined>):Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
NameDescription
requestIamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.

optionsCallOptions |Callback<google.iam.v1.Policy,google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details.

callbackCallback<google.iam.v1.Policy,google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
TypeDescription
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getJobRun(request, options)

getJobRun(request?:protos.google.cloud.deploy.v1.IGetJobRunRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IJobRun,protos.google.cloud.deploy.v1.IGetJobRunRequest|undefined,{}|undefined]>;

Gets details of a single JobRun.

Parameters
NameDescription
requestIGetJobRunRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IJobRun,protos.google.cloud.deploy.v1.IGetJobRunRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `JobRun`. Format must be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallGetJobRun(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.getJobRun(request);console.log(response);}callGetJobRun();

getJobRun(request, options, callback)

getJobRun(request:protos.google.cloud.deploy.v1.IGetJobRunRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IJobRun,protos.google.cloud.deploy.v1.IGetJobRunRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetJobRunRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IJobRun,protos.google.cloud.deploy.v1.IGetJobRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getJobRun(request, callback)

getJobRun(request:protos.google.cloud.deploy.v1.IGetJobRunRequest,callback:Callback<protos.google.cloud.deploy.v1.IJobRun,protos.google.cloud.deploy.v1.IGetJobRunRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetJobRunRequest
callbackCallback<protos.google.cloud.deploy.v1.IJobRun,protos.google.cloud.deploy.v1.IGetJobRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getLocation(request, options, callback)

getLocation(request:LocationProtos.google.cloud.location.IGetLocationRequest,options?:gax.CallOptions|Callback<LocationProtos.google.cloud.location.ILocation,LocationProtos.google.cloud.location.IGetLocationRequest|null|undefined,{}|null|undefined>,callback?:Callback<LocationProtos.google.cloud.location.ILocation,LocationProtos.google.cloud.location.IGetLocationRequest|null|undefined,{}|null|undefined>):Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
NameDescription
requestLocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

optionsCallOptions |Callback<google.cloud.location.ILocation,google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. SeeCallOptions for more details.

callbackCallback<google.cloud.location.ILocation,google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples.

Example
const[response]=awaitclient.getLocation(request);

getOperation(request, options, callback)

getOperation(request:protos.google.longrunning.GetOperationRequest,options?:gax.CallOptions|Callback<protos.google.longrunning.Operation,protos.google.longrunning.GetOperationRequest,{}|null|undefined>,callback?:Callback<protos.google.longrunning.Operation,protos.google.longrunning.GetOperationRequest,{}|null|undefined>):Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
NameDescription
requestGetOperationRequest

The request object that will be sent.

optionsCallOptions |Callback<protos.google.longrunning.Operation,protos.google.longrunning.GetOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details.

callbackCallback<protos.google.longrunning.Operation,protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example
constclient=longrunning.operationsClient();constname='';const[response]=awaitclient.getOperation({name});// doThingsWith(response)

getProjectId()

getProjectId():Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback:Callback<string,undefined,undefined>):void;
Parameter
NameDescription
callbackCallback<string, undefined, undefined>
Returns
TypeDescription
void

getRelease(request, options)

getRelease(request?:protos.google.cloud.deploy.v1.IGetReleaseRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IGetReleaseRequest|undefined,{}|undefined]>;

Gets details of a single Release.

Parameters
NameDescription
requestIGetReleaseRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IGetReleaseRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `Release`. Format must be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallGetRelease(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.getRelease(request);console.log(response);}callGetRelease();

getRelease(request, options, callback)

getRelease(request:protos.google.cloud.deploy.v1.IGetReleaseRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IGetReleaseRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetReleaseRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IGetReleaseRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getRelease(request, callback)

getRelease(request:protos.google.cloud.deploy.v1.IGetReleaseRequest,callback:Callback<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IGetReleaseRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetReleaseRequest
callbackCallback<protos.google.cloud.deploy.v1.IRelease,protos.google.cloud.deploy.v1.IGetReleaseRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getRollout(request, options)

getRollout(request?:protos.google.cloud.deploy.v1.IGetRolloutRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IGetRolloutRequest|undefined,{}|undefined]>;

Gets details of a single Rollout.

Parameters
NameDescription
requestIGetRolloutRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IGetRolloutRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `Rollout`. Format must be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallGetRollout(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.getRollout(request);console.log(response);}callGetRollout();

getRollout(request, options, callback)

getRollout(request:protos.google.cloud.deploy.v1.IGetRolloutRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IGetRolloutRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRolloutRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IGetRolloutRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getRollout(request, callback)

getRollout(request:protos.google.cloud.deploy.v1.IGetRolloutRequest,callback:Callback<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IGetRolloutRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRolloutRequest
callbackCallback<protos.google.cloud.deploy.v1.IRollout,protos.google.cloud.deploy.v1.IGetRolloutRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getTarget(request, options)

getTarget(request?:protos.google.cloud.deploy.v1.IGetTargetRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IGetTargetRequest|undefined,{}|undefined]>;

Gets details of a single Target.

Parameters
NameDescription
requestIGetTargetRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IGetTargetRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingTarget. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `Target`. Format must be   *  `projects/{project_id}/locations/{location_name}/targets/{target_name}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallGetTarget(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.getTarget(request);console.log(response);}callGetTarget();

getTarget(request, options, callback)

getTarget(request:protos.google.cloud.deploy.v1.IGetTargetRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IGetTargetRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetTargetRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IGetTargetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getTarget(request, callback)

getTarget(request:protos.google.cloud.deploy.v1.IGetTargetRequest,callback:Callback<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IGetTargetRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetTargetRequest
callbackCallback<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IGetTargetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

ignoreJob(request, options)

ignoreJob(request?:protos.google.cloud.deploy.v1.IIgnoreJobRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IIgnoreJobResponse,protos.google.cloud.deploy.v1.IIgnoreJobRequest|undefined,{}|undefined]>;

Ignores the specified Job in a Rollout.

Parameters
NameDescription
requestIIgnoreJobRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IIgnoreJobResponse,protos.google.cloud.deploy.v1.IIgnoreJobRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingIgnoreJobResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the Rollout. Format is   *  `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.   */// const rollout = 'abc123'/**   *  Required. The phase ID the Job to ignore belongs to.   */// const phaseId = 'abc123'/**   *  Required. The job ID for the Job to ignore.   */// const jobId = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallIgnoreJob(){// Construct requestconstrequest={rollout,phaseId,jobId,};// Run requestconstresponse=awaitdeployClient.ignoreJob(request);console.log(response);}callIgnoreJob();

ignoreJob(request, options, callback)

ignoreJob(request:protos.google.cloud.deploy.v1.IIgnoreJobRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IIgnoreJobResponse,protos.google.cloud.deploy.v1.IIgnoreJobRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIIgnoreJobRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IIgnoreJobResponse,protos.google.cloud.deploy.v1.IIgnoreJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

ignoreJob(request, callback)

ignoreJob(request:protos.google.cloud.deploy.v1.IIgnoreJobRequest,callback:Callback<protos.google.cloud.deploy.v1.IIgnoreJobResponse,protos.google.cloud.deploy.v1.IIgnoreJobRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIIgnoreJobRequest
callbackCallback<protos.google.cloud.deploy.v1.IIgnoreJobResponse,protos.google.cloud.deploy.v1.IIgnoreJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

initialize()

initialize():Promise<{[name:string]:Function;}>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]:Function; }>

{Promise} A promise that resolves to an authenticated service stub.

jobPath(project, location, job)

jobPath(project:string,location:string,job:string):string;

Return a fully-qualified job resource name string.

Parameters
NameDescription
projectstring
locationstring
jobstring
Returns
TypeDescription
string

{string} Resource name string.

jobRunPath(project, location, deliveryPipeline, release, rollout, jobRun)

jobRunPath(project:string,location:string,deliveryPipeline:string,release:string,rollout:string,jobRun:string):string;

Return a fully-qualified jobRun resource name string.

Parameters
NameDescription
projectstring
locationstring
deliveryPipelinestring
releasestring
rolloutstring
jobRunstring
Returns
TypeDescription
string

{string} Resource name string.

listAutomationRuns(request, options)

listAutomationRuns(request?:protos.google.cloud.deploy.v1.IListAutomationRunsRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IAutomationRun[],protos.google.cloud.deploy.v1.IListAutomationRunsRequest|null,protos.google.cloud.deploy.v1.IListAutomationRunsResponse]>;

Lists AutomationRuns in a given project and location.

Parameters
NameDescription
requestIListAutomationRunsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IAutomationRun[],protos.google.cloud.deploy.v1.IListAutomationRunsRequest | null,protos.google.cloud.deploy.v1.IListAutomationRunsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistAutomationRunsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listAutomationRuns(request, options, callback)

listAutomationRuns(request:protos.google.cloud.deploy.v1.IListAutomationRunsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListAutomationRunsRequest,protos.google.cloud.deploy.v1.IListAutomationRunsResponse|null|undefined,protos.google.cloud.deploy.v1.IAutomationRun>):void;
Parameters
NameDescription
requestIListAutomationRunsRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListAutomationRunsRequest,protos.google.cloud.deploy.v1.IListAutomationRunsResponse | null | undefined,protos.google.cloud.deploy.v1.IAutomationRun>
Returns
TypeDescription
void

listAutomationRuns(request, callback)

listAutomationRuns(request:protos.google.cloud.deploy.v1.IListAutomationRunsRequest,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListAutomationRunsRequest,protos.google.cloud.deploy.v1.IListAutomationRunsResponse|null|undefined,protos.google.cloud.deploy.v1.IAutomationRun>):void;
Parameters
NameDescription
requestIListAutomationRunsRequest
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListAutomationRunsRequest,protos.google.cloud.deploy.v1.IListAutomationRunsResponse | null | undefined,protos.google.cloud.deploy.v1.IAutomationRun>
Returns
TypeDescription
void

listAutomationRunsAsync(request, options)

listAutomationRunsAsync(request?:protos.google.cloud.deploy.v1.IListAutomationRunsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.deploy.v1.IAutomationRun>;

Equivalent tolistAutomationRuns, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListAutomationRunsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.deploy.v1.IAutomationRun>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent `Delivery Pipeline`, which owns this collection of   *  automationRuns. Format must be   *  `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`.   */// const parent = 'abc123'/**   *  The maximum number of automationRuns to return. The service may return   *  fewer than this value. If unspecified, at most 50 automationRuns will   *  be returned. The maximum value is 1000; values above 1000 will be set   *  to 1000.   */// const pageSize = 1234/**   *  A page token, received from a previous `ListAutomationRuns` call.   *  Provide this to retrieve the subsequent page.   *  When paginating, all other provided parameters match   *  the call that provided the page token.   */// const pageToken = 'abc123'/**   *  Filter automationRuns to be returned. All fields can be used in the   *  filter.   */// const filter = 'abc123'/**   *  Field to sort by.   */// const orderBy = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallListAutomationRuns(){// Construct requestconstrequest={parent,};// Run requestconstiterable=deployClient.listAutomationRunsAsync(request);forawait(constresponseofiterable){console.log(response);}}callListAutomationRuns();

listAutomationRunsStream(request, options)

listAutomationRunsStream(request?:protos.google.cloud.deploy.v1.IListAutomationRunsRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListAutomationRunsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistAutomationRunsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listAutomations(request, options)

listAutomations(request?:protos.google.cloud.deploy.v1.IListAutomationsRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IAutomation[],protos.google.cloud.deploy.v1.IListAutomationsRequest|null,protos.google.cloud.deploy.v1.IListAutomationsResponse]>;

Lists Automations in a given project and location.

Parameters
NameDescription
requestIListAutomationsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IAutomation[],protos.google.cloud.deploy.v1.IListAutomationsRequest | null,protos.google.cloud.deploy.v1.IListAutomationsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array ofAutomation. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistAutomationsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listAutomations(request, options, callback)

listAutomations(request:protos.google.cloud.deploy.v1.IListAutomationsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListAutomationsRequest,protos.google.cloud.deploy.v1.IListAutomationsResponse|null|undefined,protos.google.cloud.deploy.v1.IAutomation>):void;
Parameters
NameDescription
requestIListAutomationsRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListAutomationsRequest,protos.google.cloud.deploy.v1.IListAutomationsResponse | null | undefined,protos.google.cloud.deploy.v1.IAutomation>
Returns
TypeDescription
void

listAutomations(request, callback)

listAutomations(request:protos.google.cloud.deploy.v1.IListAutomationsRequest,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListAutomationsRequest,protos.google.cloud.deploy.v1.IListAutomationsResponse|null|undefined,protos.google.cloud.deploy.v1.IAutomation>):void;
Parameters
NameDescription
requestIListAutomationsRequest
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListAutomationsRequest,protos.google.cloud.deploy.v1.IListAutomationsResponse | null | undefined,protos.google.cloud.deploy.v1.IAutomation>
Returns
TypeDescription
void

listAutomationsAsync(request, options)

listAutomationsAsync(request?:protos.google.cloud.deploy.v1.IListAutomationsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.deploy.v1.IAutomation>;

Equivalent tolistAutomations, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListAutomationsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.deploy.v1.IAutomation>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingAutomation. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent `Delivery Pipeline`, which owns this collection of   *  automations. Format must be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.   */// const parent = 'abc123'/**   *  The maximum number of automations to return. The service may return   *  fewer than this value. If unspecified, at most 50 automations will   *  be returned. The maximum value is 1000; values above 1000 will be set   *  to 1000.   */// const pageSize = 1234/**   *  A page token, received from a previous `ListAutomations` call.   *  Provide this to retrieve the subsequent page.   *  When paginating, all other provided parameters match   *  the call that provided the page token.   */// const pageToken = 'abc123'/**   *  Filter automations to be returned. All fields can be used in the   *  filter.   */// const filter = 'abc123'/**   *  Field to sort by.   */// const orderBy = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallListAutomations(){// Construct requestconstrequest={parent,};// Run requestconstiterable=deployClient.listAutomationsAsync(request);forawait(constresponseofiterable){console.log(response);}}callListAutomations();

listAutomationsStream(request, options)

listAutomationsStream(request?:protos.google.cloud.deploy.v1.IListAutomationsRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListAutomationsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representingAutomation on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistAutomationsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listCustomTargetTypes(request, options)

listCustomTargetTypes(request?:protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.ICustomTargetType[],protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest|null,protos.google.cloud.deploy.v1.IListCustomTargetTypesResponse]>;

Lists CustomTargetTypes in a given project and location.

Parameters
NameDescription
requestIListCustomTargetTypesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.ICustomTargetType[],protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest | null,protos.google.cloud.deploy.v1.IListCustomTargetTypesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array ofCustomTargetType. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistCustomTargetTypesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listCustomTargetTypes(request, options, callback)

listCustomTargetTypes(request:protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest,protos.google.cloud.deploy.v1.IListCustomTargetTypesResponse|null|undefined,protos.google.cloud.deploy.v1.ICustomTargetType>):void;
Parameters
NameDescription
requestIListCustomTargetTypesRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest,protos.google.cloud.deploy.v1.IListCustomTargetTypesResponse | null | undefined,protos.google.cloud.deploy.v1.ICustomTargetType>
Returns
TypeDescription
void

listCustomTargetTypes(request, callback)

listCustomTargetTypes(request:protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest,protos.google.cloud.deploy.v1.IListCustomTargetTypesResponse|null|undefined,protos.google.cloud.deploy.v1.ICustomTargetType>):void;
Parameters
NameDescription
requestIListCustomTargetTypesRequest
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest,protos.google.cloud.deploy.v1.IListCustomTargetTypesResponse | null | undefined,protos.google.cloud.deploy.v1.ICustomTargetType>
Returns
TypeDescription
void

listCustomTargetTypesAsync(request, options)

listCustomTargetTypesAsync(request?:protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.deploy.v1.ICustomTargetType>;

Equivalent tolistCustomTargetTypes, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListCustomTargetTypesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.deploy.v1.ICustomTargetType>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingCustomTargetType. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent that owns this collection of custom target types.   *  Format must be `projects/{project_id}/locations/{location_name}`.   */// const parent = 'abc123'/**   *  Optional. The maximum number of `CustomTargetType` objects to return. The   *  service may return fewer than this value. If unspecified, at most 50   *  `CustomTargetType` objects will be returned. The maximum value is 1000;   *  values above 1000 will be set to 1000.   */// const pageSize = 1234/**   *  Optional. A page token, received from a previous `ListCustomTargetTypes`   *  call. Provide this to retrieve the subsequent page.   *  When paginating, all other provided parameters match   *  the call that provided the page token.   */// const pageToken = 'abc123'/**   *  Optional. Filter custom target types to be returned. See   *  https://google.aip.dev/160 for more details.   */// const filter = 'abc123'/**   *  Optional. Field to sort by. See https://google.aip.dev/132#ordering for   *  more details.   */// const orderBy = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallListCustomTargetTypes(){// Construct requestconstrequest={parent,};// Run requestconstiterable=deployClient.listCustomTargetTypesAsync(request);forawait(constresponseofiterable){console.log(response);}}callListCustomTargetTypes();

listCustomTargetTypesStream(request, options)

listCustomTargetTypesStream(request?:protos.google.cloud.deploy.v1.IListCustomTargetTypesRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListCustomTargetTypesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representingCustomTargetType on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistCustomTargetTypesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listDeliveryPipelines(request, options)

listDeliveryPipelines(request?:protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IDeliveryPipeline[],protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest|null,protos.google.cloud.deploy.v1.IListDeliveryPipelinesResponse]>;

Lists DeliveryPipelines in a given project and location.

Parameters
NameDescription
requestIListDeliveryPipelinesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IDeliveryPipeline[],protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest | null,protos.google.cloud.deploy.v1.IListDeliveryPipelinesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array ofDeliveryPipeline. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistDeliveryPipelinesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listDeliveryPipelines(request, options, callback)

listDeliveryPipelines(request:protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest,protos.google.cloud.deploy.v1.IListDeliveryPipelinesResponse|null|undefined,protos.google.cloud.deploy.v1.IDeliveryPipeline>):void;
Parameters
NameDescription
requestIListDeliveryPipelinesRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest,protos.google.cloud.deploy.v1.IListDeliveryPipelinesResponse | null | undefined,protos.google.cloud.deploy.v1.IDeliveryPipeline>
Returns
TypeDescription
void

listDeliveryPipelines(request, callback)

listDeliveryPipelines(request:protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest,protos.google.cloud.deploy.v1.IListDeliveryPipelinesResponse|null|undefined,protos.google.cloud.deploy.v1.IDeliveryPipeline>):void;
Parameters
NameDescription
requestIListDeliveryPipelinesRequest
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest,protos.google.cloud.deploy.v1.IListDeliveryPipelinesResponse | null | undefined,protos.google.cloud.deploy.v1.IDeliveryPipeline>
Returns
TypeDescription
void

listDeliveryPipelinesAsync(request, options)

listDeliveryPipelinesAsync(request?:protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.deploy.v1.IDeliveryPipeline>;

Equivalent tolistDeliveryPipelines, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListDeliveryPipelinesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.deploy.v1.IDeliveryPipeline>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingDeliveryPipeline. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent, which owns this collection of pipelines. Format must   *  be `projects/{project_id}/locations/{location_name}`.   */// const parent = 'abc123'/**   *  The maximum number of pipelines to return. The service may return   *  fewer than this value. If unspecified, at most 50 pipelines will   *  be returned. The maximum value is 1000; values above 1000 will be set   *  to 1000.   */// const pageSize = 1234/**   *  A page token, received from a previous `ListDeliveryPipelines` call.   *  Provide this to retrieve the subsequent page.   *  When paginating, all other provided parameters match   *  the call that provided the page token.   */// const pageToken = 'abc123'/**   *  Filter pipelines to be returned. See https://google.aip.dev/160 for more   *  details.   */// const filter = 'abc123'/**   *  Field to sort by. See https://google.aip.dev/132#ordering for more details.   */// const orderBy = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallListDeliveryPipelines(){// Construct requestconstrequest={parent,};// Run requestconstiterable=deployClient.listDeliveryPipelinesAsync(request);forawait(constresponseofiterable){console.log(response);}}callListDeliveryPipelines();

listDeliveryPipelinesStream(request, options)

listDeliveryPipelinesStream(request?:protos.google.cloud.deploy.v1.IListDeliveryPipelinesRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListDeliveryPipelinesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representingDeliveryPipeline on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistDeliveryPipelinesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listJobRuns(request, options)

listJobRuns(request?:protos.google.cloud.deploy.v1.IListJobRunsRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IJobRun[],protos.google.cloud.deploy.v1.IListJobRunsRequest|null,protos.google.cloud.deploy.v1.IListJobRunsResponse]>;

Lists JobRuns in a given project and location.

Parameters
NameDescription
requestIListJobRunsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IJobRun[],protos.google.cloud.deploy.v1.IListJobRunsRequest | null,protos.google.cloud.deploy.v1.IListJobRunsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistJobRunsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listJobRuns(request, options, callback)

listJobRuns(request:protos.google.cloud.deploy.v1.IListJobRunsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListJobRunsRequest,protos.google.cloud.deploy.v1.IListJobRunsResponse|null|undefined,protos.google.cloud.deploy.v1.IJobRun>):void;
Parameters
NameDescription
requestIListJobRunsRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListJobRunsRequest,protos.google.cloud.deploy.v1.IListJobRunsResponse | null | undefined,protos.google.cloud.deploy.v1.IJobRun>
Returns
TypeDescription
void

listJobRuns(request, callback)

listJobRuns(request:protos.google.cloud.deploy.v1.IListJobRunsRequest,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListJobRunsRequest,protos.google.cloud.deploy.v1.IListJobRunsResponse|null|undefined,protos.google.cloud.deploy.v1.IJobRun>):void;
Parameters
NameDescription
requestIListJobRunsRequest
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListJobRunsRequest,protos.google.cloud.deploy.v1.IListJobRunsResponse | null | undefined,protos.google.cloud.deploy.v1.IJobRun>
Returns
TypeDescription
void

listJobRunsAsync(request, options)

listJobRunsAsync(request?:protos.google.cloud.deploy.v1.IListJobRunsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.deploy.v1.IJobRun>;

Equivalent tolistJobRuns, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListJobRunsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.deploy.v1.IJobRun>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The `Rollout` which owns this collection of `JobRun` objects.   */// const parent = 'abc123'/**   *  Optional. The maximum number of `JobRun` objects to return. The service may   *  return fewer than this value. If unspecified, at most 50 `JobRun` objects   *  will be returned. The maximum value is 1000; values above 1000 will be set   *  to 1000.   */// const pageSize = 1234/**   *  Optional. A page token, received from a previous `ListJobRuns` call.   *  Provide this to retrieve the subsequent page.   *  When paginating, all other provided parameters match the call that provided   *  the page token.   */// const pageToken = 'abc123'/**   *  Optional. Filter results to be returned. See https://google.aip.dev/160 for   *  more details.   */// const filter = 'abc123'/**   *  Optional. Field to sort by. See https://google.aip.dev/132#ordering for   *  more details.   */// const orderBy = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallListJobRuns(){// Construct requestconstrequest={parent,};// Run requestconstiterable=deployClient.listJobRunsAsync(request);forawait(constresponseofiterable){console.log(response);}}callListJobRuns();

listJobRunsStream(request, options)

listJobRunsStream(request?:protos.google.cloud.deploy.v1.IListJobRunsRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListJobRunsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistJobRunsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request:LocationProtos.google.cloud.location.IListLocationsRequest,options?:CallOptions):AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestLocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
constiterable=client.listLocationsAsync(request);forawait(constresponseofiterable){// process response}

listOperationsAsync(request, options)

listOperationsAsync(request:protos.google.longrunning.ListOperationsRequest,options?:gax.CallOptions):AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returnsUNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
NameDescription
requestListOperationsRequest

The request object that will be sent.

optionsCallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details.

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms toiteration protocols.

Example
constclient=longrunning.operationsClient();forawait(constresponseofclient.listOperationsAsync(request));// doThingsWith(response)

listReleases(request, options)

listReleases(request?:protos.google.cloud.deploy.v1.IListReleasesRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IRelease[],protos.google.cloud.deploy.v1.IListReleasesRequest|null,protos.google.cloud.deploy.v1.IListReleasesResponse]>;

Lists Releases in a given project and location.

Parameters
NameDescription
requestIListReleasesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IRelease[],protos.google.cloud.deploy.v1.IListReleasesRequest | null,protos.google.cloud.deploy.v1.IListReleasesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistReleasesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listReleases(request, options, callback)

listReleases(request:protos.google.cloud.deploy.v1.IListReleasesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListReleasesRequest,protos.google.cloud.deploy.v1.IListReleasesResponse|null|undefined,protos.google.cloud.deploy.v1.IRelease>):void;
Parameters
NameDescription
requestIListReleasesRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListReleasesRequest,protos.google.cloud.deploy.v1.IListReleasesResponse | null | undefined,protos.google.cloud.deploy.v1.IRelease>
Returns
TypeDescription
void

listReleases(request, callback)

listReleases(request:protos.google.cloud.deploy.v1.IListReleasesRequest,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListReleasesRequest,protos.google.cloud.deploy.v1.IListReleasesResponse|null|undefined,protos.google.cloud.deploy.v1.IRelease>):void;
Parameters
NameDescription
requestIListReleasesRequest
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListReleasesRequest,protos.google.cloud.deploy.v1.IListReleasesResponse | null | undefined,protos.google.cloud.deploy.v1.IRelease>
Returns
TypeDescription
void

listReleasesAsync(request, options)

listReleasesAsync(request?:protos.google.cloud.deploy.v1.IListReleasesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.deploy.v1.IRelease>;

Equivalent tolistReleases, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListReleasesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.deploy.v1.IRelease>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The `DeliveryPipeline` which owns this collection of `Release`   *  objects.   */// const parent = 'abc123'/**   *  Optional. The maximum number of `Release` objects to return. The service   *  may return fewer than this value. If unspecified, at most 50 `Release`   *  objects will be returned. The maximum value is 1000; values above 1000 will   *  be set to 1000.   */// const pageSize = 1234/**   *  Optional. A page token, received from a previous `ListReleases` call.   *  Provide this to retrieve the subsequent page.   *  When paginating, all other provided parameters match   *  the call that provided the page token.   */// const pageToken = 'abc123'/**   *  Optional. Filter releases to be returned. See https://google.aip.dev/160   *  for more details.   */// const filter = 'abc123'/**   *  Optional. Field to sort by. See https://google.aip.dev/132#ordering for   *  more details.   */// const orderBy = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallListReleases(){// Construct requestconstrequest={parent,};// Run requestconstiterable=deployClient.listReleasesAsync(request);forawait(constresponseofiterable){console.log(response);}}callListReleases();

listReleasesStream(request, options)

listReleasesStream(request?:protos.google.cloud.deploy.v1.IListReleasesRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListReleasesRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistReleasesAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listRollouts(request, options)

listRollouts(request?:protos.google.cloud.deploy.v1.IListRolloutsRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IRollout[],protos.google.cloud.deploy.v1.IListRolloutsRequest|null,protos.google.cloud.deploy.v1.IListRolloutsResponse]>;

Lists Rollouts in a given project and location.

Parameters
NameDescription
requestIListRolloutsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IRollout[],protos.google.cloud.deploy.v1.IListRolloutsRequest | null,protos.google.cloud.deploy.v1.IListRolloutsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistRolloutsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listRollouts(request, options, callback)

listRollouts(request:protos.google.cloud.deploy.v1.IListRolloutsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListRolloutsRequest,protos.google.cloud.deploy.v1.IListRolloutsResponse|null|undefined,protos.google.cloud.deploy.v1.IRollout>):void;
Parameters
NameDescription
requestIListRolloutsRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListRolloutsRequest,protos.google.cloud.deploy.v1.IListRolloutsResponse | null | undefined,protos.google.cloud.deploy.v1.IRollout>
Returns
TypeDescription
void

listRollouts(request, callback)

listRollouts(request:protos.google.cloud.deploy.v1.IListRolloutsRequest,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListRolloutsRequest,protos.google.cloud.deploy.v1.IListRolloutsResponse|null|undefined,protos.google.cloud.deploy.v1.IRollout>):void;
Parameters
NameDescription
requestIListRolloutsRequest
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListRolloutsRequest,protos.google.cloud.deploy.v1.IListRolloutsResponse | null | undefined,protos.google.cloud.deploy.v1.IRollout>
Returns
TypeDescription
void

listRolloutsAsync(request, options)

listRolloutsAsync(request?:protos.google.cloud.deploy.v1.IListRolloutsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.deploy.v1.IRollout>;

Equivalent tolistRollouts, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListRolloutsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.deploy.v1.IRollout>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The `Release` which owns this collection of `Rollout` objects.   */// const parent = 'abc123'/**   *  Optional. The maximum number of `Rollout` objects to return. The service   *  may return fewer than this value. If unspecified, at most 50 `Rollout`   *  objects will be returned. The maximum value is 1000; values above 1000 will   *  be set to 1000.   */// const pageSize = 1234/**   *  Optional. A page token, received from a previous `ListRollouts` call.   *  Provide this to retrieve the subsequent page.   *  When paginating, all other provided parameters match   *  the call that provided the page token.   */// const pageToken = 'abc123'/**   *  Optional. Filter rollouts to be returned. See https://google.aip.dev/160   *  for more details.   */// const filter = 'abc123'/**   *  Optional. Field to sort by. See https://google.aip.dev/132#ordering for   *  more details.   */// const orderBy = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallListRollouts(){// Construct requestconstrequest={parent,};// Run requestconstiterable=deployClient.listRolloutsAsync(request);forawait(constresponseofiterable){console.log(response);}}callListRollouts();

listRolloutsStream(request, options)

listRolloutsStream(request?:protos.google.cloud.deploy.v1.IListRolloutsRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListRolloutsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistRolloutsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listTargets(request, options)

listTargets(request?:protos.google.cloud.deploy.v1.IListTargetsRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.ITarget[],protos.google.cloud.deploy.v1.IListTargetsRequest|null,protos.google.cloud.deploy.v1.IListTargetsResponse]>;

Lists Targets in a given project and location.

Parameters
NameDescription
requestIListTargetsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.ITarget[],protos.google.cloud.deploy.v1.IListTargetsRequest | null,protos.google.cloud.deploy.v1.IListTargetsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array ofTarget. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend usinglistTargetsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

listTargets(request, options, callback)

listTargets(request:protos.google.cloud.deploy.v1.IListTargetsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListTargetsRequest,protos.google.cloud.deploy.v1.IListTargetsResponse|null|undefined,protos.google.cloud.deploy.v1.ITarget>):void;
Parameters
NameDescription
requestIListTargetsRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListTargetsRequest,protos.google.cloud.deploy.v1.IListTargetsResponse | null | undefined,protos.google.cloud.deploy.v1.ITarget>
Returns
TypeDescription
void

listTargets(request, callback)

listTargets(request:protos.google.cloud.deploy.v1.IListTargetsRequest,callback:PaginationCallback<protos.google.cloud.deploy.v1.IListTargetsRequest,protos.google.cloud.deploy.v1.IListTargetsResponse|null|undefined,protos.google.cloud.deploy.v1.ITarget>):void;
Parameters
NameDescription
requestIListTargetsRequest
callbackPaginationCallback<protos.google.cloud.deploy.v1.IListTargetsRequest,protos.google.cloud.deploy.v1.IListTargetsResponse | null | undefined,protos.google.cloud.deploy.v1.ITarget>
Returns
TypeDescription
void

listTargetsAsync(request, options)

listTargetsAsync(request?:protos.google.cloud.deploy.v1.IListTargetsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.deploy.v1.ITarget>;

Equivalent tolistTargets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListTargetsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.deploy.v1.ITarget>

{Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representingTarget. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent, which owns this collection of targets. Format must be   *  `projects/{project_id}/locations/{location_name}`.   */// const parent = 'abc123'/**   *  Optional. The maximum number of `Target` objects to return. The service may   *  return fewer than this value. If unspecified, at most 50 `Target` objects   *  will be returned. The maximum value is 1000; values above 1000 will be set   *  to 1000.   */// const pageSize = 1234/**   *  Optional. A page token, received from a previous `ListTargets` call.   *  Provide this to retrieve the subsequent page.   *  When paginating, all other provided parameters match   *  the call that provided the page token.   */// const pageToken = 'abc123'/**   *  Optional. Filter targets to be returned. See https://google.aip.dev/160 for   *  more details.   */// const filter = 'abc123'/**   *  Optional. Field to sort by. See https://google.aip.dev/132#ordering for   *  more details.   */// const orderBy = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallListTargets(){// Construct requestconstrequest={parent,};// Run requestconstiterable=deployClient.listTargetsAsync(request);forawait(constresponseofiterable){console.log(response);}}callListTargets();

listTargetsStream(request, options)

listTargetsStream(request?:protos.google.cloud.deploy.v1.IListTargetsRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListTargetsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representingTarget on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend usinglistTargetsAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

locationPath(project, location)

locationPath(project:string,location:string):string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
projectstring
locationstring
Returns
TypeDescription
string

{string} Resource name string.

matchAutomationFromAutomationName(automationName)

matchAutomationFromAutomationName(automationName:string):string|number;

Parse the automation from Automation resource.

Parameter
NameDescription
automationNamestring

A fully-qualified path representing Automation resource.

Returns
TypeDescription
string | number

{string} A string representing the automation.

matchAutomationRunFromAutomationRunName(automationRunName)

matchAutomationRunFromAutomationRunName(automationRunName:string):string|number;

Parse the automation_run from AutomationRun resource.

Parameter
NameDescription
automationRunNamestring

A fully-qualified path representing AutomationRun resource.

Returns
TypeDescription
string | number

{string} A string representing the automation_run.

matchBuildFromBuildName(buildName)

matchBuildFromBuildName(buildName:string):string|number;

Parse the build from Build resource.

Parameter
NameDescription
buildNamestring

A fully-qualified path representing Build resource.

Returns
TypeDescription
string | number

{string} A string representing the build.

matchClusterFromClusterName(clusterName)

matchClusterFromClusterName(clusterName:string):string|number;

Parse the cluster from Cluster resource.

Parameter
NameDescription
clusterNamestring

A fully-qualified path representing Cluster resource.

Returns
TypeDescription
string | number

{string} A string representing the cluster.

matchCustomTargetTypeFromCustomTargetTypeName(customTargetTypeName)

matchCustomTargetTypeFromCustomTargetTypeName(customTargetTypeName:string):string|number;

Parse the custom_target_type from CustomTargetType resource.

Parameter
NameDescription
customTargetTypeNamestring

A fully-qualified path representing CustomTargetType resource.

Returns
TypeDescription
string | number

{string} A string representing the custom_target_type.

matchDeliveryPipelineFromAutomationName(automationName)

matchDeliveryPipelineFromAutomationName(automationName:string):string|number;

Parse the delivery_pipeline from Automation resource.

Parameter
NameDescription
automationNamestring

A fully-qualified path representing Automation resource.

Returns
TypeDescription
string | number

{string} A string representing the delivery_pipeline.

matchDeliveryPipelineFromAutomationRunName(automationRunName)

matchDeliveryPipelineFromAutomationRunName(automationRunName:string):string|number;

Parse the delivery_pipeline from AutomationRun resource.

Parameter
NameDescription
automationRunNamestring

A fully-qualified path representing AutomationRun resource.

Returns
TypeDescription
string | number

{string} A string representing the delivery_pipeline.

matchDeliveryPipelineFromDeliveryPipelineName(deliveryPipelineName)

matchDeliveryPipelineFromDeliveryPipelineName(deliveryPipelineName:string):string|number;

Parse the delivery_pipeline from DeliveryPipeline resource.

Parameter
NameDescription
deliveryPipelineNamestring

A fully-qualified path representing DeliveryPipeline resource.

Returns
TypeDescription
string | number

{string} A string representing the delivery_pipeline.

matchDeliveryPipelineFromJobRunName(jobRunName)

matchDeliveryPipelineFromJobRunName(jobRunName:string):string|number;

Parse the delivery_pipeline from JobRun resource.

Parameter
NameDescription
jobRunNamestring

A fully-qualified path representing JobRun resource.

Returns
TypeDescription
string | number

{string} A string representing the delivery_pipeline.

matchDeliveryPipelineFromReleaseName(releaseName)

matchDeliveryPipelineFromReleaseName(releaseName:string):string|number;

Parse the delivery_pipeline from Release resource.

Parameter
NameDescription
releaseNamestring

A fully-qualified path representing Release resource.

Returns
TypeDescription
string | number

{string} A string representing the delivery_pipeline.

matchDeliveryPipelineFromRolloutName(rolloutName)

matchDeliveryPipelineFromRolloutName(rolloutName:string):string|number;

Parse the delivery_pipeline from Rollout resource.

Parameter
NameDescription
rolloutNamestring

A fully-qualified path representing Rollout resource.

Returns
TypeDescription
string | number

{string} A string representing the delivery_pipeline.

matchJobFromJobName(jobName)

matchJobFromJobName(jobName:string):string|number;

Parse the job from Job resource.

Parameter
NameDescription
jobNamestring

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the job.

matchJobRunFromJobRunName(jobRunName)

matchJobRunFromJobRunName(jobRunName:string):string|number;

Parse the job_run from JobRun resource.

Parameter
NameDescription
jobRunNamestring

A fully-qualified path representing JobRun resource.

Returns
TypeDescription
string | number

{string} A string representing the job_run.

matchLocationFromAutomationName(automationName)

matchLocationFromAutomationName(automationName:string):string|number;

Parse the location from Automation resource.

Parameter
NameDescription
automationNamestring

A fully-qualified path representing Automation resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromAutomationRunName(automationRunName)

matchLocationFromAutomationRunName(automationRunName:string):string|number;

Parse the location from AutomationRun resource.

Parameter
NameDescription
automationRunNamestring

A fully-qualified path representing AutomationRun resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromBuildName(buildName)

matchLocationFromBuildName(buildName:string):string|number;

Parse the location from Build resource.

Parameter
NameDescription
buildNamestring

A fully-qualified path representing Build resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromClusterName(clusterName)

matchLocationFromClusterName(clusterName:string):string|number;

Parse the location from Cluster resource.

Parameter
NameDescription
clusterNamestring

A fully-qualified path representing Cluster resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromConfigName(configName)

matchLocationFromConfigName(configName:string):string|number;

Parse the location from Config resource.

Parameter
NameDescription
configNamestring

A fully-qualified path representing Config resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCustomTargetTypeName(customTargetTypeName)

matchLocationFromCustomTargetTypeName(customTargetTypeName:string):string|number;

Parse the location from CustomTargetType resource.

Parameter
NameDescription
customTargetTypeNamestring

A fully-qualified path representing CustomTargetType resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDeliveryPipelineName(deliveryPipelineName)

matchLocationFromDeliveryPipelineName(deliveryPipelineName:string):string|number;

Parse the location from DeliveryPipeline resource.

Parameter
NameDescription
deliveryPipelineNamestring

A fully-qualified path representing DeliveryPipeline resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromJobName(jobName)

matchLocationFromJobName(jobName:string):string|number;

Parse the location from Job resource.

Parameter
NameDescription
jobNamestring

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromJobRunName(jobRunName)

matchLocationFromJobRunName(jobRunName:string):string|number;

Parse the location from JobRun resource.

Parameter
NameDescription
jobRunNamestring

A fully-qualified path representing JobRun resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName:string):string|number;

Parse the location from Location resource.

Parameter
NameDescription
locationNamestring

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromMembershipName(membershipName)

matchLocationFromMembershipName(membershipName:string):string|number;

Parse the location from Membership resource.

Parameter
NameDescription
membershipNamestring

A fully-qualified path representing Membership resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromReleaseName(releaseName)

matchLocationFromReleaseName(releaseName:string):string|number;

Parse the location from Release resource.

Parameter
NameDescription
releaseNamestring

A fully-qualified path representing Release resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromRolloutName(rolloutName)

matchLocationFromRolloutName(rolloutName:string):string|number;

Parse the location from Rollout resource.

Parameter
NameDescription
rolloutNamestring

A fully-qualified path representing Rollout resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromServiceName(serviceName)

matchLocationFromServiceName(serviceName:string):string|number;

Parse the location from Service resource.

Parameter
NameDescription
serviceNamestring

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTargetName(targetName)

matchLocationFromTargetName(targetName:string):string|number;

Parse the location from Target resource.

Parameter
NameDescription
targetNamestring

A fully-qualified path representing Target resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromWorkerPoolName(workerPoolName)

matchLocationFromWorkerPoolName(workerPoolName:string):string|number;

Parse the location from WorkerPool resource.

Parameter
NameDescription
workerPoolNamestring

A fully-qualified path representing WorkerPool resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchMembershipFromMembershipName(membershipName)

matchMembershipFromMembershipName(membershipName:string):string|number;

Parse the membership from Membership resource.

Parameter
NameDescription
membershipNamestring

A fully-qualified path representing Membership resource.

Returns
TypeDescription
string | number

{string} A string representing the membership.

matchProjectFromAutomationName(automationName)

matchProjectFromAutomationName(automationName:string):string|number;

Parse the project from Automation resource.

Parameter
NameDescription
automationNamestring

A fully-qualified path representing Automation resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromAutomationRunName(automationRunName)

matchProjectFromAutomationRunName(automationRunName:string):string|number;

Parse the project from AutomationRun resource.

Parameter
NameDescription
automationRunNamestring

A fully-qualified path representing AutomationRun resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromBuildName(buildName)

matchProjectFromBuildName(buildName:string):string|number;

Parse the project from Build resource.

Parameter
NameDescription
buildNamestring

A fully-qualified path representing Build resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromClusterName(clusterName)

matchProjectFromClusterName(clusterName:string):string|number;

Parse the project from Cluster resource.

Parameter
NameDescription
clusterNamestring

A fully-qualified path representing Cluster resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromConfigName(configName)

matchProjectFromConfigName(configName:string):string|number;

Parse the project from Config resource.

Parameter
NameDescription
configNamestring

A fully-qualified path representing Config resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCustomTargetTypeName(customTargetTypeName)

matchProjectFromCustomTargetTypeName(customTargetTypeName:string):string|number;

Parse the project from CustomTargetType resource.

Parameter
NameDescription
customTargetTypeNamestring

A fully-qualified path representing CustomTargetType resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDeliveryPipelineName(deliveryPipelineName)

matchProjectFromDeliveryPipelineName(deliveryPipelineName:string):string|number;

Parse the project from DeliveryPipeline resource.

Parameter
NameDescription
deliveryPipelineNamestring

A fully-qualified path representing DeliveryPipeline resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromJobName(jobName)

matchProjectFromJobName(jobName:string):string|number;

Parse the project from Job resource.

Parameter
NameDescription
jobNamestring

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromJobRunName(jobRunName)

matchProjectFromJobRunName(jobRunName:string):string|number;

Parse the project from JobRun resource.

Parameter
NameDescription
jobRunNamestring

A fully-qualified path representing JobRun resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName:string):string|number;

Parse the project from Location resource.

Parameter
NameDescription
locationNamestring

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromMembershipName(membershipName)

matchProjectFromMembershipName(membershipName:string):string|number;

Parse the project from Membership resource.

Parameter
NameDescription
membershipNamestring

A fully-qualified path representing Membership resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName:string):string|number;

Parse the project from Project resource.

Parameter
NameDescription
projectNamestring

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromReleaseName(releaseName)

matchProjectFromReleaseName(releaseName:string):string|number;

Parse the project from Release resource.

Parameter
NameDescription
releaseNamestring

A fully-qualified path representing Release resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromRolloutName(rolloutName)

matchProjectFromRolloutName(rolloutName:string):string|number;

Parse the project from Rollout resource.

Parameter
NameDescription
rolloutNamestring

A fully-qualified path representing Rollout resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromServiceName(serviceName)

matchProjectFromServiceName(serviceName:string):string|number;

Parse the project from Service resource.

Parameter
NameDescription
serviceNamestring

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTargetName(targetName)

matchProjectFromTargetName(targetName:string):string|number;

Parse the project from Target resource.

Parameter
NameDescription
targetNamestring

A fully-qualified path representing Target resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromWorkerPoolName(workerPoolName)

matchProjectFromWorkerPoolName(workerPoolName:string):string|number;

Parse the project from WorkerPool resource.

Parameter
NameDescription
workerPoolNamestring

A fully-qualified path representing WorkerPool resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchReleaseFromJobRunName(jobRunName)

matchReleaseFromJobRunName(jobRunName:string):string|number;

Parse the release from JobRun resource.

Parameter
NameDescription
jobRunNamestring

A fully-qualified path representing JobRun resource.

Returns
TypeDescription
string | number

{string} A string representing the release.

matchReleaseFromReleaseName(releaseName)

matchReleaseFromReleaseName(releaseName:string):string|number;

Parse the release from Release resource.

Parameter
NameDescription
releaseNamestring

A fully-qualified path representing Release resource.

Returns
TypeDescription
string | number

{string} A string representing the release.

matchReleaseFromRolloutName(rolloutName)

matchReleaseFromRolloutName(rolloutName:string):string|number;

Parse the release from Rollout resource.

Parameter
NameDescription
rolloutNamestring

A fully-qualified path representing Rollout resource.

Returns
TypeDescription
string | number

{string} A string representing the release.

matchRolloutFromJobRunName(jobRunName)

matchRolloutFromJobRunName(jobRunName:string):string|number;

Parse the rollout from JobRun resource.

Parameter
NameDescription
jobRunNamestring

A fully-qualified path representing JobRun resource.

Returns
TypeDescription
string | number

{string} A string representing the rollout.

matchRolloutFromRolloutName(rolloutName)

matchRolloutFromRolloutName(rolloutName:string):string|number;

Parse the rollout from Rollout resource.

Parameter
NameDescription
rolloutNamestring

A fully-qualified path representing Rollout resource.

Returns
TypeDescription
string | number

{string} A string representing the rollout.

matchServiceFromServiceName(serviceName)

matchServiceFromServiceName(serviceName:string):string|number;

Parse the service from Service resource.

Parameter
NameDescription
serviceNamestring

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the service.

matchTargetFromTargetName(targetName)

matchTargetFromTargetName(targetName:string):string|number;

Parse the target from Target resource.

Parameter
NameDescription
targetNamestring

A fully-qualified path representing Target resource.

Returns
TypeDescription
string | number

{string} A string representing the target.

matchWorkerPoolFromWorkerPoolName(workerPoolName)

matchWorkerPoolFromWorkerPoolName(workerPoolName:string):string|number;

Parse the worker_pool from WorkerPool resource.

Parameter
NameDescription
workerPoolNamestring

A fully-qualified path representing WorkerPool resource.

Returns
TypeDescription
string | number

{string} A string representing the worker_pool.

membershipPath(project, location, membership)

membershipPath(project:string,location:string,membership:string):string;

Return a fully-qualified membership resource name string.

Parameters
NameDescription
projectstring
locationstring
membershipstring
Returns
TypeDescription
string

{string} Resource name string.

projectPath(project)

projectPath(project:string):string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
projectstring
Returns
TypeDescription
string

{string} Resource name string.

releasePath(project, location, deliveryPipeline, release)

releasePath(project:string,location:string,deliveryPipeline:string,release:string):string;

Return a fully-qualified release resource name string.

Parameters
NameDescription
projectstring
locationstring
deliveryPipelinestring
releasestring
Returns
TypeDescription
string

{string} Resource name string.

retryJob(request, options)

retryJob(request?:protos.google.cloud.deploy.v1.IRetryJobRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IRetryJobResponse,protos.google.cloud.deploy.v1.IRetryJobRequest|undefined,{}|undefined]>;

Retries the specified Job in a Rollout.

Parameters
NameDescription
requestIRetryJobRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IRetryJobResponse,protos.google.cloud.deploy.v1.IRetryJobRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingRetryJobResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the Rollout. Format is   *  `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.   */// const rollout = 'abc123'/**   *  Required. The phase ID the Job to retry belongs to.   */// const phaseId = 'abc123'/**   *  Required. The job ID for the Job to retry.   */// const jobId = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallRetryJob(){// Construct requestconstrequest={rollout,phaseId,jobId,};// Run requestconstresponse=awaitdeployClient.retryJob(request);console.log(response);}callRetryJob();

retryJob(request, options, callback)

retryJob(request:protos.google.cloud.deploy.v1.IRetryJobRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IRetryJobResponse,protos.google.cloud.deploy.v1.IRetryJobRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIRetryJobRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IRetryJobResponse,protos.google.cloud.deploy.v1.IRetryJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

retryJob(request, callback)

retryJob(request:protos.google.cloud.deploy.v1.IRetryJobRequest,callback:Callback<protos.google.cloud.deploy.v1.IRetryJobResponse,protos.google.cloud.deploy.v1.IRetryJobRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIRetryJobRequest
callbackCallback<protos.google.cloud.deploy.v1.IRetryJobResponse,protos.google.cloud.deploy.v1.IRetryJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

rollbackTarget(request, options)

rollbackTarget(request?:protos.google.cloud.deploy.v1.IRollbackTargetRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.IRollbackTargetResponse,protos.google.cloud.deploy.v1.IRollbackTargetRequest|undefined,{}|undefined]>;

Creates aRollout to roll back the specified target.

Parameters
NameDescription
requestIRollbackTargetRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.IRollbackTargetResponse,protos.google.cloud.deploy.v1.IRollbackTargetRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingRollbackTargetResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The `DeliveryPipeline` for which the rollback `Rollout` should be   *  created. Format should be   *  `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.   */// const name = 'abc123'/**   *  Required. ID of the `Target` that is being rolled back.   */// const targetId = 'abc123'/**   *  Required. ID of the rollback `Rollout` to create.   */// const rolloutId = 'abc123'/**   *  Optional. ID of the `Release` to roll back to. If this isn't specified, the   *  previous successful `Rollout` to the specified target will be used to   *  determine the `Release`.   */// const releaseId = 'abc123'/**   *  Optional. If provided, this must be the latest `Rollout` that is on the   *  `Target`.   */// const rolloutToRollBack = 'abc123'/**   *  Optional. Configs for the rollback `Rollout`.   */// const rollbackConfig = {}/**   *  Optional. If set to true, the request is validated and the user is provided   *  with a `RollbackTargetResponse`.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallRollbackTarget(){// Construct requestconstrequest={name,targetId,rolloutId,};// Run requestconstresponse=awaitdeployClient.rollbackTarget(request);console.log(response);}callRollbackTarget();

rollbackTarget(request, options, callback)

rollbackTarget(request:protos.google.cloud.deploy.v1.IRollbackTargetRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.IRollbackTargetResponse,protos.google.cloud.deploy.v1.IRollbackTargetRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIRollbackTargetRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.IRollbackTargetResponse,protos.google.cloud.deploy.v1.IRollbackTargetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

rollbackTarget(request, callback)

rollbackTarget(request:protos.google.cloud.deploy.v1.IRollbackTargetRequest,callback:Callback<protos.google.cloud.deploy.v1.IRollbackTargetResponse,protos.google.cloud.deploy.v1.IRollbackTargetRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIRollbackTargetRequest
callbackCallback<protos.google.cloud.deploy.v1.IRollbackTargetResponse,protos.google.cloud.deploy.v1.IRollbackTargetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

rolloutPath(project, location, deliveryPipeline, release, rollout)

rolloutPath(project:string,location:string,deliveryPipeline:string,release:string,rollout:string):string;

Return a fully-qualified rollout resource name string.

Parameters
NameDescription
projectstring
locationstring
deliveryPipelinestring
releasestring
rolloutstring
Returns
TypeDescription
string

{string} Resource name string.

servicePath(project, location, service)

servicePath(project:string,location:string,service:string):string;

Return a fully-qualified service resource name string.

Parameters
NameDescription
projectstring
locationstring
servicestring
Returns
TypeDescription
string

{string} Resource name string.

setIamPolicy(request, options, callback)

setIamPolicy(request:IamProtos.google.iam.v1.SetIamPolicyRequest,options?:gax.CallOptions|Callback<IamProtos.google.iam.v1.Policy,IamProtos.google.iam.v1.SetIamPolicyRequest|null|undefined,{}|null|undefined>,callback?:Callback<IamProtos.google.iam.v1.Policy,IamProtos.google.iam.v1.SetIamPolicyRequest|null|undefined,{}|null|undefined>):Promise<[IamProtos.google.iam.v1.Policy]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
NameDescription
requestIamProtos.google.iam.v1.SetIamPolicyRequest

The request object that will be sent.

optionsCallOptions |Callback<google.iam.v1.Policy,google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details.

callbackCallback<google.iam.v1.Policy,google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
TypeDescription
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

targetPath(project, location, target)

targetPath(project:string,location:string,target:string):string;

Return a fully-qualified target resource name string.

Parameters
NameDescription
projectstring
locationstring
targetstring
Returns
TypeDescription
string

{string} Resource name string.

terminateJobRun(request, options)

terminateJobRun(request?:protos.google.cloud.deploy.v1.ITerminateJobRunRequest,options?:CallOptions):Promise<[protos.google.cloud.deploy.v1.ITerminateJobRunResponse,protos.google.cloud.deploy.v1.ITerminateJobRunRequest|undefined,{}|undefined]>;

Terminates a Job Run in a given project and location.

Parameters
NameDescription
requestITerminateJobRunRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.deploy.v1.ITerminateJobRunResponse,protos.google.cloud.deploy.v1.ITerminateJobRunRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingTerminateJobRunResponse. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Name of the `JobRun`. Format must be   *  `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}`.   */// const name = 'abc123'// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallTerminateJobRun(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaitdeployClient.terminateJobRun(request);console.log(response);}callTerminateJobRun();

terminateJobRun(request, options, callback)

terminateJobRun(request:protos.google.cloud.deploy.v1.ITerminateJobRunRequest,options:CallOptions,callback:Callback<protos.google.cloud.deploy.v1.ITerminateJobRunResponse,protos.google.cloud.deploy.v1.ITerminateJobRunRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestITerminateJobRunRequest
optionsCallOptions
callbackCallback<protos.google.cloud.deploy.v1.ITerminateJobRunResponse,protos.google.cloud.deploy.v1.ITerminateJobRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

terminateJobRun(request, callback)

terminateJobRun(request:protos.google.cloud.deploy.v1.ITerminateJobRunRequest,callback:Callback<protos.google.cloud.deploy.v1.ITerminateJobRunResponse,protos.google.cloud.deploy.v1.ITerminateJobRunRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestITerminateJobRunRequest
callbackCallback<protos.google.cloud.deploy.v1.ITerminateJobRunResponse,protos.google.cloud.deploy.v1.ITerminateJobRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

testIamPermissions(request, options, callback)

testIamPermissions(request:IamProtos.google.iam.v1.TestIamPermissionsRequest,options?:gax.CallOptions|Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse,IamProtos.google.iam.v1.TestIamPermissionsRequest|null|undefined,{}|null|undefined>,callback?:Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse,IamProtos.google.iam.v1.TestIamPermissionsRequest|null|undefined,{}|null|undefined>):Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
NameDescription
requestIamProtos.google.iam.v1.TestIamPermissionsRequest

The request object that will be sent.

optionsCallOptions |Callback<google.iam.v1.TestIamPermissionsResponse,google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details.

callbackCallback<google.iam.v1.TestIamPermissionsResponse,google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
TypeDescription
Promise<[google.iam.v1.TestIamPermissionsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

updateAutomation(request, options)

updateAutomation(request?:protos.google.cloud.deploy.v1.IUpdateAutomationRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Updates the parameters of a single Automation resource.

Parameters
NameDescription
requestIUpdateAutomationRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Field mask is used to specify the fields to be overwritten in the   *  `Automation` resource by the update.   *  The fields specified in the update_mask are relative to the resource, not   *  the full request. A field will be overwritten if it's in the mask. If the   *  user doesn't provide a mask then all fields are overwritten.   */// const updateMask = {}/**   *  Required. The `Automation` to update.   */// const automation = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, updating a `Automation` that does not exist will   *  result in the creation of a new `Automation`.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallUpdateAutomation(){// Construct requestconstrequest={updateMask,automation,};// Run requestconst[operation]=awaitdeployClient.updateAutomation(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateAutomation();

updateAutomation(request, options, callback)

updateAutomation(request:protos.google.cloud.deploy.v1.IUpdateAutomationRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateAutomationRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateAutomation(request, callback)

updateAutomation(request:protos.google.cloud.deploy.v1.IUpdateAutomationRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateAutomationRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IAutomation,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCustomTargetType(request, options)

updateCustomTargetType(request?:protos.google.cloud.deploy.v1.IUpdateCustomTargetTypeRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Updates a single CustomTargetType.

Parameters
NameDescription
requestIUpdateCustomTargetTypeRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Field mask is used to specify the fields to be overwritten in the   *  `CustomTargetType` resource by the update.   *  The fields specified in the update_mask are relative to the resource, not   *  the full request. A field will be overwritten if it's in the mask. If the   *  user doesn't provide a mask then all fields are overwritten.   */// const updateMask = {}/**   *  Required. The `CustomTargetType` to update.   */// const customTargetType = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, updating a `CustomTargetType` that does not exist   *  will result in the creation of a new `CustomTargetType`.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallUpdateCustomTargetType(){// Construct requestconstrequest={updateMask,customTargetType,};// Run requestconst[operation]=awaitdeployClient.updateCustomTargetType(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateCustomTargetType();

updateCustomTargetType(request, options, callback)

updateCustomTargetType(request:protos.google.cloud.deploy.v1.IUpdateCustomTargetTypeRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateCustomTargetTypeRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCustomTargetType(request, callback)

updateCustomTargetType(request:protos.google.cloud.deploy.v1.IUpdateCustomTargetTypeRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateCustomTargetTypeRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.ICustomTargetType,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDeliveryPipeline(request, options)

updateDeliveryPipeline(request?:protos.google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Updates the parameters of a single DeliveryPipeline.

Parameters
NameDescription
requestIUpdateDeliveryPipelineRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Field mask is used to specify the fields to be overwritten in the   *  `DeliveryPipeline` resource by the update.   *  The fields specified in the update_mask are relative to the resource, not   *  the full request. A field will be overwritten if it's in the mask. If the   *  user doesn't provide a mask then all fields are overwritten.   */// const updateMask = {}/**   *  Required. The `DeliveryPipeline` to update.   */// const deliveryPipeline = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, updating a `DeliveryPipeline` that does not exist   *  will result in the creation of a new `DeliveryPipeline`.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallUpdateDeliveryPipeline(){// Construct requestconstrequest={updateMask,deliveryPipeline,};// Run requestconst[operation]=awaitdeployClient.updateDeliveryPipeline(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateDeliveryPipeline();

updateDeliveryPipeline(request, options, callback)

updateDeliveryPipeline(request:protos.google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateDeliveryPipelineRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDeliveryPipeline(request, callback)

updateDeliveryPipeline(request:protos.google.cloud.deploy.v1.IUpdateDeliveryPipelineRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateDeliveryPipelineRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.IDeliveryPipeline,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateTarget(request, options)

updateTarget(request?:protos.google.cloud.deploy.v1.IUpdateTargetRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Updates the parameters of a single Target.

Parameters
NameDescription
requestIUpdateTargetRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Itspromise() method returns a promise you canawait for. Please see thedocumentation for more details and examples.

Example
/**   * This snippet has been automatically generated and should be regarded as a code template only.   * It will require modifications to work.   * It may require correct/in-range values for request initialization.   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. Field mask is used to specify the fields to be overwritten in the   *  Target resource by the update.   *  The fields specified in the update_mask are relative to the resource, not   *  the full request. A field will be overwritten if it's in the mask. If the   *  user doesn't provide a mask then all fields are overwritten.   */// const updateMask = {}/**   *  Required. The `Target` to update.   */// const target = {}/**   *  Optional. A request ID to identify requests. Specify a unique request ID   *  so that if you must retry your request, the server knows to ignore the   *  request if it has already been completed. The server guarantees that for   *  at least 60 minutes after the first request.   *  For example, consider a situation where you make an initial request and the   *  request times out. If you make the request again with the same request ID,   *  the server can check if original operation with the same request ID was   *  received, and if so, will ignore the second request. This prevents clients   *  from accidentally creating duplicate commitments.   *  The request ID must be a valid UUID with the exception that zero UUID is   *  not supported (00000000-0000-0000-0000-000000000000).   */// const requestId = 'abc123'/**   *  Optional. If set to true, updating a `Target` that does not exist will   *  result in the creation of a new `Target`.   */// const allowMissing = true/**   *  Optional. If set to true, the request is validated and the user is provided   *  with an expected result, but no actual change is made.   */// const validateOnly = true// Imports the Deploy libraryconst{CloudDeployClient}=require('@google-cloud/deploy').v1;// Instantiates a clientconstdeployClient=newCloudDeployClient();asyncfunctioncallUpdateTarget(){// Construct requestconstrequest={updateMask,target,};// Run requestconst[operation]=awaitdeployClient.updateTarget(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateTarget();

updateTarget(request, options, callback)

updateTarget(request:protos.google.cloud.deploy.v1.IUpdateTargetRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateTargetRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateTarget(request, callback)

updateTarget(request:protos.google.cloud.deploy.v1.IUpdateTargetRequest,callback:Callback<LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIUpdateTargetRequest
callbackCallback<LROperation<protos.google.cloud.deploy.v1.ITarget,protos.google.cloud.deploy.v1.IOperationMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

workerPoolPath(project, location, workerPool)

workerPoolPath(project:string,location:string,workerPool:string):string;

Return a fully-qualified workerPool resource name string.

Parameters
NameDescription
projectstring
locationstring
workerPoolstring
Returns
TypeDescription
string

{string} Resource name string.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.