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, gaxInstanceopt)

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/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-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 EventarcClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

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

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

cancelOperation(request, optionsopt, callbackopt) → {Promise}

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 returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation 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 Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

channelConnectionPath(project, location, channel_connection) → {string}

Return a fully-qualified channelConnection resource name string.

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

Resource name string.

channelPath(project, location, channel) → {string}

Return a fully-qualified channel resource name string.

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

Resource name string.

(async) checkCreateChannelConnectionProgress(name) → {Promise}

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

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
  /**
   * 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 to add this channel connection.
   */
  // const parent = 'abc123'
  /**
   *  Required. Channel connection to create.
   */
  // const channelConnection = {}
  /**
   *  Required. The user-provided ID to be assigned to the channel connection.
   */
  // const channelConnectionId = 'abc123'

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

  async function callCreateChannelConnection() {
    // Construct request
    const request = {
      parent,
      channelConnection,
      channelConnectionId,
    };

    // Run request
    const [operation] = await eventarcClient.createChannelConnection(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateChannelConnection();

(async) checkCreateChannelProgress(name) → {Promise}

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

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
  /**
   * 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 to add this channel.
   */
  // const parent = 'abc123'
  /**
   *  Required. The channel to create.
   */
  // const channel = {}
  /**
   *  Required. The user-provided ID to be assigned to the channel.
   */
  // const channelId = 'abc123'
  /**
   *  Required. If set, validate the request and preview the review, but do not
   *  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 callCreateChannel() {
    // Construct request
    const request = {
      parent,
      channel,
      channelId,
      validateOnly,
    };

    // Run request
    const [operation] = await eventarcClient.createChannel(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateChannel();

(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
  /**
   * 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 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
   *  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();

(async) checkDeleteChannelConnectionProgress(name) → {Promise}

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

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
  /**
   * 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 channel connection to delete.
   */
  // const name = 'abc123'

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

  async function callDeleteChannelConnection() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await eventarcClient.deleteChannelConnection(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteChannelConnection();

(async) checkDeleteChannelProgress(name) → {Promise}

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

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
  /**
   * 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 channel to be deleted.
   */
  // const name = 'abc123'
  /**
   *  Required. If set, validate the request and preview the review, but do not
   *  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 callDeleteChannel() {
    // Construct request
    const request = {
      name,
      validateOnly,
    };

    // Run request
    const [operation] = await eventarcClient.deleteChannel(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteChannel();

(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
  /**
   * 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 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
   *  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();

(async) checkUpdateChannelProgress(name) → {Promise}

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

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
  /**
   * 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.
   */
  /**
   *  The channel to be updated.
   */
  // const channel = {}
  /**
   *  The fields to be updated; only fields explicitly provided are updated.
   *  If no field mask is provided, all provided fields in the request are
   *  updated. To update all fields, provide a field mask of "*".
   */
  // const updateMask = {}
  /**
   *  Required. If set, validate the request and preview the review, but do not
   *  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 callUpdateChannel() {
    // Construct request
    const request = {
      validateOnly,
    };

    // Run request
    const [operation] = await eventarcClient.updateChannel(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateChannel();

(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
  /**
   * 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.
   */
  /**
   *  The trigger to be updated.
   */
  // const trigger = {}
  /**
   *  The fields to be updated; only fields explicitly provided are updated.
   *  If no field mask is provided, all provided fields in the request are
   *  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
   *  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() → {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.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

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 returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

getIamPolicy(request, optionsopt, callbackopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
resource string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options Object <optional>

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

This object should have the same structure as GetPolicyOptions.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

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

The second parameter to the callback is an object representing Policy.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
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 Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getOperation(request, optionsopt, callbackopt) → {Promise}

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

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

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

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

googleChannelConfigPath(project, location) → {string}

Return a fully-qualified googleChannelConfig resource name string.

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

Resource name string.

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.

listChannelConnectionsAsync(request, optionsopt) → {Object}

Equivalent to listChannelConnections, 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 from which to list channel connections.
pageSize number

The maximum number of channel connections to return on each page.

Note: The service may send fewer responses.
pageToken string

The page token; provide the value from the next_page_token field in a previous ListChannelConnections call to retrieve the subsequent page.

When paginating, all other parameters provided to ListChannelConnetions match the call that provided the page token.
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 ChannelConnection. 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
  /**
   * 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 from which to list channel connections.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of channel connections to return on each page.
   *  Note: The service may send fewer responses.
   */
  // const pageSize = 1234
  /**
   *  The page token; provide the value from the `next_page_token` field in a
   *  previous `ListChannelConnections` call to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListChannelConnetions`
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

  async function callListChannelConnections() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = eventarcClient.listChannelConnectionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListChannelConnections();

listChannelConnectionsStream(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 from which to list channel connections.
pageSize number

The maximum number of channel connections to return on each page.

Note: The service may send fewer responses.
pageToken string

The page token; provide the value from the next_page_token field in a previous ListChannelConnections call to retrieve the subsequent page.

When paginating, all other parameters provided to ListChannelConnetions match the call that provided the page token.
options object <optional>

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

An object stream which emits an object representing ChannelConnection 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 listChannelConnectionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listChannelsAsync(request, optionsopt) → {Object}

Equivalent to listChannels, 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 channels on.
pageSize number

The maximum number of channels 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 ListChannels call to retrieve the subsequent page.

When paginating, all other parameters provided to ListChannels 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 order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, channel_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 Channel. 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
  /**
   * 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 to list channels on.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of channels 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 `ListChannels` call to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListChannels` 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 order is ascending. To
   *  specify descending order for a field, append a `desc` suffix; for example:
   *  `name desc, channel_id`.
   */
  // const orderBy = 'abc123'

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

  async function callListChannels() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = eventarcClient.listChannelsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListChannels();

listChannelsStream(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 channels on.
pageSize number

The maximum number of channels 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 ListChannels call to retrieve the subsequent page.

When paginating, all other parameters provided to ListChannels 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 order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, channel_id.
options object <optional>

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

An object stream which emits an object representing Channel 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 listChannelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, optionsopt) → {Object}

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

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
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 Location. 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.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

listOperationsAsync(request, optionsopt) → {Object}

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

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

listProvidersAsync(request, optionsopt) → {Object}

Equivalent to listProviders, 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 of the provider to get.
pageSize number

The maximum number of providers to return on each page.
pageToken string

The page token; provide the value from the next_page_token field in a previous ListProviders call to retrieve the subsequent page.

When paginating, all other parameters provided to ListProviders 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, _id.
filter string

The filter field that the list request will filter on.
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 Provider. 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
  /**
   * 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 of the provider to get.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of providers to return on each page.
   */
  // const pageSize = 1234
  /**
   *  The page token; provide the value from the `next_page_token` field in a
   *  previous `ListProviders` call to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListProviders` 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, _id`.
   */
  // const orderBy = 'abc123'
  /**
   *  The filter field that the list request will filter on.
   */
  // const filter = 'abc123'

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

  async function callListProviders() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = eventarcClient.listProvidersAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListProviders();

listProvidersStream(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 of the provider to get.
pageSize number

The maximum number of providers to return on each page.
pageToken string

The page token; provide the value from the next_page_token field in a previous ListProviders call to retrieve the subsequent page.

When paginating, all other parameters provided to ListProviders 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, _id.
filter string

The filter field that the list request will filter on.
options object <optional>

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

An object stream which emits an object representing Provider 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 listProvidersAsync() 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 order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, trigger_id.
filter string

Filter field. Used to filter the Triggers to be listed. Possible filters are described in https://google.aip.dev/160. For example, using "?filter=destination:gke" would list only Triggers with a gke destination.
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
  /**
   * 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 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 order is ascending. To
   *  specify descending order for a field, append a `desc` suffix; for example:
   *  `name desc, trigger_id`.
   */
  // const orderBy = 'abc123'
  /**
   *  Filter field. Used to filter the Triggers to be listed. Possible filters
   *  are described in https://google.aip.dev/160. For example, using
   *  "?filter=destination:gke" would list only Triggers with a gke destination.
   */
  // const filter = '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 = eventarcClient.listTriggersAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTriggers();

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 order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, trigger_id.
filter string

Filter field. Used to filter the Triggers to be listed. Possible filters are described in https://google.aip.dev/160. For example, using "?filter=destination:gke" would list only Triggers with a gke destination.
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.

matchChannelConnectionFromChannelConnectionName(channelConnectionName) → {string}

Parse the channel_connection from ChannelConnection resource.

Parameters:
Name Type Description
channelConnectionName string

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

A string representing the channel_connection.

matchChannelFromChannelName(channelName) → {string}

Parse the channel from Channel resource.

Parameters:
Name Type Description
channelName string

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

A string representing the channel.

matchLocationFromChannelConnectionName(channelConnectionName) → {string}

Parse the location from ChannelConnection resource.

Parameters:
Name Type Description
channelConnectionName string

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

A string representing the location.

matchLocationFromChannelName(channelName) → {string}

Parse the location from Channel resource.

Parameters:
Name Type Description
channelName string

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

A string representing the location.

matchLocationFromGoogleChannelConfigName(googleChannelConfigName) → {string}

Parse the location from GoogleChannelConfig resource.

Parameters:
Name Type Description
googleChannelConfigName string

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

A string representing the location.

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.

matchLocationFromProviderName(providerName) → {string}

Parse the location from Provider resource.

Parameters:
Name Type Description
providerName string

A fully-qualified path representing Provider 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.

matchProjectFromChannelConnectionName(channelConnectionName) → {string}

Parse the project from ChannelConnection resource.

Parameters:
Name Type Description
channelConnectionName string

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

A string representing the project.

matchProjectFromChannelName(channelName) → {string}

Parse the project from Channel resource.

Parameters:
Name Type Description
channelName string

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

A string representing the project.

matchProjectFromGoogleChannelConfigName(googleChannelConfigName) → {string}

Parse the project from GoogleChannelConfig resource.

Parameters:
Name Type Description
googleChannelConfigName string

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

A string representing the project.

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.

matchProjectFromProviderName(providerName) → {string}

Parse the project from Provider resource.

Parameters:
Name Type Description
providerName string

A fully-qualified path representing Provider 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.

matchProviderFromProviderName(providerName) → {string}

Parse the provider from Provider resource.

Parameters:
Name Type Description
providerName string

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

A string representing the provider.

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.

providerPath(project, location, provider) → {string}

Return a fully-qualified provider resource name string.

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

Resource name string.

setIamPolicy(request, optionsopt, callbackopt) → {Promise}

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

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions Array.<string>

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

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

The second parameter to the callback is an object representing TestIamPermissionsResponse.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

testIamPermissions(request, optionsopt, callbackopt) → {Promise}

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

The request object that will be sent.

Properties
Name Type Description
resource string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions Array.<string>

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

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

The second parameter to the callback is an object representing TestIamPermissionsResponse.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

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.