Class v1.EventarcClient (1.1.2)

Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations. v1

Package

@google-cloud/eventarc

Constructors

(constructor)(opts)

constructor(opts?:ClientOptions);

Construct an instance of EventarcClient.

Parameter
NameDescription
optsClientOptions

Properties

apiEndpoint

staticgetapiEndpoint():string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth:gax.GoogleAuth;

descriptors

descriptors:Descriptors;

eventarcStub

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

innerApiCalls

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

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.

warn

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

Methods

checkCreateTriggerProgress(name)

checkCreateTriggerProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger,protos.google.cloud.eventarc.v1.OperationMetadata>>;

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

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger, protos.google.cloud.eventarc.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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example
/**   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which to add this trigger.   */// const parent = 'abc123'/**   *  Required. The trigger to create.   */// const trigger = {}/**   *  Required. The user-provided ID to be assigned to the trigger.   */// const triggerId = 'abc123'/**   *  Required. If set, validate the request and preview the review, but do not actually   *  post it.   */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateTrigger(){// Construct requestconstrequest={parent,trigger,triggerId,validateOnly,};// Run requestconst[operation]=awaiteventarcClient.createTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callCreateTrigger();

checkDeleteTriggerProgress(name)

checkDeleteTriggerProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger,protos.google.cloud.eventarc.v1.OperationMetadata>>;

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

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger, protos.google.cloud.eventarc.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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example
/**   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the trigger to be deleted.   */// const name = 'abc123'/**   *  If provided, the trigger will only be deleted if the etag matches the   *  current etag on the resource.   */// const etag = 'abc123'/**   *  If set to true, and the trigger is not found, the request will succeed   *  but no action will be taken on the server.   */// const allowMissing = true/**   *  Required. If set, validate the request and preview the review, but do not actually   *  post it.   */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteTrigger(){// Construct requestconstrequest={name,validateOnly,};// Run requestconst[operation]=awaiteventarcClient.deleteTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteTrigger();

checkUpdateTriggerProgress(name)

checkUpdateTriggerProgress(name:string):Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger,protos.google.cloud.eventarc.v1.OperationMetadata>>;

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

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger, protos.google.cloud.eventarc.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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example
/**   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  The trigger to be updated.   */// const trigger = {}/**   *  The fields to be updated; only fields explicitly provided will be updated.   *  If no field mask is provided, all provided fields in the request will be   *  updated. To update all fields, provide a field mask of "*".   */// const updateMask = {}/**   *  If set to true, and the trigger is not found, a new trigger will be   *  created. In this situation, `update_mask` is ignored.   */// const allowMissing = true/**   *  Required. If set, validate the request and preview the review, but do not actually   *  post it.   */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateTrigger(){// Construct requestconstrequest={validateOnly,};// Run requestconst[operation]=awaiteventarcClient.updateTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateTrigger();

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.

createTrigger(request, options)

