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 | "rest" <optional>

Use HTTP fallback mode. Pass "rest" to use HTTP/1.1 REST API instead of gRPC. 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: 'rest'}, gax);

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

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.

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

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 Dataexchange library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-data-exchange').v1beta1;

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

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

    // Run request
    const iterable = await dataexchangeClient.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 Dataexchange library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-data-exchange').v1beta1;

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

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

    // Run request
    const iterable = await dataexchangeClient.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.

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

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 Dataexchange library
  const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-data-exchange').v1beta1;

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

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

    // Run request
    const iterable = await dataexchangeClient.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.

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.

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.