EventarcClient

EventarcClient

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

Constructor

new EventarcClient(optionsopt)

Construct an instance of EventarcClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

(async) checkCreateTriggerProgress(name) → {Promise}

Check the status of the long running operation returned by createTrigger().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.
Example
const decodedOperation = await checkCreateTriggerProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

(async) checkDeleteTriggerProgress(name) → {Promise}

Check the status of the long running operation returned by deleteTrigger().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.
Example
const decodedOperation = await checkDeleteTriggerProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

(async) checkUpdateTriggerProgress(name) → {Promise}

Check the status of the long running operation returned by updateTrigger().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.
Example
const decodedOperation = await checkUpdateTriggerProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

close() → {Promise}

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

A promise that resolves when the client is closed.

createTrigger(request, optionsopt) → {Promise}

Create a new trigger in a particular project and location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent collection in which to add this trigger.
trigger google.cloud.eventarc.v1.Trigger

Required. The trigger to create.
triggerId string

Required. The user-provided ID to be assigned to the trigger.
validateOnly boolean

Required. If set, validate the request and preview the review, but do not actually post it.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.
Example
const [operation] = await client.createTrigger(request);
const [response] = await operation.promise();

deleteTrigger(request, optionsopt) → {Promise}

Delete a single trigger.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the trigger to be deleted.
etag string

If provided, the trigger will only be deleted if the etag matches the current etag on the resource.
allowMissing boolean

If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server.
validateOnly boolean

Required. If set, validate the request and preview the review, but do not actually post it.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.
Example
const [operation] = await client.deleteTrigger(request);
const [response] = await operation.promise();

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

getTrigger(request, optionsopt) → {Promise}

Get a single trigger.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the trigger to get.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Trigger. Please see the documentation for more details and examples.
Example
const [response] = await client.getTrigger(request);

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listTriggers(request, optionsopt) → {Promise}

List triggers.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent collection to list triggers on.
pageSize number

The maximum number of triggers to return on each page. Note: The service may send fewer.
pageToken string

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.
orderBy string

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.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

listTriggersAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent collection to list triggers on.
pageSize number

The maximum number of triggers to return on each page. Note: The service may send fewer.
pageToken string

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.
orderBy string

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.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 for more details and examples.
Example
const iterable = client.listTriggersAsync(request);
for await (const response of iterable) {
  // process response
}

listTriggersStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent collection to list triggers on.
pageSize number

The maximum number of triggers to return on each page. Note: The service may send fewer.
pageToken string

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.
orderBy string

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.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:
Name Type Description
project string
location string
Returns:
Type Description
string

Resource name string.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTriggerName(triggerName) → {string}

Parse the location from Trigger resource.

Parameters:
Name Type Description
triggerName string

A fully-qualified path representing Trigger resource.
Returns:
Type Description
string

A string representing the location.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

A fully-qualified path representing Project resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTriggerName(triggerName) → {string}

Parse the project from Trigger resource.

Parameters:
Name Type Description
triggerName string

A fully-qualified path representing Trigger resource.
Returns:
Type Description
string

A string representing the project.

matchTriggerFromTriggerName(triggerName) → {string}

Parse the trigger from Trigger resource.

Parameters:
Name Type Description
triggerName string

A fully-qualified path representing Trigger resource.
Returns:
Type Description
string

A string representing the trigger.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

triggerPath(project, location, trigger) → {string}

Return a fully-qualified trigger resource name string.

Parameters:
Name Type Description
project string
location string
trigger string
Returns:
Type Description
string

Resource name string.

updateTrigger(request, optionsopt) → {Promise}

Update a single trigger.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
trigger google.cloud.eventarc.v1.Trigger

The trigger to be updated.
updateMask google.protobuf.FieldMask

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 "*".
allowMissing boolean

If set to true, and the trigger is not found, a new trigger will be created. In this situation, update_mask is ignored.
validateOnly boolean

Required. If set, validate the request and preview the review, but do not actually post it.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.
Example
const [operation] = await client.updateTrigger(request);
const [response] = await operation.promise();