createTrigger(request?:protos.google.cloud.eventarc.v1.ICreateTriggerRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Create a new trigger in a particular project and location.

Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.ICreateTriggerRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example
/**   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection in which to add this trigger.   */// const parent = 'abc123'/**   *  Required. The trigger to create.   */// const trigger = {}/**   *  Required. The user-provided ID to be assigned to the trigger.   */// const triggerId = 'abc123'/**   *  Required. If set, validate the request and preview the review, but do not actually   *  post it.   */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallCreateTrigger(){// Construct requestconstrequest={parent,trigger,triggerId,validateOnly,};// Run requestconst[operation]=awaiteventarcClient.createTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callCreateTrigger();

createTrigger(request, options, callback)

createTrigger(request:protos.google.cloud.eventarc.v1.ICreateTriggerRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.ICreateTriggerRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createTrigger(request, callback)

createTrigger(request:protos.google.cloud.eventarc.v1.ICreateTriggerRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.ICreateTriggerRequest
callbackCallback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteTrigger(request, options)

deleteTrigger(request?:protos.google.cloud.eventarc.v1.IDeleteTriggerRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Delete a single trigger.

Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IDeleteTriggerRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example
/**   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the trigger to be deleted.   */// const name = 'abc123'/**   *  If provided, the trigger will only be deleted if the etag matches the   *  current etag on the resource.   */// const etag = 'abc123'/**   *  If set to true, and the trigger is not found, the request will succeed   *  but no action will be taken on the server.   */// const allowMissing = true/**   *  Required. If set, validate the request and preview the review, but do not actually   *  post it.   */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallDeleteTrigger(){// Construct requestconstrequest={name,validateOnly,};// Run requestconst[operation]=awaiteventarcClient.deleteTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callDeleteTrigger();

deleteTrigger(request, options, callback)

deleteTrigger(request:protos.google.cloud.eventarc.v1.IDeleteTriggerRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IDeleteTriggerRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteTrigger(request, callback)

deleteTrigger(request:protos.google.cloud.eventarc.v1.IDeleteTriggerRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IDeleteTriggerRequest
callbackCallback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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

getTrigger(request, options)

getTrigger(request?:protos.google.cloud.eventarc.v1.IGetTriggerRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IGetTriggerRequest|undefined,{}|undefined]>;

Get a single trigger.

Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IGetTriggerRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IGetTriggerRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Trigger]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example
/**   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The name of the trigger to get.   */// const name = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallGetTrigger(){// Construct requestconstrequest={name,};// Run requestconstresponse=awaiteventarcClient.getTrigger(request);console.log(response);}callGetTrigger();

getTrigger(request, options, callback)

getTrigger(request:protos.google.cloud.eventarc.v1.IGetTriggerRequest,options:CallOptions,callback:Callback<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IGetTriggerRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IGetTriggerRequest
optionsCallOptions
callbackCallback<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IGetTriggerRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getTrigger(request, callback)

getTrigger(request:protos.google.cloud.eventarc.v1.IGetTriggerRequest,callback:Callback<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IGetTriggerRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IGetTriggerRequest
callbackCallback<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IGetTriggerRequest | 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.

listTriggers(request, options)

listTriggers(request?:protos.google.cloud.eventarc.v1.IListTriggersRequest,options?:CallOptions):Promise<[protos.google.cloud.eventarc.v1.ITrigger[],protos.google.cloud.eventarc.v1.IListTriggersRequest|null,protos.google.cloud.eventarc.v1.IListTriggersResponse]>;

List triggers.

Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IListTriggersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.eventarc.v1.ITrigger[], protos.google.cloud.eventarc.v1.IListTriggersRequest | null, protos.google.cloud.eventarc.v1.IListTriggersResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Trigger]. 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 usinglistTriggersAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTriggers(request, options, callback)

listTriggers(request:protos.google.cloud.eventarc.v1.IListTriggersRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest,protos.google.cloud.eventarc.v1.IListTriggersResponse|null|undefined,protos.google.cloud.eventarc.v1.ITrigger>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IListTriggersRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest, protos.google.cloud.eventarc.v1.IListTriggersResponse | null | undefined, protos.google.cloud.eventarc.v1.ITrigger>
Returns
TypeDescription
void

listTriggers(request, callback)

listTriggers(request:protos.google.cloud.eventarc.v1.IListTriggersRequest,callback:PaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest,protos.google.cloud.eventarc.v1.IListTriggersResponse|null|undefined,protos.google.cloud.eventarc.v1.ITrigger>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IListTriggersRequest
callbackPaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest, protos.google.cloud.eventarc.v1.IListTriggersResponse | null | undefined, protos.google.cloud.eventarc.v1.ITrigger>
Returns
TypeDescription
void

listTriggersAsync(request, options)

listTriggersAsync(request?:protos.google.cloud.eventarc.v1.IListTriggersRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.eventarc.v1.ITrigger>;

Equivalent tolistTriggers, but returns an iterable object.

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

Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IListTriggersRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.eventarc.v1.ITrigger>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Trigger]. 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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example
/**   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  Required. The parent collection to list triggers on.   */// const parent = 'abc123'/**   *  The maximum number of triggers to return on each page.   *  Note: The service may send fewer.   */// const pageSize = 1234/**   *  The page token; provide the value from the `next_page_token` field in a   *  previous `ListTriggers` call to retrieve the subsequent page.   *  When paginating, all other parameters provided to `ListTriggers` must match   *  the call that provided the page token.   */// const pageToken = 'abc123'/**   *  The sorting order of the resources returned. Value should be a comma   *  separated list of fields. The default sorting oder is ascending. To specify   *  descending order for a field, append a ` desc` suffix; for example:   *  `name desc, trigger_id`.   */// const orderBy = 'abc123'// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallListTriggers(){// Construct requestconstrequest={parent,};// Run requestconstiterable=awaiteventarcClient.listTriggersAsync(request);forawait(constresponseofiterable){console.log(response);}}callListTriggers();

listTriggersStream(request, options)

listTriggersStream(request?:protos.google.cloud.eventarc.v1.IListTriggersRequest,options?:CallOptions):Transform;

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

Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IListTriggersRequest

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 [Trigger] 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 usinglistTriggersAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.

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.

matchLocationFromTriggerName(triggerName)

matchLocationFromTriggerName(triggerName:string):string|number;

Parse the location from Trigger resource.

Parameter
NameDescription
triggerNamestring

A fully-qualified path representing Trigger resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

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.

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.

matchProjectFromTriggerName(triggerName)

matchProjectFromTriggerName(triggerName:string):string|number;

Parse the project from Trigger resource.

Parameter
NameDescription
triggerNamestring

A fully-qualified path representing Trigger resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchTriggerFromTriggerName(triggerName)

matchTriggerFromTriggerName(triggerName:string):string|number;

Parse the trigger from Trigger resource.

Parameter
NameDescription
triggerNamestring

A fully-qualified path representing Trigger resource.

Returns
TypeDescription
string | number

{string} A string representing the trigger.

projectPath(project)

projectPath(project:string):string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
projectstring
Returns
TypeDescription
string

{string} Resource name string.

triggerPath(project, location, trigger)

triggerPath(project:string,location:string,trigger:string):string;

Return a fully-qualified trigger resource name string.

Parameters
NameDescription
projectstring
locationstring
triggerstring
Returns
TypeDescription
string

{string} Resource name string.

updateTrigger(request, options)

updateTrigger(request?:protos.google.cloud.eventarc.v1.IUpdateTriggerRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Update a single trigger.

Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IUpdateTriggerRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.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 the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example
/**   * TODO(developer): Uncomment these variables before running the sample.   *//**   *  The trigger to be updated.   */// const trigger = {}/**   *  The fields to be updated; only fields explicitly provided will be updated.   *  If no field mask is provided, all provided fields in the request will be   *  updated. To update all fields, provide a field mask of "*".   */// const updateMask = {}/**   *  If set to true, and the trigger is not found, a new trigger will be   *  created. In this situation, `update_mask` is ignored.   */// const allowMissing = true/**   *  Required. If set, validate the request and preview the review, but do not actually   *  post it.   */// const validateOnly = true// Imports the Eventarc libraryconst{EventarcClient}=require('@google-cloud/eventarc').v1;// Instantiates a clientconsteventarcClient=newEventarcClient();asyncfunctioncallUpdateTrigger(){// Construct requestconstrequest={validateOnly,};// Run requestconst[operation]=awaiteventarcClient.updateTrigger(request);const[response]=awaitoperation.promise();console.log(response);}callUpdateTrigger();

updateTrigger(request, options, callback)

updateTrigger(request:protos.google.cloud.eventarc.v1.IUpdateTriggerRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IUpdateTriggerRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateTrigger(request, callback)

updateTrigger(request:protos.google.cloud.eventarc.v1.IUpdateTriggerRequest,callback:Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger,protos.google.cloud.eventarc.v1.IOperationMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestprotos.google.cloud.eventarc.v1.IUpdateTriggerRequest
callbackCallback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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-12-03 UTC.