Class v1.DataTransferServiceClient (4.6.0)

DataTransferService is the service for the Data Transfer API. v1

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of DataTransferServiceClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof fallback` : 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 DataTransferServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

dataTransferServiceStub

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

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

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.

universeDomain

get universeDomain(): string;

warn

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

Methods

cancelOperation(request, optionsOrCallback, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

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 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 value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`request`	`CancelOperationRequest` The request object that will be sent.
`optionsOrCallback`	`CallOptions \| Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} \| undefined \| null>`
`callback`	`Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} \| undefined \| null>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateDestinationProgress(name)

checkCreateDestinationProgress(name: string): Promise<LROperation<protos.google.cloud.networkconnectivity.v1.Destination, protos.google.cloud.networkconnectivity.v1.OperationMetadata>>;

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

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.networkconnectivity.v1.Destination, protos.google.cloud.networkconnectivity.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 for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the `Destination` resource, which becomes the
   *  final component of the `Destination` resource name.
   */
  // const destinationId = 'abc123'
  /**
   *  Required. The `Destination` resource to create.
   */
  // const destination = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request. This prevents
   *  clients from accidentally creating duplicate `Destination`
   *  resources.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

  async function callCreateDestination() {
    // Construct request
    const request = {
      parent,
      destinationId,
      destination,
    };

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

  callCreateDestination();

checkCreateMulticloudDataTransferConfigProgress(name)

checkCreateMulticloudDataTransferConfigProgress(name: string): Promise<LROperation<protos.google.cloud.networkconnectivity.v1.MulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.OperationMetadata>>;

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

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.networkconnectivity.v1.MulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.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 for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the `MulticloudDataTransferConfig` resource,
   *  which becomes the final component of the `MulticloudDataTransferConfig`
   *  resource name.
   */
  // const multicloudDataTransferConfigId = 'abc123'
  /**
   *  Required. The `MulticloudDataTransferConfig` resource to create.
   */
  // const multicloudDataTransferConfig = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request. This prevents
   *  clients from accidentally creating duplicate `MulticloudDataTransferConfig`
   *  resources.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

  async function callCreateMulticloudDataTransferConfig() {
    // Construct request
    const request = {
      parent,
      multicloudDataTransferConfigId,
      multicloudDataTransferConfig,
    };

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

  callCreateMulticloudDataTransferConfig();

checkDeleteDestinationProgress(name)

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

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

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkconnectivity.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 for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the `Destination` resource to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'
  /**
   *  Optional. The etag is computed by the server, and might be sent with update
   *  and delete requests so that the client has an up-to-date value before
   *  proceeding.
   */
  // const etag = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

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

  callDeleteDestination();

checkDeleteMulticloudDataTransferConfigProgress(name)

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

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

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkconnectivity.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 for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the `MulticloudDataTransferConfig` resource to
   *  delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request. This prevents
   *  clients from accidentally creating duplicate `MulticloudDataTransferConfig`
   *  resources.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'
  /**
   *  Optional. The etag is computed by the server, and might be sent with update
   *  and delete requests so that the client has an up-to-date value before
   *  proceeding.
   */
  // const etag = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

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

  callDeleteMulticloudDataTransferConfig();

checkUpdateDestinationProgress(name)

checkUpdateDestinationProgress(name: string): Promise<LROperation<protos.google.cloud.networkconnectivity.v1.Destination, protos.google.cloud.networkconnectivity.v1.OperationMetadata>>;

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

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.networkconnectivity.v1.Destination, protos.google.cloud.networkconnectivity.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 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.
   */
  /**
   *  Optional. `FieldMask is used to specify the fields to be overwritten in the
   *  `Destination` resource by the update.
   *  The fields specified in `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If you
   *  don't specify a mask, all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The `Destination` resource to update.
   */
  // const destination = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

  async function callUpdateDestination() {
    // Construct request
    const request = {
      destination,
    };

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

  callUpdateDestination();

checkUpdateMulticloudDataTransferConfigProgress(name)

checkUpdateMulticloudDataTransferConfigProgress(name: string): Promise<LROperation<protos.google.cloud.networkconnectivity.v1.MulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.OperationMetadata>>;

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

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.networkconnectivity.v1.MulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.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 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.
   */
  /**
   *  Optional. `FieldMask` is used to specify the fields in the
   *  `MulticloudDataTransferConfig` resource to be overwritten by the update.
   *  The fields specified in `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If you
   *  don't specify a mask, all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The `MulticloudDataTransferConfig` resource to update.
   */
  // const multicloudDataTransferConfig = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request. This prevents
   *  clients from accidentally creating duplicate `MulticloudDataTransferConfig`
   *  resources.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

  async function callUpdateMulticloudDataTransferConfig() {
    // Construct request
    const request = {
      multicloudDataTransferConfig,
    };

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

  callUpdateMulticloudDataTransferConfig();

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
Type	Description
`Promise<void>`	{Promise} A promise that resolves when the client is closed.

createDestination(request, options)

createDestination(request?: protos.google.cloud.networkconnectivity.v1.ICreateDestinationRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a Destination resource in a specified project and location.

Parameters
Name	Description
`request`	`ICreateDestinationRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.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 for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the `Destination` resource, which becomes the
   *  final component of the `Destination` resource name.
   */
  // const destinationId = 'abc123'
  /**
   *  Required. The `Destination` resource to create.
   */
  // const destination = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request. This prevents
   *  clients from accidentally creating duplicate `Destination`
   *  resources.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

  async function callCreateDestination() {
    // Construct request
    const request = {
      parent,
      destinationId,
      destination,
    };

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

  callCreateDestination();

createDestination(request, options, callback)

createDestination(request: protos.google.cloud.networkconnectivity.v1.ICreateDestinationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateDestinationRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createDestination(request, callback)

createDestination(request: protos.google.cloud.networkconnectivity.v1.ICreateDestinationRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateDestinationRequest`
`callback`	`Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createMulticloudDataTransferConfig(request, options)

createMulticloudDataTransferConfig(request?: protos.google.cloud.networkconnectivity.v1.ICreateMulticloudDataTransferConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a MulticloudDataTransferConfig resource in a specified project and location.

Parameters
Name	Description
`request`	`ICreateMulticloudDataTransferConfigRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.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 for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID to use for the `MulticloudDataTransferConfig` resource,
   *  which becomes the final component of the `MulticloudDataTransferConfig`
   *  resource name.
   */
  // const multicloudDataTransferConfigId = 'abc123'
  /**
   *  Required. The `MulticloudDataTransferConfig` resource to create.
   */
  // const multicloudDataTransferConfig = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request. This prevents
   *  clients from accidentally creating duplicate `MulticloudDataTransferConfig`
   *  resources.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

  async function callCreateMulticloudDataTransferConfig() {
    // Construct request
    const request = {
      parent,
      multicloudDataTransferConfigId,
      multicloudDataTransferConfig,
    };

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

  callCreateMulticloudDataTransferConfig();

createMulticloudDataTransferConfig(request, options, callback)

createMulticloudDataTransferConfig(request: protos.google.cloud.networkconnectivity.v1.ICreateMulticloudDataTransferConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateMulticloudDataTransferConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createMulticloudDataTransferConfig(request, callback)

createMulticloudDataTransferConfig(request: protos.google.cloud.networkconnectivity.v1.ICreateMulticloudDataTransferConfigRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateMulticloudDataTransferConfigRequest`
`callback`	`Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteDestination(request, options)

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

Deletes a Destination resource.

Parameters
Name	Description
`request`	`IDeleteDestinationRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.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 for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the `Destination` resource to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'
  /**
   *  Optional. The etag is computed by the server, and might be sent with update
   *  and delete requests so that the client has an up-to-date value before
   *  proceeding.
   */
  // const etag = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

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

  callDeleteDestination();

deleteDestination(request, options, callback)

deleteDestination(request: protos.google.cloud.networkconnectivity.v1.IDeleteDestinationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteDestinationRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteDestination(request, callback)

deleteDestination(request: protos.google.cloud.networkconnectivity.v1.IDeleteDestinationRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteDestinationRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteMulticloudDataTransferConfig(request, options)

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

Deletes a MulticloudDataTransferConfig resource.

Parameters
Name	Description
`request`	`IDeleteMulticloudDataTransferConfigRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.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 for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the `MulticloudDataTransferConfig` resource to
   *  delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request. This prevents
   *  clients from accidentally creating duplicate `MulticloudDataTransferConfig`
   *  resources.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'
  /**
   *  Optional. The etag is computed by the server, and might be sent with update
   *  and delete requests so that the client has an up-to-date value before
   *  proceeding.
   */
  // const etag = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

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

  callDeleteMulticloudDataTransferConfig();

deleteMulticloudDataTransferConfig(request, options, callback)

deleteMulticloudDataTransferConfig(request: protos.google.cloud.networkconnectivity.v1.IDeleteMulticloudDataTransferConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteMulticloudDataTransferConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteMulticloudDataTransferConfig(request, callback)

deleteMulticloudDataTransferConfig(request: protos.google.cloud.networkconnectivity.v1.IDeleteMulticloudDataTransferConfigRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteMulticloudDataTransferConfigRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteOperation(request, optionsOrCallback, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

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	Description
`request`	`DeleteOperationRequest` The request object that will be sent.
`optionsOrCallback`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>`
`callback`	`Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

destinationPath(project, location, multicloudDataTransferConfig, destination)

destinationPath(project: string, location: string, multicloudDataTransferConfig: string, destination: string): string;

Return a fully-qualified destination resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`multicloudDataTransferConfig`	`string`
`destination`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

getDestination(request, options)

getDestination(request?: protos.google.cloud.networkconnectivity.v1.IGetDestinationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkconnectivity.v1.IDestination,
        protos.google.cloud.networkconnectivity.v1.IGetDestinationRequest | undefined,
        {} | undefined
    ]>;

Gets the details of a Destination resource.

Parameters
Name	Description
`request`	`IGetDestinationRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IGetDestinationRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the `Destination` resource to get.
   */
  // const name = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

    // Run request
    const response = await networkconnectivityClient.getDestination(request);
    console.log(response);
  }

  callGetDestination();

getDestination(request, options, callback)

getDestination(request: protos.google.cloud.networkconnectivity.v1.IGetDestinationRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IGetDestinationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetDestinationRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IGetDestinationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getDestination(request, callback)

getDestination(request: protos.google.cloud.networkconnectivity.v1.IGetDestinationRequest, callback: Callback<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IGetDestinationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetDestinationRequest`
`callback`	`Callback<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IGetDestinationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

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

Parameters
Name	Description
`request`	`IamProtos.google.iam.v1.GetIamPolicyRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
`Promise<[google.iam.v1.Policy]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IGetLocationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>` Call options. See CallOptions for more details.
`callback`	`Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`Promise<google.cloud.location.ILocation>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


const [response] = await client.getLocation(request);

getMulticloudDataTransferConfig(request, options)

getMulticloudDataTransferConfig(request?: protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig,
        protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferConfigRequest | undefined,
        {} | undefined
    ]>;

Gets the details of a MulticloudDataTransferConfig resource.

Parameters
Name	Description
`request`	`IGetMulticloudDataTransferConfigRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferConfigRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing MulticloudDataTransferConfig. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the `MulticloudDataTransferConfig` resource to get.
   */
  // const name = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

    // Run request
    const response = await networkconnectivityClient.getMulticloudDataTransferConfig(request);
    console.log(response);
  }

  callGetMulticloudDataTransferConfig();

getMulticloudDataTransferConfig(request, options, callback)

getMulticloudDataTransferConfig(request: protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetMulticloudDataTransferConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getMulticloudDataTransferConfig(request, callback)

getMulticloudDataTransferConfig(request: protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferConfigRequest, callback: Callback<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetMulticloudDataTransferConfigRequest`
`callback`	`Callback<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getMulticloudDataTransferSupportedService(request, options)

getMulticloudDataTransferSupportedService(request?: protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferSupportedServiceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService,
        protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferSupportedServiceRequest | undefined,
        {} | undefined
    ]>;

Gets the details of a service that is supported for Data Transfer Essentials.

Parameters
Name	Description
`request`	`IGetMulticloudDataTransferSupportedServiceRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferSupportedServiceRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing MulticloudDataTransferSupportedService. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the service.
   */
  // const name = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

    // Run request
    const response = await networkconnectivityClient.getMulticloudDataTransferSupportedService(request);
    console.log(response);
  }

  callGetMulticloudDataTransferSupportedService();

getMulticloudDataTransferSupportedService(request, options, callback)

getMulticloudDataTransferSupportedService(request: protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferSupportedServiceRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferSupportedServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetMulticloudDataTransferSupportedServiceRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferSupportedServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getMulticloudDataTransferSupportedService(request, callback)

getMulticloudDataTransferSupportedService(request: protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferSupportedServiceRequest, callback: Callback<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferSupportedServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetMulticloudDataTransferSupportedServiceRequest`
`callback`	`Callback<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService, protos.google.cloud.networkconnectivity.v1.IGetMulticloudDataTransferSupportedServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getOperation(request, optionsOrCallback, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

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	Description
`request`	`GetOperationRequest` The request object that will be sent.
`optionsOrCallback`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>`
`callback`	`Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<[protos.google.longrunning.Operation]>`

Example


const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
`Promise<string>`

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
`callback`	`Callback<string, undefined, undefined>`

Returns
Type	Description
`void`

groupPath(project, hub, group)

groupPath(project: string, hub: string, group: string): string;

Return a fully-qualified group resource name string.

Parameters
Name	Description
`project`	`string`
`hub`	`string`
`group`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

hubPath(project, hub)

hubPath(project: string, hub: string): string;

Return a fully-qualified hub resource name string.

Parameters
Name	Description
`project`	`string`
`hub`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

hubRoutePath(project, hub, routeTable, route)

hubRoutePath(project: string, hub: string, routeTable: string, route: string): string;

Return a fully-qualified hubRoute resource name string.

Parameters
Name	Description
`project`	`string`
`hub`	`string`
`routeTable`	`string`
`route`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

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
Type	Description
`Promise<{ [name: string]: Function; }>`	{Promise} A promise that resolves to an authenticated service stub.

internalRangePath(project, location, internalRange)

internalRangePath(project: string, location: string, internalRange: string): string;

Return a fully-qualified internalRange resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`internalRange`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

listDestinations(request, options)

listDestinations(request?: protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkconnectivity.v1.IDestination[],
        protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest | null,
        protos.google.cloud.networkconnectivity.v1.IListDestinationsResponse
    ]>;

Lists the Destination resources in a specified project and location.

Parameters
Name	Description
`request`	`IListDestinationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.networkconnectivity.v1.IDestination[],
        protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest | null,
        protos.google.cloud.networkconnectivity.v1.IListDestinationsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listDestinationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDestinations(request, options, callback)

listDestinations(request: protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest, protos.google.cloud.networkconnectivity.v1.IListDestinationsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IDestination>): void;

Parameters
Name	Description
`request`	`IListDestinationsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest, protos.google.cloud.networkconnectivity.v1.IListDestinationsResponse \| null \| undefined, protos.google.cloud.networkconnectivity.v1.IDestination>`

Returns
Type	Description
`void`

listDestinations(request, callback)

listDestinations(request: protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest, protos.google.cloud.networkconnectivity.v1.IListDestinationsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IDestination>): void;

Parameters
Name	Description
`request`	`IListDestinationsRequest`
`callback`	`PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest, protos.google.cloud.networkconnectivity.v1.IListDestinationsResponse \| null \| undefined, protos.google.cloud.networkconnectivity.v1.IDestination>`

Returns
Type	Description
`void`

listDestinationsAsync(request, options)

listDestinationsAsync(request?: protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkconnectivity.v1.IDestination>;

Equivalent to listDestinations, but returns an iterable object.

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

Parameters
Name	Description
`request`	`IListDestinationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<protos.google.cloud.networkconnectivity.v1.IDestination>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 name of the parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of results listed per page.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. An expression that filters the results listed in the response.
   */
  // const filter = 'abc123'
  /**
   *  Optional. The sort order of the results.
   */
  // const orderBy = 'abc123'
  /**
   *  Optional. If `true`, allow partial responses for multi-regional aggregated
   *  list requests.
   */
  // const returnPartialSuccess = true

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

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

  callListDestinations();

listDestinationsStream(request, options)

listDestinationsStream(request?: protos.google.cloud.networkconnectivity.v1.IListDestinationsRequest, options?: CallOptions): Transform;

Equivalent to listDestinations, but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`IListDestinationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Transform`	{Stream} An object stream which emits an object representing 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 `listDestinationsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

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	Description
`request`	`LocationProtos.google.cloud.location.IListLocationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<google.cloud.location.ILocation>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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
}

listMulticloudDataTransferConfigs(request, options)

listMulticloudDataTransferConfigs(request?: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig[],
        protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest | null,
        protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsResponse
    ]>;

Lists the MulticloudDataTransferConfig resources in a specified project and location.

Parameters
Name	Description
`request`	`IListMulticloudDataTransferConfigsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig[],
        protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest | null,
        protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of MulticloudDataTransferConfig. 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 listMulticloudDataTransferConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMulticloudDataTransferConfigs(request, options, callback)

listMulticloudDataTransferConfigs(request: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest, protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig>): void;

Parameters
Name	Description
`request`	`IListMulticloudDataTransferConfigsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest, protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsResponse \| null \| undefined, protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig>`

Returns
Type	Description
`void`

listMulticloudDataTransferConfigs(request, callback)

listMulticloudDataTransferConfigs(request: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest, protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig>): void;

Parameters
Name	Description
`request`	`IListMulticloudDataTransferConfigsRequest`
`callback`	`PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest, protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsResponse \| null \| undefined, protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig>`

Returns
Type	Description
`void`

listMulticloudDataTransferConfigsAsync(request, options)

listMulticloudDataTransferConfigsAsync(request?: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig>;

Equivalent to listMulticloudDataTransferConfigs, but returns an iterable object.

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

Parameters
Name	Description
`request`	`IListMulticloudDataTransferConfigsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing MulticloudDataTransferConfig. 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 name of the parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of results listed per page.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. An expression that filters the results listed in the response.
   */
  // const filter = 'abc123'
  /**
   *  Optional. The sort order of the results.
   */
  // const orderBy = 'abc123'
  /**
   *  Optional. If `true`, allows partial responses for multi-regional aggregated
   *  list requests.
   */
  // const returnPartialSuccess = true

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

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

  callListMulticloudDataTransferConfigs();

listMulticloudDataTransferConfigsStream(request, options)

listMulticloudDataTransferConfigsStream(request?: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferConfigsRequest, options?: CallOptions): Transform;

Equivalent to listMulticloudDataTransferConfigs, but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`IListMulticloudDataTransferConfigsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

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

listMulticloudDataTransferSupportedServices(request, options)

listMulticloudDataTransferSupportedServices(request?: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService[],
        protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest | null,
        protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesResponse
    ]>;

Lists the services in the project for a region that are supported for Data Transfer Essentials.

Parameters
Name	Description
`request`	`IListMulticloudDataTransferSupportedServicesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService[],
        protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest | null,
        protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of MulticloudDataTransferSupportedService. 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 listMulticloudDataTransferSupportedServicesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMulticloudDataTransferSupportedServices(request, options, callback)

listMulticloudDataTransferSupportedServices(request: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest, protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService>): void;

Parameters
Name	Description
`request`	`IListMulticloudDataTransferSupportedServicesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest, protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesResponse \| null \| undefined, protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService>`

Returns
Type	Description
`void`

listMulticloudDataTransferSupportedServices(request, callback)

listMulticloudDataTransferSupportedServices(request: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest, protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService>): void;

Parameters
Name	Description
`request`	`IListMulticloudDataTransferSupportedServicesRequest`
`callback`	`PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest, protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesResponse \| null \| undefined, protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService>`

Returns
Type	Description
`void`

listMulticloudDataTransferSupportedServicesAsync(request, options)

listMulticloudDataTransferSupportedServicesAsync(request?: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService>;

Equivalent to listMulticloudDataTransferSupportedServices, but returns an iterable object.

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

Parameters
Name	Description
`request`	`IListMulticloudDataTransferSupportedServicesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferSupportedService>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing MulticloudDataTransferSupportedService. 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 name of the parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of results listed per page.
   */
  // const pageSize = 1234
  /**
   *  Optional. The page token.
   */
  // const pageToken = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

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

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

  callListMulticloudDataTransferSupportedServices();

listMulticloudDataTransferSupportedServicesStream(request, options)

listMulticloudDataTransferSupportedServicesStream(request?: protos.google.cloud.networkconnectivity.v1.IListMulticloudDataTransferSupportedServicesRequest, options?: CallOptions): Transform;

Equivalent to listMulticloudDataTransferSupportedServices, but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`IListMulticloudDataTransferSupportedServicesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

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

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;

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	Description
`request`	`ListOperationsRequest` The request object that will be sent.
`options`	`CallOptions` 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
`AsyncIterable<protos.google.longrunning.IOperation>`	{Object} An iterable Object that conforms to iteration protocols.

Example


const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

matchDestinationFromDestinationName(destinationName)

matchDestinationFromDestinationName(destinationName: string): string | number;

Parse the destination from Destination resource.

Parameter
Name	Description
`destinationName`	`string` A fully-qualified path representing Destination resource.

Returns
Type	Description
`string \| number`	{string} A string representing the destination.

matchGroupFromGroupName(groupName)

matchGroupFromGroupName(groupName: string): string | number;

Parse the group from Group resource.

Parameter
Name	Description
`groupName`	`string` A fully-qualified path representing Group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the group.

matchHubFromGroupName(groupName)

matchHubFromGroupName(groupName: string): string | number;

Parse the hub from Group resource.

Parameter
Name	Description
`groupName`	`string` A fully-qualified path representing Group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the hub.

matchHubFromHubName(hubName)

matchHubFromHubName(hubName: string): string | number;

Parse the hub from Hub resource.

Parameter
Name	Description
`hubName`	`string` A fully-qualified path representing Hub resource.

Returns
Type	Description
`string \| number`	{string} A string representing the hub.

matchHubFromHubRouteName(hubRouteName)

matchHubFromHubRouteName(hubRouteName: string): string | number;

Parse the hub from HubRoute resource.

Parameter
Name	Description
`hubRouteName`	`string` A fully-qualified path representing HubRoute resource.

Returns
Type	Description
`string \| number`	{string} A string representing the hub.

matchHubFromRouteTableName(routeTableName)

matchHubFromRouteTableName(routeTableName: string): string | number;

Parse the hub from RouteTable resource.

Parameter
Name	Description
`routeTableName`	`string` A fully-qualified path representing RouteTable resource.

Returns
Type	Description
`string \| number`	{string} A string representing the hub.

matchInternalRangeFromInternalRangeName(internalRangeName)

matchInternalRangeFromInternalRangeName(internalRangeName: string): string | number;

Parse the internal_range from InternalRange resource.

Parameter
Name	Description
`internalRangeName`	`string` A fully-qualified path representing InternalRange resource.

Returns
Type	Description
`string \| number`	{string} A string representing the internal_range.

matchLocationFromDestinationName(destinationName)

matchLocationFromDestinationName(destinationName: string): string | number;

Parse the location from Destination resource.

Parameter
Name	Description
`destinationName`	`string` A fully-qualified path representing Destination resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromInternalRangeName(internalRangeName)

matchLocationFromInternalRangeName(internalRangeName: string): string | number;

Parse the location from InternalRange resource.

Parameter
Name	Description
`internalRangeName`	`string` A fully-qualified path representing InternalRange resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromMulticloudDataTransferConfigName(multicloudDataTransferConfigName)

matchLocationFromMulticloudDataTransferConfigName(multicloudDataTransferConfigName: string): string | number;

Parse the location from MulticloudDataTransferConfig resource.

Parameter
Name	Description
`multicloudDataTransferConfigName`	`string` A fully-qualified path representing MulticloudDataTransferConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromMulticloudDataTransferSupportedServiceName(multicloudDataTransferSupportedServiceName)

matchLocationFromMulticloudDataTransferSupportedServiceName(multicloudDataTransferSupportedServiceName: string): string | number;

Parse the location from MulticloudDataTransferSupportedService resource.

Parameter
Name	Description
`multicloudDataTransferSupportedServiceName`	`string` A fully-qualified path representing MulticloudDataTransferSupportedService resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromServiceClassName(serviceClassName)

matchLocationFromServiceClassName(serviceClassName: string): string | number;

Parse the location from ServiceClass resource.

Parameter
Name	Description
`serviceClassName`	`string` A fully-qualified path representing ServiceClass resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromServiceConnectionMapName(serviceConnectionMapName)

matchLocationFromServiceConnectionMapName(serviceConnectionMapName: string): string | number;

Parse the location from ServiceConnectionMap resource.

Parameter
Name	Description
`serviceConnectionMapName`	`string` A fully-qualified path representing ServiceConnectionMap resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromServiceConnectionPolicyName(serviceConnectionPolicyName)

matchLocationFromServiceConnectionPolicyName(serviceConnectionPolicyName: string): string | number;

Parse the location from ServiceConnectionPolicy resource.

Parameter
Name	Description
`serviceConnectionPolicyName`	`string` A fully-qualified path representing ServiceConnectionPolicy resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromServiceConnectionTokenName(serviceConnectionTokenName)

matchLocationFromServiceConnectionTokenName(serviceConnectionTokenName: string): string | number;

Parse the location from ServiceConnectionToken resource.

Parameter
Name	Description
`serviceConnectionTokenName`	`string` A fully-qualified path representing ServiceConnectionToken resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromSpokeName(spokeName)

matchLocationFromSpokeName(spokeName: string): string | number;

Parse the location from Spoke resource.

Parameter
Name	Description
`spokeName`	`string` A fully-qualified path representing Spoke resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchMulticloudDataTransferConfigFromDestinationName(destinationName)

matchMulticloudDataTransferConfigFromDestinationName(destinationName: string): string | number;

Parse the multicloud_data_transfer_config from Destination resource.

Parameter
Name	Description
`destinationName`	`string` A fully-qualified path representing Destination resource.

Returns
Type	Description
`string \| number`	{string} A string representing the multicloud_data_transfer_config.

matchMulticloudDataTransferConfigFromMulticloudDataTransferConfigName(multicloudDataTransferConfigName)

matchMulticloudDataTransferConfigFromMulticloudDataTransferConfigName(multicloudDataTransferConfigName: string): string | number;

Parse the multicloud_data_transfer_config from MulticloudDataTransferConfig resource.

Parameter
Name	Description
`multicloudDataTransferConfigName`	`string` A fully-qualified path representing MulticloudDataTransferConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the multicloud_data_transfer_config.

matchMulticloudDataTransferSupportedServiceFromMulticloudDataTransferSupportedServiceName(multicloudDataTransferSupportedServiceName)

matchMulticloudDataTransferSupportedServiceFromMulticloudDataTransferSupportedServiceName(multicloudDataTransferSupportedServiceName: string): string | number;

Parse the multicloud_data_transfer_supported_service from MulticloudDataTransferSupportedService resource.

Parameter
Name	Description
`multicloudDataTransferSupportedServiceName`	`string` A fully-qualified path representing MulticloudDataTransferSupportedService resource.

Returns
Type	Description
`string \| number`	{string} A string representing the multicloud_data_transfer_supported_service.

matchPolicyBasedRouteFromPolicyBasedRouteName(policyBasedRouteName)

matchPolicyBasedRouteFromPolicyBasedRouteName(policyBasedRouteName: string): string | number;

Parse the policy_based_route from PolicyBasedRoute resource.

Parameter
Name	Description
`policyBasedRouteName`	`string` A fully-qualified path representing PolicyBasedRoute resource.

Returns
Type	Description
`string \| number`	{string} A string representing the policy_based_route.

matchProjectFromDestinationName(destinationName)

matchProjectFromDestinationName(destinationName: string): string | number;

Parse the project from Destination resource.

Parameter
Name	Description
`destinationName`	`string` A fully-qualified path representing Destination resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromGroupName(groupName)

matchProjectFromGroupName(groupName: string): string | number;

Parse the project from Group resource.

Parameter
Name	Description
`groupName`	`string` A fully-qualified path representing Group resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromHubName(hubName)

matchProjectFromHubName(hubName: string): string | number;

Parse the project from Hub resource.

Parameter
Name	Description
`hubName`	`string` A fully-qualified path representing Hub resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromHubRouteName(hubRouteName)

matchProjectFromHubRouteName(hubRouteName: string): string | number;

Parse the project from HubRoute resource.

Parameter
Name	Description
`hubRouteName`	`string` A fully-qualified path representing HubRoute resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromInternalRangeName(internalRangeName)

matchProjectFromInternalRangeName(internalRangeName: string): string | number;

Parse the project from InternalRange resource.

Parameter
Name	Description
`internalRangeName`	`string` A fully-qualified path representing InternalRange resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromMulticloudDataTransferConfigName(multicloudDataTransferConfigName)

matchProjectFromMulticloudDataTransferConfigName(multicloudDataTransferConfigName: string): string | number;

Parse the project from MulticloudDataTransferConfig resource.

Parameter
Name	Description
`multicloudDataTransferConfigName`	`string` A fully-qualified path representing MulticloudDataTransferConfig resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromMulticloudDataTransferSupportedServiceName(multicloudDataTransferSupportedServiceName)

matchProjectFromMulticloudDataTransferSupportedServiceName(multicloudDataTransferSupportedServiceName: string): string | number;

Parse the project from MulticloudDataTransferSupportedService resource.

Parameter
Name	Description
`multicloudDataTransferSupportedServiceName`	`string` A fully-qualified path representing MulticloudDataTransferSupportedService resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromPolicyBasedRouteName(policyBasedRouteName)

matchProjectFromPolicyBasedRouteName(policyBasedRouteName: string): string | number;

Parse the project from PolicyBasedRoute resource.

Parameter
Name	Description
`policyBasedRouteName`	`string` A fully-qualified path representing PolicyBasedRoute resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromRouteTableName(routeTableName)

matchProjectFromRouteTableName(routeTableName: string): string | number;

Parse the project from RouteTable resource.

Parameter
Name	Description
`routeTableName`	`string` A fully-qualified path representing RouteTable resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromServiceClassName(serviceClassName)

matchProjectFromServiceClassName(serviceClassName: string): string | number;

Parse the project from ServiceClass resource.

Parameter
Name	Description
`serviceClassName`	`string` A fully-qualified path representing ServiceClass resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromServiceConnectionMapName(serviceConnectionMapName)

matchProjectFromServiceConnectionMapName(serviceConnectionMapName: string): string | number;

Parse the project from ServiceConnectionMap resource.

Parameter
Name	Description
`serviceConnectionMapName`	`string` A fully-qualified path representing ServiceConnectionMap resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromServiceConnectionPolicyName(serviceConnectionPolicyName)

matchProjectFromServiceConnectionPolicyName(serviceConnectionPolicyName: string): string | number;

Parse the project from ServiceConnectionPolicy resource.

Parameter
Name	Description
`serviceConnectionPolicyName`	`string` A fully-qualified path representing ServiceConnectionPolicy resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromServiceConnectionTokenName(serviceConnectionTokenName)

matchProjectFromServiceConnectionTokenName(serviceConnectionTokenName: string): string | number;

Parse the project from ServiceConnectionToken resource.

Parameter
Name	Description
`serviceConnectionTokenName`	`string` A fully-qualified path representing ServiceConnectionToken resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromSpokeName(spokeName)

matchProjectFromSpokeName(spokeName: string): string | number;

Parse the project from Spoke resource.

Parameter
Name	Description
`spokeName`	`string` A fully-qualified path representing Spoke resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchRouteFromHubRouteName(hubRouteName)

matchRouteFromHubRouteName(hubRouteName: string): string | number;

Parse the route from HubRoute resource.

Parameter
Name	Description
`hubRouteName`	`string` A fully-qualified path representing HubRoute resource.

Returns
Type	Description
`string \| number`	{string} A string representing the route.

matchRouteTableFromHubRouteName(hubRouteName)

matchRouteTableFromHubRouteName(hubRouteName: string): string | number;

Parse the route_table from HubRoute resource.

Parameter
Name	Description
`hubRouteName`	`string` A fully-qualified path representing HubRoute resource.

Returns
Type	Description
`string \| number`	{string} A string representing the route_table.

matchRouteTableFromRouteTableName(routeTableName)

matchRouteTableFromRouteTableName(routeTableName: string): string | number;

Parse the route_table from RouteTable resource.

Parameter
Name	Description
`routeTableName`	`string` A fully-qualified path representing RouteTable resource.

Returns
Type	Description
`string \| number`	{string} A string representing the route_table.

matchServiceClassFromServiceClassName(serviceClassName)

matchServiceClassFromServiceClassName(serviceClassName: string): string | number;

Parse the service_class from ServiceClass resource.

Parameter
Name	Description
`serviceClassName`	`string` A fully-qualified path representing ServiceClass resource.

Returns
Type	Description
`string \| number`	{string} A string representing the service_class.

matchServiceConnectionMapFromServiceConnectionMapName(serviceConnectionMapName)

matchServiceConnectionMapFromServiceConnectionMapName(serviceConnectionMapName: string): string | number;

Parse the service_connection_map from ServiceConnectionMap resource.

Parameter
Name	Description
`serviceConnectionMapName`	`string` A fully-qualified path representing ServiceConnectionMap resource.

Returns
Type	Description
`string \| number`	{string} A string representing the service_connection_map.

matchServiceConnectionPolicyFromServiceConnectionPolicyName(serviceConnectionPolicyName)

matchServiceConnectionPolicyFromServiceConnectionPolicyName(serviceConnectionPolicyName: string): string | number;

Parse the service_connection_policy from ServiceConnectionPolicy resource.

Parameter
Name	Description
`serviceConnectionPolicyName`	`string` A fully-qualified path representing ServiceConnectionPolicy resource.

Returns
Type	Description
`string \| number`	{string} A string representing the service_connection_policy.

matchServiceConnectionTokenFromServiceConnectionTokenName(serviceConnectionTokenName)

matchServiceConnectionTokenFromServiceConnectionTokenName(serviceConnectionTokenName: string): string | number;

Parse the service_connection_token from ServiceConnectionToken resource.

Parameter
Name	Description
`serviceConnectionTokenName`	`string` A fully-qualified path representing ServiceConnectionToken resource.

Returns
Type	Description
`string \| number`	{string} A string representing the service_connection_token.

matchSpokeFromSpokeName(spokeName)

matchSpokeFromSpokeName(spokeName: string): string | number;

Parse the spoke from Spoke resource.

Parameter
Name	Description
`spokeName`	`string` A fully-qualified path representing Spoke resource.

Returns
Type	Description
`string \| number`	{string} A string representing the spoke.

multicloudDataTransferConfigPath(project, location, multicloudDataTransferConfig)

multicloudDataTransferConfigPath(project: string, location: string, multicloudDataTransferConfig: string): string;

Return a fully-qualified multicloudDataTransferConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`multicloudDataTransferConfig`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

multicloudDataTransferSupportedServicePath(project, location, multicloudDataTransferSupportedService)

multicloudDataTransferSupportedServicePath(project: string, location: string, multicloudDataTransferSupportedService: string): string;

Return a fully-qualified multicloudDataTransferSupportedService resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`multicloudDataTransferSupportedService`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

policyBasedRoutePath(project, policyBasedRoute)

policyBasedRoutePath(project: string, policyBasedRoute: string): string;

Return a fully-qualified policyBasedRoute resource name string.

Parameters
Name	Description
`project`	`string`
`policyBasedRoute`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

routeTablePath(project, hub, routeTable)

routeTablePath(project: string, hub: string, routeTable: string): string;

Return a fully-qualified routeTable resource name string.

Parameters
Name	Description
`project`	`string`
`hub`	`string`
`routeTable`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

serviceClassPath(project, location, serviceClass)

serviceClassPath(project: string, location: string, serviceClass: string): string;

Return a fully-qualified serviceClass resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`serviceClass`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

serviceConnectionMapPath(project, location, serviceConnectionMap)

serviceConnectionMapPath(project: string, location: string, serviceConnectionMap: string): string;

Return a fully-qualified serviceConnectionMap resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`serviceConnectionMap`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

serviceConnectionPolicyPath(project, location, serviceConnectionPolicy)

serviceConnectionPolicyPath(project: string, location: string, serviceConnectionPolicy: string): string;

Return a fully-qualified serviceConnectionPolicy resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`serviceConnectionPolicy`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

serviceConnectionTokenPath(project, location, serviceConnectionToken)

serviceConnectionTokenPath(project: string, location: string, serviceConnectionToken: string): string;

Return a fully-qualified serviceConnectionToken resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`serviceConnectionToken`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`request`	`IamProtos.google.iam.v1.SetIamPolicyRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest \| null \| undefined, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
`Promise<[google.iam.v1.Policy]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

spokePath(project, location, spoke)

spokePath(project: string, location: string, spoke: string): string;

Return a fully-qualified spoke resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`spoke`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`request`	`IamProtos.google.iam.v1.TestIamPermissionsRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest \| null \| undefined, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
`Promise<[google.iam.v1.TestIamPermissionsResponse]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

updateDestination(request, options)

updateDestination(request?: protos.google.cloud.networkconnectivity.v1.IUpdateDestinationRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a Destination resource in a specified project and location.

Parameters
Name	Description
`request`	`IUpdateDestinationRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.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 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.
   */
  /**
   *  Optional. `FieldMask is used to specify the fields to be overwritten in the
   *  `Destination` resource by the update.
   *  The fields specified in `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If you
   *  don't specify a mask, all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The `Destination` resource to update.
   */
  // const destination = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

  async function callUpdateDestination() {
    // Construct request
    const request = {
      destination,
    };

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

  callUpdateDestination();

updateDestination(request, options, callback)

updateDestination(request: protos.google.cloud.networkconnectivity.v1.IUpdateDestinationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateDestinationRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateDestination(request, callback)

updateDestination(request: protos.google.cloud.networkconnectivity.v1.IUpdateDestinationRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateDestinationRequest`
`callback`	`Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IDestination, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateMulticloudDataTransferConfig(request, options)

updateMulticloudDataTransferConfig(request?: protos.google.cloud.networkconnectivity.v1.IUpdateMulticloudDataTransferConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a MulticloudDataTransferConfig resource in a specified project and location.

Parameters
Name	Description
`request`	`IUpdateMulticloudDataTransferConfigRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.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 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.
   */
  /**
   *  Optional. `FieldMask` is used to specify the fields in the
   *  `MulticloudDataTransferConfig` resource to be overwritten by the update.
   *  The fields specified in `update_mask` are relative to the resource, not
   *  the full request. A field is overwritten if it is in the mask. If you
   *  don't specify a mask, all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The `MulticloudDataTransferConfig` resource to update.
   */
  // const multicloudDataTransferConfig = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server can ignore
   *  the request if it has already been completed. The server waits
   *  for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, can ignore the second request. This prevents
   *  clients from accidentally creating duplicate `MulticloudDataTransferConfig`
   *  resources.
   *  The request ID must be a valid UUID with the exception that zero UUID
   *  (00000000-0000-0000-0000-000000000000) isn't supported.
   */
  // const requestId = 'abc123'

  // Imports the Networkconnectivity library
  const {DataTransferServiceClient} = require('@google-cloud/network-connectivity').v1;

  // Instantiates a client
  const networkconnectivityClient = new DataTransferServiceClient();

  async function callUpdateMulticloudDataTransferConfig() {
    // Construct request
    const request = {
      multicloudDataTransferConfig,
    };

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

  callUpdateMulticloudDataTransferConfig();

updateMulticloudDataTransferConfig(request, options, callback)

updateMulticloudDataTransferConfig(request: protos.google.cloud.networkconnectivity.v1.IUpdateMulticloudDataTransferConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateMulticloudDataTransferConfigRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateMulticloudDataTransferConfig(request, callback)

updateMulticloudDataTransferConfig(request: protos.google.cloud.networkconnectivity.v1.IUpdateMulticloudDataTransferConfigRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateMulticloudDataTransferConfigRequest`
`callback`	`Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

Class v1.DataTransferServiceClient (4.6.0) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(opts, gaxInstance)

Properties

apiEndpoint

apiEndpoint

auth

dataTransferServiceStub

descriptors

iamClient

innerApiCalls

locationsClient

operationsClient

pathTemplates

port

scopes

servicePath

universeDomain

warn

Methods

cancelOperation(request, optionsOrCallback, callback)

checkCreateDestinationProgress(name)

checkCreateMulticloudDataTransferConfigProgress(name)

checkDeleteDestinationProgress(name)

checkDeleteMulticloudDataTransferConfigProgress(name)

checkUpdateDestinationProgress(name)

checkUpdateMulticloudDataTransferConfigProgress(name)

close()

createDestination(request, options)

createDestination(request, options, callback)

createDestination(request, callback)

createMulticloudDataTransferConfig(request, options)

createMulticloudDataTransferConfig(request, options, callback)

createMulticloudDataTransferConfig(request, callback)

deleteDestination(request, options)

deleteDestination(request, options, callback)

deleteDestination(request, callback)

deleteMulticloudDataTransferConfig(request, options)

deleteMulticloudDataTransferConfig(request, options, callback)

deleteMulticloudDataTransferConfig(request, callback)

deleteOperation(request, optionsOrCallback, callback)

destinationPath(project, location, multicloudDataTransferConfig, destination)

getDestination(request, options)

getDestination(request, options, callback)

getDestination(request, callback)

getIamPolicy(request, options, callback)

getLocation(request, options, callback)

getMulticloudDataTransferConfig(request, options)

getMulticloudDataTransferConfig(request, options, callback)

getMulticloudDataTransferConfig(request, callback)

getMulticloudDataTransferSupportedService(request, options)

getMulticloudDataTransferSupportedService(request, options, callback)

getMulticloudDataTransferSupportedService(request, callback)

getOperation(request, optionsOrCallback, callback)

getProjectId()

getProjectId(callback)

groupPath(project, hub, group)

hubPath(project, hub)

hubRoutePath(project, hub, routeTable, route)

initialize()

internalRangePath(project, location, internalRange)

listDestinations(request, options)

listDestinations(request, options, callback)

listDestinations(request, callback)

listDestinationsAsync(request, options)

listDestinationsStream(request, options)

listLocationsAsync(request, options)

listMulticloudDataTransferConfigs(request, options)

listMulticloudDataTransferConfigs(request, options, callback)

listMulticloudDataTransferConfigs(request, callback)

listMulticloudDataTransferConfigsAsync(request, options)

listMulticloudDataTransferConfigsStream(request, options)

listMulticloudDataTransferSupportedServices(request, options)

listMulticloudDataTransferSupportedServices(request, options, callback)

listMulticloudDataTransferSupportedServices(request, callback)

listMulticloudDataTransferSupportedServicesAsync(request, options)

listMulticloudDataTransferSupportedServicesStream(request, options)

listOperationsAsync(request, options)

locationPath(project, location)

Class v1.DataTransferServiceClient (4.6.0)