Class v1.HubServiceClient

Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model. v1

Package

@google-cloud/network-connectivity

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of HubServiceClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

hubServiceStub

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

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

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

Methods

checkCreateHubProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.networkconnectivity.v1.Hub, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Required. A unique identifier for the hub.
   */
  // const hubId = 'abc123'
  /**
   *  Required. The initial values for a new hub.
   */
  // const hub = {}
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

  async function callCreateHub() {
    // Construct request
    const request = {
      parent,
      hubId,
      hub,
    };

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

  callCreateHub();

checkCreateSpokeProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.networkconnectivity.v1.Spoke, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Required. Unique id for the spoke to create.
   */
  // const spokeId = 'abc123'
  /**
   *  Required. The initial values for a new spoke.
   */
  // const spoke = {}
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

  async function callCreateSpoke() {
    // Construct request
    const request = {
      parent,
      spokeId,
      spoke,
    };

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

  callCreateSpoke();

checkDeleteHubProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the hub to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

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

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

  callDeleteHub();

checkDeleteSpokeProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the spoke to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

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

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

  callDeleteSpoke();

checkUpdateHubProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.networkconnectivity.v1.Hub, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. In the case of an update to an existing hub, field mask is used to specify
   *  the fields to be overwritten. The fields specified in the update_mask are
   *  relative to the resource, not the full request. A field is overwritten if
   *  it is in the mask. If the user does not provide a mask, then all fields are
   *  overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The state that the hub should be in after the update.
   */
  // const hub = {}
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

  async function callUpdateHub() {
    // Construct request
    const request = {
      hub,
    };

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

  callUpdateHub();

checkUpdateSpokeProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.networkconnectivity.v1.Spoke, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. In the case of an update to an existing spoke, field mask is used to
   *  specify the fields to be overwritten. The fields specified in the
   *  update_mask are relative to the resource, not the full request. A field is
   *  overwritten if it is in the mask. If the user does not provide a mask, then
   *  all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The state that the spoke should be in after the update.
   */
  // const spoke = {}
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

  async function callUpdateSpoke() {
    // Construct request
    const request = {
      spoke,
    };

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

  callUpdateSpoke();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
TypeDescription
Promise<void>

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

createHub(request, options)

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

Creates a new hub in the specified project.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.ICreateHubRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.networkconnectivity.v1.IHub, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Required. A unique identifier for the hub.
   */
  // const hubId = 'abc123'
  /**
   *  Required. The initial values for a new hub.
   */
  // const hub = {}
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

  async function callCreateHub() {
    // Construct request
    const request = {
      parent,
      hubId,
      hub,
    };

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

  callCreateHub();

createHub(request, options, callback)

createHub(request: protos.google.cloud.networkconnectivity.v1.ICreateHubRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.ICreateHubRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createHub(request, callback)

createHub(request: protos.google.cloud.networkconnectivity.v1.ICreateHubRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.ICreateHubRequest
callback Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createSpoke(request, options)

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

Creates a spoke in the specified project and location.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.ICreateSpokeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource.
   */
  // const parent = 'abc123'
  /**
   *  Required. Unique id for the spoke to create.
   */
  // const spokeId = 'abc123'
  /**
   *  Required. The initial values for a new spoke.
   */
  // const spoke = {}
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

  async function callCreateSpoke() {
    // Construct request
    const request = {
      parent,
      spokeId,
      spoke,
    };

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

  callCreateSpoke();

createSpoke(request, options, callback)

createSpoke(request: protos.google.cloud.networkconnectivity.v1.ICreateSpokeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.ICreateSpokeRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createSpoke(request, callback)

createSpoke(request: protos.google.cloud.networkconnectivity.v1.ICreateSpokeRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.ICreateSpokeRequest
callback Callback<LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteHub(request, options)

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

Deletes the specified hub.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IDeleteHubRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the hub to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

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

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

  callDeleteHub();

deleteHub(request, options, callback)

deleteHub(request: protos.google.cloud.networkconnectivity.v1.IDeleteHubRequest, 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
NameDescription
request protos.google.cloud.networkconnectivity.v1.IDeleteHubRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteHub(request, callback)

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

deleteSpoke(request, options)

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

Deletes the specified spoke.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IDeleteSpokeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the spoke to delete.
   */
  // const name = 'abc123'
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

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

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

  callDeleteSpoke();

deleteSpoke(request, options, callback)

deleteSpoke(request: protos.google.cloud.networkconnectivity.v1.IDeleteSpokeRequest, 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
NameDescription
request protos.google.cloud.networkconnectivity.v1.IDeleteSpokeRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteSpoke(request, callback)

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

getHub(request, options)

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

Gets details about the specified hub.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IGetHubRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IGetHubRequest | undefined, {} | undefined ]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the hub resource to get.
   */
  // const name = 'abc123'

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

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

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

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

  callGetHub();

getHub(request, options, callback)

getHub(request: protos.google.cloud.networkconnectivity.v1.IGetHubRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IGetHubRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IGetHubRequest
options CallOptions
callback Callback<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IGetHubRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getHub(request, callback)

getHub(request: protos.google.cloud.networkconnectivity.v1.IGetHubRequest, callback: Callback<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IGetHubRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IGetHubRequest
callback Callback<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IGetHubRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

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

getProjectId(callback)

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

getSpoke(request, options)

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

Gets details about the specified spoke.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest | undefined, {} | undefined ]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the spoke resource.
   */
  // const name = 'abc123'

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

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

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

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

  callGetSpoke();

getSpoke(request, options, callback)

getSpoke(request: protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest
options CallOptions
callback Callback<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getSpoke(request, callback)

getSpoke(request: protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest, callback: Callback<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest
callback Callback<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IGetSpokeRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

hubPath(project, hub)

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

Return a fully-qualified hub resource name string.

Parameters
NameDescription
project string
hub string
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

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

instancePath(project, zone, instance)

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

Return a fully-qualified instance resource name string.

Parameters
NameDescription
project string
zone string
instance string
Returns
TypeDescription
string

{string} Resource name string.

interconnectAttachmentPath(project, region, resourceId)

interconnectAttachmentPath(project: string, region: string, resourceId: string): string;

Return a fully-qualified interconnectAttachment resource name string.

Parameters
NameDescription
project string
region string
resourceId string
Returns
TypeDescription
string

{string} Resource name string.

listHubs(request, options)

listHubs(request?: protos.google.cloud.networkconnectivity.v1.IListHubsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkconnectivity.v1.IHub[],
        protos.google.cloud.networkconnectivity.v1.IListHubsRequest | null,
        protos.google.cloud.networkconnectivity.v1.IListHubsResponse
    ]>;

Lists hubs in a given project.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListHubsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.networkconnectivity.v1.IHub[], protos.google.cloud.networkconnectivity.v1.IListHubsRequest | null, protos.google.cloud.networkconnectivity.v1.IListHubsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Hub]. 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 listHubsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listHubs(request, options, callback)

listHubs(request: protos.google.cloud.networkconnectivity.v1.IListHubsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListHubsRequest, protos.google.cloud.networkconnectivity.v1.IListHubsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IHub>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListHubsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListHubsRequest, protos.google.cloud.networkconnectivity.v1.IListHubsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IHub>
Returns
TypeDescription
void

listHubs(request, callback)

listHubs(request: protos.google.cloud.networkconnectivity.v1.IListHubsRequest, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListHubsRequest, protos.google.cloud.networkconnectivity.v1.IListHubsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IHub>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListHubsRequest
callback PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListHubsRequest, protos.google.cloud.networkconnectivity.v1.IListHubsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.IHub>
Returns
TypeDescription
void

listHubsAsync(request, options)

listHubsAsync(request?: protos.google.cloud.networkconnectivity.v1.IListHubsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkconnectivity.v1.IHub>;

Equivalent to listHubs, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListHubsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.networkconnectivity.v1.IHub>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Hub]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource's name.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of results per page that should be returned.
   */
  // const pageSize = 1234
  /**
   *  The page token.
   */
  // const pageToken = 'abc123'
  /**
   *  An expression that filters the results listed in the response.
   */
  // const filter = 'abc123'
  /**
   *  Sort the results by a certain order.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListHubs();

listHubsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListHubsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

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

listSpokes(request, options)

listSpokes(request?: protos.google.cloud.networkconnectivity.v1.IListSpokesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkconnectivity.v1.ISpoke[],
        protos.google.cloud.networkconnectivity.v1.IListSpokesRequest | null,
        protos.google.cloud.networkconnectivity.v1.IListSpokesResponse
    ]>;

Lists the spokes in the specified project and location.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListSpokesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.networkconnectivity.v1.ISpoke[], protos.google.cloud.networkconnectivity.v1.IListSpokesRequest | null, protos.google.cloud.networkconnectivity.v1.IListSpokesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Spoke]. 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 listSpokesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSpokes(request, options, callback)

listSpokes(request: protos.google.cloud.networkconnectivity.v1.IListSpokesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListSpokesRequest, protos.google.cloud.networkconnectivity.v1.IListSpokesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.ISpoke>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListSpokesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListSpokesRequest, protos.google.cloud.networkconnectivity.v1.IListSpokesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.ISpoke>
Returns
TypeDescription
void

listSpokes(request, callback)

listSpokes(request: protos.google.cloud.networkconnectivity.v1.IListSpokesRequest, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListSpokesRequest, protos.google.cloud.networkconnectivity.v1.IListSpokesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.ISpoke>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListSpokesRequest
callback PaginationCallback<protos.google.cloud.networkconnectivity.v1.IListSpokesRequest, protos.google.cloud.networkconnectivity.v1.IListSpokesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1.ISpoke>
Returns
TypeDescription
void

listSpokesAsync(request, options)

listSpokesAsync(request?: protos.google.cloud.networkconnectivity.v1.IListSpokesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkconnectivity.v1.ISpoke>;

Equivalent to listSpokes, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListSpokesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.networkconnectivity.v1.ISpoke>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Spoke]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of results per page that should be returned.
   */
  // const pageSize = 1234
  /**
   *  The page token.
   */
  // const pageToken = 'abc123'
  /**
   *  An expression that filters the results listed in the response.
   */
  // const filter = 'abc123'
  /**
   *  Sort the results by a certain order.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListSpokes();

listSpokesStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IListSpokesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

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

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchHubFromHubName(hubName)

matchHubFromHubName(hubName: string): string | number;

Parse the hub from Hub resource.

Parameter
NameDescription
hubName string

A fully-qualified path representing Hub resource.

Returns
TypeDescription
string | number

{string} A string representing the hub.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter
NameDescription
instanceName string

A fully-qualified path representing Instance resource.

Returns
TypeDescription
string | number

{string} A string representing the instance.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSpokeName(spokeName)

matchLocationFromSpokeName(spokeName: string): string | number;

Parse the location from Spoke resource.

Parameter
NameDescription
spokeName string

A fully-qualified path representing Spoke resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromHubName(hubName)

matchProjectFromHubName(hubName: string): string | number;

Parse the project from Hub resource.

Parameter
NameDescription
hubName string

A fully-qualified path representing Hub resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

Parse the project from Instance resource.

Parameter
NameDescription
instanceName string

A fully-qualified path representing Instance resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromInterconnectAttachmentName(interconnectAttachmentName)

matchProjectFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;

Parse the project from InterconnectAttachment resource.

Parameter
NameDescription
interconnectAttachmentName string

A fully-qualified path representing InterconnectAttachment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromNetworkName(networkName)

matchProjectFromNetworkName(networkName: string): string | number;

Parse the project from Network resource.

Parameter
NameDescription
networkName string

A fully-qualified path representing Network resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromSpokeName(spokeName)

matchProjectFromSpokeName(spokeName: string): string | number;

Parse the project from Spoke resource.

Parameter
NameDescription
spokeName string

A fully-qualified path representing Spoke resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromVpnTunnelName(vpnTunnelName)

matchProjectFromVpnTunnelName(vpnTunnelName: string): string | number;

Parse the project from VpnTunnel resource.

Parameter
NameDescription
vpnTunnelName string

A fully-qualified path representing VpnTunnel resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchRegionFromInterconnectAttachmentName(interconnectAttachmentName)

matchRegionFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;

Parse the region from InterconnectAttachment resource.

Parameter
NameDescription
interconnectAttachmentName string

A fully-qualified path representing InterconnectAttachment resource.

Returns
TypeDescription
string | number

{string} A string representing the region.

matchRegionFromVpnTunnelName(vpnTunnelName)

matchRegionFromVpnTunnelName(vpnTunnelName: string): string | number;

Parse the region from VpnTunnel resource.

Parameter
NameDescription
vpnTunnelName string

A fully-qualified path representing VpnTunnel resource.

Returns
TypeDescription
string | number

{string} A string representing the region.

matchResourceIdFromInterconnectAttachmentName(interconnectAttachmentName)

matchResourceIdFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;

Parse the resource_id from InterconnectAttachment resource.

Parameter
NameDescription
interconnectAttachmentName string

A fully-qualified path representing InterconnectAttachment resource.

Returns
TypeDescription
string | number

{string} A string representing the resource_id.

matchResourceIdFromNetworkName(networkName)

matchResourceIdFromNetworkName(networkName: string): string | number;

Parse the resource_id from Network resource.

Parameter
NameDescription
networkName string

A fully-qualified path representing Network resource.

Returns
TypeDescription
string | number

{string} A string representing the resource_id.

matchResourceIdFromVpnTunnelName(vpnTunnelName)

matchResourceIdFromVpnTunnelName(vpnTunnelName: string): string | number;

Parse the resource_id from VpnTunnel resource.

Parameter
NameDescription
vpnTunnelName string

A fully-qualified path representing VpnTunnel resource.

Returns
TypeDescription
string | number

{string} A string representing the resource_id.

matchSpokeFromSpokeName(spokeName)

matchSpokeFromSpokeName(spokeName: string): string | number;

Parse the spoke from Spoke resource.

Parameter
NameDescription
spokeName string

A fully-qualified path representing Spoke resource.

Returns
TypeDescription
string | number

{string} A string representing the spoke.

matchZoneFromInstanceName(instanceName)

matchZoneFromInstanceName(instanceName: string): string | number;

Parse the zone from Instance resource.

Parameter
NameDescription
instanceName string

A fully-qualified path representing Instance resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

networkPath(project, resourceId)

networkPath(project: string, resourceId: string): string;

Return a fully-qualified network resource name string.

Parameters
NameDescription
project string
resourceId string
Returns
TypeDescription
string

{string} Resource name string.

spokePath(project, location, spoke)

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

Return a fully-qualified spoke resource name string.

Parameters
NameDescription
project string
location string
spoke string
Returns
TypeDescription
string

{string} Resource name string.

updateHub(request, options)

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

Updates the description and/or labels of the specified hub.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IUpdateHubRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.networkconnectivity.v1.IHub, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. In the case of an update to an existing hub, field mask is used to specify
   *  the fields to be overwritten. The fields specified in the update_mask are
   *  relative to the resource, not the full request. A field is overwritten if
   *  it is in the mask. If the user does not provide a mask, then all fields are
   *  overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The state that the hub should be in after the update.
   */
  // const hub = {}
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

  async function callUpdateHub() {
    // Construct request
    const request = {
      hub,
    };

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

  callUpdateHub();

updateHub(request, options, callback)

updateHub(request: protos.google.cloud.networkconnectivity.v1.IUpdateHubRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IUpdateHubRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateHub(request, callback)

updateHub(request: protos.google.cloud.networkconnectivity.v1.IUpdateHubRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IUpdateHubRequest
callback Callback<LROperation<protos.google.cloud.networkconnectivity.v1.IHub, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateSpoke(request, options)

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

Updates the parameters of the specified spoke.

Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IUpdateSpokeRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. In the case of an update to an existing spoke, field mask is used to
   *  specify the fields to be overwritten. The fields specified in the
   *  update_mask are relative to the resource, not the full request. A field is
   *  overwritten if it is in the mask. If the user does not provide a mask, then
   *  all fields are overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The state that the spoke should be in after the update.
   */
  // const spoke = {}
  /**
   *  Optional. A unique request ID (optional). If you specify this ID, you can use it
   *  in cases when you need to retry your request. When you need to retry, this
   *  ID lets the server know that it can ignore the request if it has already
   *  been completed. The server guarantees that for at least 60 minutes after
   *  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 to see whether the original operation
   *  was received. If it was, the server ignores the second request. This
   *  behavior prevents clients from mistakenly creating duplicate commitments.
   *  The request ID must be a valid UUID, with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

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

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

  async function callUpdateSpoke() {
    // Construct request
    const request = {
      spoke,
    };

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

  callUpdateSpoke();

updateSpoke(request, options, callback)

updateSpoke(request: protos.google.cloud.networkconnectivity.v1.IUpdateSpokeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IUpdateSpokeRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateSpoke(request, callback)

updateSpoke(request: protos.google.cloud.networkconnectivity.v1.IUpdateSpokeRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.networkconnectivity.v1.IUpdateSpokeRequest
callback Callback<LROperation<protos.google.cloud.networkconnectivity.v1.ISpoke, protos.google.cloud.networkconnectivity.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

vpnTunnelPath(project, region, resourceId)

vpnTunnelPath(project: string, region: string, resourceId: string): string;

Return a fully-qualified vpnTunnel resource name string.

Parameters
NameDescription
project string
region string
resourceId string
Returns
TypeDescription
string

{string} Resource name string.