Class v1.DataFusionClient

Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI. v1

Package

@google-cloud/data-fusion

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of DataFusionClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

dataFusionStub

dataFusionStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

checkCreateInstanceProgress(name)

checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.datafusion.v1.Instance, protos.google.cloud.datafusion.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.datafusion.v1.Instance, protos.google.cloud.datafusion.v1.OperationMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The instance's project and location in the format
   *  projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Required. The name of the instance to create.
   */
  // const instanceId = 'abc123'
  /**
   *  An instance resource.
   */
  // const instance = {}

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

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

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

  callCreateInstance();

checkDeleteInstanceProgress(name)

checkDeleteInstanceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datafusion.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datafusion.v1.OperationMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The instance resource name in the format
   *  projects/{project}/locations/{location}/instances/{instance}
   */
  // const name = 'abc123'

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

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

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

  callDeleteInstance();

checkRestartInstanceProgress(name)

checkRestartInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.datafusion.v1.Instance, protos.google.cloud.datafusion.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.datafusion.v1.Instance, protos.google.cloud.datafusion.v1.OperationMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the Data Fusion instance which need to be restarted in the form of
   *  projects/{project}/locations/{location}/instances/{instance}
   */
  // const name = 'abc123'

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

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

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

  callRestartInstance();

checkUpdateInstanceProgress(name)

checkUpdateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.datafusion.v1.Instance, protos.google.cloud.datafusion.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.datafusion.v1.Instance, protos.google.cloud.datafusion.v1.OperationMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The instance resource that replaces the resource on the server. Currently,
   *  Data Fusion only allows replacing labels, options, and stack driver
   *  settings. All other fields will be ignored.
   */
  // const instance = {}
  /**
   *  Field mask is used to specify the fields that the update will overwrite
   *  in an instance resource. The fields specified in the update_mask are
   *  relative to the resource, not the full request.
   *  A field will be overwritten if it is in the mask.
   *  If the user does not provide a mask, all the supported fields (labels,
   *  options, and version currently) will be overwritten.
   */
  // const updateMask = {}

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

  async function callUpdateInstance() {
    // Construct request
    const request = {
      instance,
    };

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

  callUpdateInstance();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createInstance(request, options)

createInstance(request?: protos.google.cloud.datafusion.v1.ICreateInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new Data Fusion instance in the specified project and location.

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.ICreateInstanceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The instance's project and location in the format
   *  projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Required. The name of the instance to create.
   */
  // const instanceId = 'abc123'
  /**
   *  An instance resource.
   */
  // const instance = {}

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

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

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

  callCreateInstance();

createInstance(request, options, callback)

createInstance(request: protos.google.cloud.datafusion.v1.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.ICreateInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createInstance(request, callback)

createInstance(request: protos.google.cloud.datafusion.v1.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.ICreateInstanceRequest
callback Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

cryptoKeyPath(project, location, keyRing, cryptoKey)

cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string;

Return a fully-qualified cryptoKey resource name string.

Parameters
NameDescription
project string
location string
keyRing string
cryptoKey string
Returns
TypeDescription
string

{string} Resource name string.

deleteInstance(request, options)

deleteInstance(request?: protos.google.cloud.datafusion.v1.IDeleteInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datafusion.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single Date Fusion instance.

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IDeleteInstanceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The instance resource name in the format
   *  projects/{project}/locations/{location}/instances/{instance}
   */
  // const name = 'abc123'

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

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

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

  callDeleteInstance();

deleteInstance(request, options, callback)

deleteInstance(request: protos.google.cloud.datafusion.v1.IDeleteInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IDeleteInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteInstance(request, callback)

deleteInstance(request: protos.google.cloud.datafusion.v1.IDeleteInstanceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IDeleteInstanceRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getInstance(request, options)

getInstance(request?: protos.google.cloud.datafusion.v1.IGetInstanceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.datafusion.v1.IInstance,
        protos.google.cloud.datafusion.v1.IGetInstanceRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Data Fusion instance.

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IGetInstanceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IGetInstanceRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Instance]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The instance resource name in the format
   *  projects/{project}/locations/{location}/instances/{instance}.
   */
  // const name = 'abc123'

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

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

    // Run request
    const response = await datafusionClient.getInstance(request);
    console.log(response);
  }

  callGetInstance();

getInstance(request, options, callback)

getInstance(request: protos.google.cloud.datafusion.v1.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IGetInstanceRequest
options CallOptions
callback Callback<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getInstance(request, callback)

getInstance(request: protos.google.cloud.datafusion.v1.IGetInstanceRequest, callback: Callback<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IGetInstanceRequest
callback Callback<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

instancePath(project, location, instance)

instancePath(project: string, location: string, instance: string): string;

Return a fully-qualified instance resource name string.

Parameters
NameDescription
project string
location string
instance string
Returns
TypeDescription
string

{string} Resource name string.

listAvailableVersions(request, options)

listAvailableVersions(request?: protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.datafusion.v1.IVersion[],
        protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest | null,
        protos.google.cloud.datafusion.v1.IListAvailableVersionsResponse
    ]>;

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.datafusion.v1.IVersion[], protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest | null, protos.google.cloud.datafusion.v1.IListAvailableVersionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Version]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAvailableVersionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAvailableVersions(request, options, callback)

listAvailableVersions(request: protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest, protos.google.cloud.datafusion.v1.IListAvailableVersionsResponse | null | undefined, protos.google.cloud.datafusion.v1.IVersion>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest, protos.google.cloud.datafusion.v1.IListAvailableVersionsResponse | null | undefined, protos.google.cloud.datafusion.v1.IVersion>
Returns
TypeDescription
void

listAvailableVersions(request, callback)

listAvailableVersions(request: protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest, callback: PaginationCallback<protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest, protos.google.cloud.datafusion.v1.IListAvailableVersionsResponse | null | undefined, protos.google.cloud.datafusion.v1.IVersion>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest
callback PaginationCallback<protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest, protos.google.cloud.datafusion.v1.IListAvailableVersionsResponse | null | undefined, protos.google.cloud.datafusion.v1.IVersion>
Returns
TypeDescription
void

listAvailableVersionsAsync(request, options)

listAvailableVersionsAsync(request?: protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datafusion.v1.IVersion>;

Equivalent to listAvailableVersions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.datafusion.v1.IVersion>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Version]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project and location for which to retrieve instance
   *  information in the format projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value to use if there are additional
   *  results to retrieve for this list request.
   */
  // const pageToken = 'abc123'
  /**
   *  Whether or not to return the latest patch of every available minor version.
   *  If true, only the latest patch will be returned. Ex. if allowed versions is
   *  [6.1.1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0]
   */
  // const latestPatchOnly = true

  // Imports the Datafusion library
  // eslint-disable-next-line node/no-missing-require
  const {DataFusionClient} = require('@google-cloud/data-fusion');

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

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

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

  listAvailableVersions();

listAvailableVersionsStream(request, options)

listAvailableVersionsStream(request?: protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListAvailableVersionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Version] 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 listAvailableVersionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listInstances(request, options)

listInstances(request?: protos.google.cloud.datafusion.v1.IListInstancesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.datafusion.v1.IInstance[],
        protos.google.cloud.datafusion.v1.IListInstancesRequest | null,
        protos.google.cloud.datafusion.v1.IListInstancesResponse
    ]>;

Lists Data Fusion instances in the specified project and location.

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListInstancesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.datafusion.v1.IInstance[], protos.google.cloud.datafusion.v1.IListInstancesRequest | null, protos.google.cloud.datafusion.v1.IListInstancesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Instance]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInstancesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listInstances(request, options, callback)

listInstances(request: protos.google.cloud.datafusion.v1.IListInstancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datafusion.v1.IListInstancesRequest, protos.google.cloud.datafusion.v1.IListInstancesResponse | null | undefined, protos.google.cloud.datafusion.v1.IInstance>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListInstancesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.datafusion.v1.IListInstancesRequest, protos.google.cloud.datafusion.v1.IListInstancesResponse | null | undefined, protos.google.cloud.datafusion.v1.IInstance>
Returns
TypeDescription
void

listInstances(request, callback)

listInstances(request: protos.google.cloud.datafusion.v1.IListInstancesRequest, callback: PaginationCallback<protos.google.cloud.datafusion.v1.IListInstancesRequest, protos.google.cloud.datafusion.v1.IListInstancesResponse | null | undefined, protos.google.cloud.datafusion.v1.IInstance>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListInstancesRequest
callback PaginationCallback<protos.google.cloud.datafusion.v1.IListInstancesRequest, protos.google.cloud.datafusion.v1.IListInstancesResponse | null | undefined, protos.google.cloud.datafusion.v1.IInstance>
Returns
TypeDescription
void

listInstancesAsync(request, options)

listInstancesAsync(request?: protos.google.cloud.datafusion.v1.IListInstancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datafusion.v1.IInstance>;

Equivalent to listInstances, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListInstancesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.datafusion.v1.IInstance>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Instance]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project and location for which to retrieve instance information
   *  in the format projects/{project}/locations/{location}. If the location is
   *  specified as '-' (wildcard), then all regions available to the project
   *  are queried, and the results are aggregated.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value to use if there are additional
   *  results to retrieve for this list request.
   */
  // const pageToken = 'abc123'
  /**
   *  List filter.
   */
  // const filter = 'abc123'
  /**
   *  Sort results. Supported values are "name", "name desc",  or "" (unsorted).
   */
  // const orderBy = 'abc123'

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

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

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

  callListInstances();

listInstancesStream(request, options)

listInstancesStream(request?: protos.google.cloud.datafusion.v1.IListInstancesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IListInstancesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Instance] 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 listInstancesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchCryptoKeyFromCryptoKeyName(cryptoKeyName)

matchCryptoKeyFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the crypto_key from CryptoKey resource.

Parameter
NameDescription
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
TypeDescription
string | number

{string} A string representing the crypto_key.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter
NameDescription
instanceName string

A fully-qualified path representing Instance resource.

Returns
TypeDescription
string | number

{string} A string representing the instance.

matchKeyRingFromCryptoKeyName(cryptoKeyName)

matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the key_ring from CryptoKey resource.

Parameter
NameDescription
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
TypeDescription
string | number

{string} A string representing the key_ring.

matchLocationFromCryptoKeyName(cryptoKeyName)

matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the location from CryptoKey resource.

Parameter
NameDescription
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromInstanceName(instanceName)

matchLocationFromInstanceName(instanceName: string): string | number;

Parse the location from Instance resource.

Parameter
NameDescription
instanceName string

A fully-qualified path representing Instance resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromCryptoKeyName(cryptoKeyName)

matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the project from CryptoKey resource.

Parameter
NameDescription
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

Parse the project from Instance resource.

Parameter
NameDescription
instanceName string

A fully-qualified path representing Instance resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

restartInstance(request, options)

restartInstance(request?: protos.google.cloud.datafusion.v1.IRestartInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IRestartInstanceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the Data Fusion instance which need to be restarted in the form of
   *  projects/{project}/locations/{location}/instances/{instance}
   */
  // const name = 'abc123'

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

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

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

  callRestartInstance();

restartInstance(request, options, callback)

restartInstance(request: protos.google.cloud.datafusion.v1.IRestartInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IRestartInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

restartInstance(request, callback)

restartInstance(request: protos.google.cloud.datafusion.v1.IRestartInstanceRequest, callback: Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IRestartInstanceRequest
callback Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateInstance(request, options)

updateInstance(request?: protos.google.cloud.datafusion.v1.IUpdateInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a single Data Fusion instance.

Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IUpdateInstanceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The instance resource that replaces the resource on the server. Currently,
   *  Data Fusion only allows replacing labels, options, and stack driver
   *  settings. All other fields will be ignored.
   */
  // const instance = {}
  /**
   *  Field mask is used to specify the fields that the update will overwrite
   *  in an instance resource. The fields specified in the update_mask are
   *  relative to the resource, not the full request.
   *  A field will be overwritten if it is in the mask.
   *  If the user does not provide a mask, all the supported fields (labels,
   *  options, and version currently) will be overwritten.
   */
  // const updateMask = {}

  // Imports the Datafusion library
  const {DataFusionClient} = require('@google-cloud/data-fusion').v1;

  // Instantiates a client
  const datafusionClient = new DataFusionClient();

  async function callUpdateInstance() {
    // Construct request
    const request = {
      instance,
    };

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

  callUpdateInstance();

updateInstance(request, options, callback)

updateInstance(request: protos.google.cloud.datafusion.v1.IUpdateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IUpdateInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateInstance(request, callback)

updateInstance(request: protos.google.cloud.datafusion.v1.IUpdateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.datafusion.v1.IUpdateInstanceRequest
callback Callback<LROperation<protos.google.cloud.datafusion.v1.IInstance, protos.google.cloud.datafusion.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void