AnalyticsHubServiceClient

AnalyticsHubServiceClient

The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish listings that reference shared datasets. With Analytics Hub, users can discover and search for listings that they have access to. Subscribers can view and subscribe to listings. When you subscribe to a listing, Analytics Hub creates a linked dataset in your project.

Constructor

new AnalyticsHubServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of AnalyticsHubServiceClient.

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 AnalyticsHubServiceClient({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: ''});
```

(async) checkDeleteSubscriptionProgress(name) → {Promise}

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

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. Resource name of the subscription to delete.
   *  e.g. projects/123/locations/US/subscriptions/456
   */
  // const name = 'abc123'

  // Imports the Analyticshub library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-analyticshub').v1;

  // Instantiates a client
  const analyticshubClient = new AnalyticsHubServiceClient();

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

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

  callDeleteSubscription();

(async) checkRefreshSubscriptionProgress(name) → {Promise}

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

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. Resource name of the Subscription to refresh.
   *  e.g. `projects/subscriberproject/locations/US/subscriptions/123`
   */
  // const name = 'abc123'

  // Imports the Analyticshub library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-analyticshub').v1;

  // Instantiates a client
  const analyticshubClient = new AnalyticsHubServiceClient();

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

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

  callRefreshSubscription();

(async) checkSubscribeDataExchangeProgress(name) → {Promise}

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

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. Resource name of the Data Exchange.
   *  e.g. `projects/publisherproject/locations/US/dataExchanges/123`
   */
  // const name = 'abc123'
  /**
   *  Required. The parent resource path of the Subscription.
   *  e.g. `projects/subscriberproject/locations/US`
   */
  // const destination = 'abc123'
  /**
   *  Required. Name of the subscription to create.
   *  e.g. `subscription1`
   */
  // const subscription = 'abc123'
  /**
   *  Email of the subscriber.
   */
  // const subscriberContact = 'abc123'

  // Imports the Analyticshub library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-analyticshub').v1;

  // Instantiates a client
  const analyticshubClient = new AnalyticsHubServiceClient();

  async function callSubscribeDataExchange() {
    // Construct request
    const request = {
      name,
      destination,
      subscription,
    };

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

  callSubscribeDataExchange();

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.

dataExchangePath(project, location, data_exchange) → {string}

Return a fully-qualified dataExchange resource name string.

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

Resource name string.

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: ''});
```

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.

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.

listDataExchangesAsync(request, optionsopt) → {Object}

Equivalent to listDataExchanges, 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 resource path of the data exchanges. e.g. projects/myproject/locations/US.
pageSize number

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken string

Page token, returned by a previous call, to request the next page of results.
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 DataExchange. 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 resource path of the data exchanges.
   *  e.g. `projects/myproject/locations/US`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of results to return in a single response page. Leverage
   *  the page tokens to iterate through the entire collection.
   */
  // const pageSize = 1234
  /**
   *  Page token, returned by a previous call, to request the next page of
   *  results.
   */
  // const pageToken = 'abc123'

  // Imports the Analyticshub library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-analyticshub').v1;

  // Instantiates a client
  const analyticshubClient = new AnalyticsHubServiceClient();

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

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

  callListDataExchanges();

