ConnectionServiceClient

Manages external data source connections and credentials.

Constructor

new ConnectionServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of ConnectionServiceClient.

Parameters:

Name Type Attributes Description

options

object

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean | "rest"

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

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 ConnectionServiceClient({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.

clusterPath(project, region, cluster) → {string}

Return a fully-qualified cluster resource name string.

Parameters:

Name	Type	Description
`project`	string
`region`	string
`cluster`	string

Returns:

Type	Description
string	Resource name string.

connectionPath(project, location, connection) → {string}

Return a fully-qualified connection resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`connection`	string

Returns:

Type	Description
string	Resource name string.

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.

listConnectionsAsync(request, optionsopt) → {Object}

Equivalent to listConnections, 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. Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}`
`pageSize`	number	Required. Page size.
`pageToken`	string	Page token.

options

object

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 Connection. 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. Parent resource name.
   *  Must be in the form: `projects/{project_id}/locations/{location_id}`
   */
  // const parent = 'abc123'
  /**
   *  Required. Page size.
   */
  // const pageSize = 1234
  /**
   *  Page token.
   */
  // const pageToken = 'abc123'

  // Imports the Connection library
  const {ConnectionServiceClient} = require('@google-cloud/bigquery-connection').v1;

  // Instantiates a client
  const connectionClient = new ConnectionServiceClient();

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

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

  callListConnections();

listConnectionsStream(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. Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}`
`pageSize`	number	Required. Page size.
`pageToken`	string	Page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Connection 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 `listConnectionsAsync()` 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.

matchClusterFromClusterName(clusterName) → {string}

Parse the cluster from Cluster resource.

Parameters:

Name	Type	Description
`clusterName`	string	A fully-qualified path representing Cluster resource.

Returns:

Type	Description
string	A string representing the cluster.

matchConnectionFromConnectionName(connectionName) → {string}

Parse the connection from Connection resource.

Parameters:

Name	Type	Description
`connectionName`	string	A fully-qualified path representing Connection resource.

Returns:

Type	Description
string	A string representing the connection.

matchLocationFromConnectionName(connectionName) → {string}

Parse the location from Connection resource.

Parameters:

Name	Type	Description
`connectionName`	string	A fully-qualified path representing Connection 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.

matchLocationFromServiceName(serviceName) → {string}

Parse the location from Service resource.

Parameters:

Name	Type	Description
`serviceName`	string	A fully-qualified path representing Service resource.

Returns:

Type	Description
string	A string representing the location.

matchProjectFromClusterName(clusterName) → {string}

Parse the project from Cluster resource.

Parameters:

Name	Type	Description
`clusterName`	string	A fully-qualified path representing Cluster resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromConnectionName(connectionName) → {string}

Parse the project from Connection resource.

Parameters:

Name	Type	Description
`connectionName`	string	A fully-qualified path representing Connection 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.

matchProjectFromServiceName(serviceName) → {string}

Parse the project from Service resource.

Parameters:

Name	Type	Description
`serviceName`	string	A fully-qualified path representing Service resource.

Returns:

Type	Description
string	A string representing the project.

matchRegionFromClusterName(clusterName) → {string}

Parse the region from Cluster resource.

Parameters:

Name	Type	Description
`clusterName`	string	A fully-qualified path representing Cluster resource.

Returns:

Type	Description
string	A string representing the region.

matchServiceFromServiceName(serviceName) → {string}

Parse the service from Service resource.

Parameters:

Name	Type	Description
`serviceName`	string	A fully-qualified path representing Service resource.

Returns:

Type	Description
string	A string representing the service.

servicePath(project, location, service) → {string}

Return a fully-qualified service resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`service`	string

Returns:

Type	Description
string	Resource name string.