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

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

  static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 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

  static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

The port for this API service.

scopes

  static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

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

servicePath

  static 
  
 get 
  
 servicePath 
 () 
 : 
  
 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 by createTrigger() .

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
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 library 
  
 const 
  
 { 
 EventarcClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/eventarc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 eventarcClient 
  
 = 
  
 new 
  
  EventarcClient 
 
 (); 
  
 async 
  
 function 
  
 callCreateTrigger 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 trigger 
 , 
  
 triggerId 
 , 
  
 validateOnly 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 eventarcClient 
 . 
 createTrigger 
 ( 
 request 
 ); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 operation 
 . 
 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 by deleteTrigger() .

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
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 library 
  
 const 
  
 { 
 EventarcClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/eventarc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 eventarcClient 
  
 = 
  
 new 
  
  EventarcClient 
 
 (); 
  
 async 
  
 function 
  
 callDeleteTrigger 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 validateOnly 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 eventarcClient 
 . 
 deleteTrigger 
 ( 
 request 
 ); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 operation 
 . 
 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 by updateTrigger() .

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
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 library 
  
 const 
  
 { 
 EventarcClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/eventarc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 eventarcClient 
  
 = 
  
 new 
  
  EventarcClient 
 
 (); 
  
 async 
  
 function 
  
 callUpdateTrigger 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 validateOnly 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 eventarcClient 
 . 
 updateTrigger 
 ( 
 request 
 ); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 operation 
 . 
 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

Type	Description
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

Name	Description
request	`protos. google.cloud.eventarc.v1.ICreateTriggerRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
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. Its `promise()` method returns a promise you can `await` 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 library 
  
 const 
  
 { 
 EventarcClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/eventarc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 eventarcClient 
  
 = 
  
 new 
  
  EventarcClient 
 
 (); 
  
 async 
  
 function 
  
 callCreateTrigger 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 trigger 
 , 
  
 triggerId 
 , 
  
 validateOnly 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 eventarcClient 
 . 
 createTrigger 
 ( 
 request 
 ); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 operation 
 . 
 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

Name	Description
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>`

Returns

Type	Description
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

Name	Description
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>`

Returns

Type	Description
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

Name	Description
request	`protos. google.cloud.eventarc.v1.IDeleteTriggerRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
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. Its `promise()` method returns a promise you can `await` 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 library 
  
 const 
  
 { 
 EventarcClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/eventarc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 eventarcClient 
  
 = 
  
 new 
  
  EventarcClient 
 
 (); 
  
 async 
  
 function 
  
 callDeleteTrigger 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 validateOnly 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 eventarcClient 
 . 
 deleteTrigger 
 ( 
 request 
 ); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 operation 
 . 
 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

Name	Description
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>`

Returns

Type	Description
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

Name	Description
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>`

Returns

Type	Description
void

getProjectId()

  getProjectId 
 () 
 : 
  
 Promise<string> 
 ;

Returns

Type	Description
Promise <string>

getProjectId(callback)

  getProjectId 
 ( 
 callback 
 : 
  
 Callback<string 
 , 
  
 undefined 
 , 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`Callback <string, undefined, undefined>`

Returns

Type	Description
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

Name	Description
request	`protos. google.cloud.eventarc.v1.IGetTriggerRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
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 library 
  
 const 
  
 { 
 EventarcClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/eventarc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 eventarcClient 
  
 = 
  
 new 
  
  EventarcClient 
 
 (); 
  
 async 
  
 function 
  
 callGetTrigger 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 eventarcClient 
 . 
 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

Name	Description
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>`

Returns

Type	Description
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

Name	Description
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>`

Returns

Type	Description
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

Type	Description
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

Name	Description
request	`protos. google.cloud.eventarc.v1.IListTriggersRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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 using listTriggersAsync() 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

Name	Description
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 >`

Returns

Type	Description
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

Name	Description
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 >`

Returns

Type	Description
void

listTriggersAsync(request, options)

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

Equivalent to listTriggers , but returns an iterable object.

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

Parameters

Name	Description
request	`protos. google.cloud.eventarc.v1.IListTriggersRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

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 library 
  
 const 
  
 { 
 EventarcClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/eventarc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 eventarcClient 
  
 = 
  
 new 
  
  EventarcClient 
 
 (); 
  
 async 
  
 function 
  
 callListTriggers 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 iterable 
  
 = 
  
 await 
  
 eventarcClient 
 . 
  listTriggersAsync 
 
 ( 
 request 
 ); 
  
 for 
  
 await 
  
 ( 
 const 
  
 response 
  
 of 
  
 iterable 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 } 
  
 callListTriggers 
 ();

listTriggersStream(request, options)

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

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

Parameters

Name	Description
request	`protos. google.cloud.eventarc.v1.IListTriggersRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

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 using listTriggersAsync() 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

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

matchLocationFromLocationName(locationName)

  matchLocationFromLocationName 
 ( 
 locationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the location from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromTriggerName(triggerName)

  matchLocationFromTriggerName 
 ( 
 triggerName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the location from Trigger resource.

Parameter

Name	Description
triggerName	`string` A fully-qualified path representing Trigger resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchProjectFromLocationName(locationName)

  matchProjectFromLocationName 
 ( 
 locationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

  matchProjectFromProjectName 
 ( 
 projectName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from Project resource.

Parameter

Name	Description
projectName	`string` A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTriggerName(triggerName)

  matchProjectFromTriggerName 
 ( 
 triggerName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from Trigger resource.

Parameter

Name	Description
triggerName	`string` A fully-qualified path representing Trigger resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchTriggerFromTriggerName(triggerName)

  matchTriggerFromTriggerName 
 ( 
 triggerName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the trigger from Trigger resource.

Parameter

Name	Description
triggerName	`string` A fully-qualified path representing Trigger resource.

Returns

Type	Description
string \| number	{string} A string representing the trigger.

projectPath(project)

  projectPath 
 ( 
 project 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
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

Name	Description
project	`string`
location	`string`
trigger	`string`

Returns

Type	Description
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

Name	Description
request	`protos. google.cloud.eventarc.v1.IUpdateTriggerRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
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. Its `promise()` method returns a promise you can `await` 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 library 
  
 const 
  
 { 
 EventarcClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/eventarc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 eventarcClient 
  
 = 
  
 new 
  
  EventarcClient 
 
 (); 
  
 async 
  
 function 
  
 callUpdateTrigger 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 validateOnly 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 eventarcClient 
 . 
 updateTrigger 
 ( 
 request 
 ); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 operation 
 . 
 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

Name	Description
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>`

Returns

Type	Description
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

Name	Description
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>`

Returns

Type	Description
void

Class v1.EventarcClient (1.1.2) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(opts)

Properties

apiEndpoint

auth

descriptors

eventarcStub

innerApiCalls

operationsClient

pathTemplates

port

scopes

servicePath

warn

Methods

checkCreateTriggerProgress(name)

checkDeleteTriggerProgress(name)

checkUpdateTriggerProgress(name)

close()

createTrigger(request, options)

createTrigger(request, options, callback)

createTrigger(request, callback)

deleteTrigger(request, options)

deleteTrigger(request, options, callback)

deleteTrigger(request, callback)

getProjectId()

getProjectId(callback)

getTrigger(request, options)

getTrigger(request, options, callback)

getTrigger(request, callback)

initialize()

listTriggers(request, options)

listTriggers(request, options, callback)

listTriggers(request, callback)

listTriggersAsync(request, options)

listTriggersStream(request, options)

locationPath(project, location)

matchLocationFromLocationName(locationName)

matchLocationFromTriggerName(triggerName)

matchProjectFromLocationName(locationName)

matchProjectFromProjectName(projectName)

matchProjectFromTriggerName(triggerName)

matchTriggerFromTriggerName(triggerName)

projectPath(project)

triggerPath(project, location, trigger)

updateTrigger(request, options)

updateTrigger(request, options, callback)

updateTrigger(request, callback)

Class v1.EventarcClient (1.1.2)