listDataExchangesStream(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 resource path of the data exchanges. e.g. projects/myproject/locations/US.
pageSize number

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken string

Page token, returned by a previous call, to request the next page of results.
options object <optional>

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

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

listListingsAsync(request, optionsopt) → {Object}

Equivalent to listListings, 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 resource path of the listing. e.g. projects/myproject/locations/US/dataExchanges/123.
pageSize number

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken string

Page token, returned by a previous call, to request the next page of results.
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 Listing. 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 resource path of the listing.
   *  e.g. `projects/myproject/locations/US/dataExchanges/123`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of results to return in a single response page. Leverage
   *  the page tokens to iterate through the entire collection.
   */
  // const pageSize = 1234
  /**
   *  Page token, returned by a previous call, to request the next page of
   *  results.
   */
  // const pageToken = 'abc123'

  // Imports the Analyticshub library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-analyticshub').v1;

  // Instantiates a client
  const analyticshubClient = new AnalyticsHubServiceClient();

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

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

  callListListings();

listListingsStream(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 resource path of the listing. e.g. projects/myproject/locations/US/dataExchanges/123.
pageSize number

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken string

Page token, returned by a previous call, to request the next page of results.
options object <optional>

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

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

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)
```

listOrgDataExchangesAsync(request, optionsopt) → {Object}

Equivalent to listOrgDataExchanges, 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
organization string

Required. The organization resource path of the projects containing DataExchanges. e.g. organizations/myorg/locations/US.
pageSize number

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken string

Page token, returned by a previous call, to request the next page of results.
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 DataExchange. 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 organization resource path of the projects containing
   *  DataExchanges. e.g. `organizations/myorg/locations/US`.
   */
  // const organization = 'abc123'
  /**
   *  The maximum number of results to return in a single response page. Leverage
   *  the page tokens to iterate through the entire collection.
   */
  // const pageSize = 1234
  /**
   *  Page token, returned by a previous call, to request the next page of
   *  results.
   */
  // const pageToken = 'abc123'

  // Imports the Analyticshub library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-analyticshub').v1;

  // Instantiates a client
  const analyticshubClient = new AnalyticsHubServiceClient();

  async function callListOrgDataExchanges() {
    // Construct request
    const request = {
      organization,
    };

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

  callListOrgDataExchanges();

listOrgDataExchangesStream(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
organization string

Required. The organization resource path of the projects containing DataExchanges. e.g. organizations/myorg/locations/US.
pageSize number

The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken string

Page token, returned by a previous call, to request the next page of results.
options object <optional>

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

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

listSharedResourceSubscriptionsAsync(request, optionsopt) → {Object}

Equivalent to listSharedResourceSubscriptions, 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
resource string

Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789
includeDeletedSubscriptions boolean

If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
pageSize number

The maximum number of results to return in a single response page.
pageToken string

Page token, returned by a previous call.
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 Subscription. 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. Resource name of the requested target. This resource may be
   *  either a Listing or a DataExchange. e.g.
   *  projects/123/locations/US/dataExchanges/456 OR e.g.
   *  projects/123/locations/US/dataExchanges/456/listings/789
   */
  // const resource = 'abc123'
  /**
   *  If selected, includes deleted subscriptions in the response
   *  (up to 63 days after deletion).
   */
  // const includeDeletedSubscriptions = true
  /**
   *  The maximum number of results to return in a single response page.
   */
  // const pageSize = 1234
  /**
   *  Page token, returned by a previous call.
   */
  // const pageToken = 'abc123'

  // Imports the Analyticshub library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-analyticshub').v1;

  // Instantiates a client
  const analyticshubClient = new AnalyticsHubServiceClient();

  async function callListSharedResourceSubscriptions() {
    // Construct request
    const request = {
      resource,
    };

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

  callListSharedResourceSubscriptions();

listSharedResourceSubscriptionsStream(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
resource string

Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789
includeDeletedSubscriptions boolean

If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
pageSize number

The maximum number of results to return in a single response page.
pageToken string

Page token, returned by a previous call.
options object <optional>

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

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

listSubscriptionsAsync(request, optionsopt) → {Object}

Equivalent to listSubscriptions, 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 resource path of the subscription. e.g. projects/myproject/locations/US
filter string

An expression for filtering the results of the request. Eligible fields for filtering are:

  • listing
  • data_exchange

Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above.

In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

  • data_exchange="projects/myproject/locations/us/dataExchanges/123"
  • listing="projects/123/locations/us/dataExchanges/456/listings/789"
  • "projects/myproject/locations/us/dataExchanges/123"
pageSize number

The maximum number of results to return in a single response page.
pageToken string

Page token, returned by a previous call.
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 Subscription. 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 resource path of the subscription.
   *  e.g. projects/myproject/locations/US
   */
  // const parent = 'abc123'
  /**
   *  An expression for filtering the results of the request. Eligible
   *  fields for filtering are:
   *   * `listing`
   *   * `data_exchange`
   *  Alternatively, a literal wrapped in double quotes may be provided.
   *  This will be checked for an exact match against both fields above.
   *  In all cases, the full Data Exchange or Listing resource name must
   *  be provided. Some example of using filters:
   *   * data_exchange="projects/myproject/locations/us/dataExchanges/123"
   *   * listing="projects/123/locations/us/dataExchanges/456/listings/789"
   *   * "projects/myproject/locations/us/dataExchanges/123"
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of results to return in a single response page.
   */
  // const pageSize = 1234
  /**
   *  Page token, returned by a previous call.
   */
  // const pageToken = 'abc123'

  // Imports the Analyticshub library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-analyticshub').v1;

  // Instantiates a client
  const analyticshubClient = new AnalyticsHubServiceClient();

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

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

  callListSubscriptions();

listSubscriptionsStream(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 resource path of the subscription. e.g. projects/myproject/locations/US
filter string

An expression for filtering the results of the request. Eligible fields for filtering are:

  • listing
  • data_exchange

Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above.

In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

  • data_exchange="projects/myproject/locations/us/dataExchanges/123"
  • listing="projects/123/locations/us/dataExchanges/456/listings/789"
  • "projects/myproject/locations/us/dataExchanges/123"
pageSize number

The maximum number of results to return in a single response page.
pageToken string

Page token, returned by a previous call.
options object <optional>

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

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

listingPath(project, location, data_exchange, listing) → {string}

Return a fully-qualified listing resource name string.

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

Resource name string.

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.

matchDataExchangeFromDataExchangeName(dataExchangeName) → {string}

Parse the data_exchange from DataExchange resource.

Parameters:
Name Type Description
dataExchangeName string

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

A string representing the data_exchange.

matchDataExchangeFromListingName(listingName) → {string}

Parse the data_exchange from Listing resource.

Parameters:
Name Type Description
listingName string

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

A string representing the data_exchange.

matchListingFromListingName(listingName) → {string}

Parse the listing from Listing resource.

Parameters:
Name Type Description
listingName string

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

A string representing the listing.

matchLocationFromDataExchangeName(dataExchangeName) → {string}

Parse the location from DataExchange resource.

Parameters:
Name Type Description
dataExchangeName string

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

A string representing the location.

matchLocationFromListingName(listingName) → {string}

Parse the location from Listing resource.

Parameters:
Name Type Description
listingName string

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

matchLocationFromSubscriptionName(subscriptionName) → {string}

Parse the location from Subscription resource.

Parameters:
Name Type Description
subscriptionName string

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

A string representing the location.

matchProjectFromDataExchangeName(dataExchangeName) → {string}

Parse the project from DataExchange resource.

Parameters:
Name Type Description
dataExchangeName string

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

A string representing the project.

matchProjectFromListingName(listingName) → {string}

Parse the project from Listing resource.

Parameters:
Name Type Description
listingName string

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

matchProjectFromSubscriptionName(subscriptionName) → {string}

Parse the project from Subscription resource.

Parameters:
Name Type Description
subscriptionName string

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

A string representing the project.

matchSubscriptionFromSubscriptionName(subscriptionName) → {string}

Parse the subscription from Subscription resource.

Parameters:
Name Type Description
subscriptionName string

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

A string representing the subscription.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

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

Resource name string.

subscriptionPath(project, location, subscription) → {string}

Return a fully-qualified subscription resource name string.

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

Resource name string.