Class v1.ReachabilityServiceClient (1.0.2)

The Reachability service in the Google Cloud Network Management API provides services that analyze the reachability within a single Google Virtual Private Cloud (VPC) network, between peered VPC networks, between VPC and on-premises networks, or between VPC networks and internet hosts. A reachability analysis is based on Google Cloud network configurations.

You can use the analysis results to verify these configurations and to troubleshoot connectivity issues. v1

Package

@google-cloud/network-management!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ReachabilityServiceClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

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

Property Value

Type	Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;

Property Value

Type	Description
gax.OperationsClient

pathTemplates

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

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

reachabilityServiceStub

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

Property Value

Type	Description
Promise<{ [name: string]: Function; }>

scopes

static get scopes(): string[];

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

Property Value

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

warn

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

Property Value

Type	Description
(code: string, message: string, warnType?: string) => void

Methods

checkCreateConnectivityTestProgress(name)

checkCreateConnectivityTestProgress(name: string): Promise<LROperation<protos.google.cloud.networkmanagement.v1.ConnectivityTest, protos.google.cloud.networkmanagement.v1.OperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.networkmanagement.v1.ConnectivityTest, protos.google.cloud.networkmanagement.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.

checkDeleteConnectivityTestProgress(name)

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

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkmanagement.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.

checkRerunConnectivityTestProgress(name)

checkRerunConnectivityTestProgress(name: string): Promise<LROperation<protos.google.cloud.networkmanagement.v1.ConnectivityTest, protos.google.cloud.networkmanagement.v1.OperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.networkmanagement.v1.ConnectivityTest, protos.google.cloud.networkmanagement.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.

checkUpdateConnectivityTestProgress(name)

checkUpdateConnectivityTestProgress(name: string): Promise<LROperation<protos.google.cloud.networkmanagement.v1.ConnectivityTest, protos.google.cloud.networkmanagement.v1.OperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.networkmanagement.v1.ConnectivityTest, protos.google.cloud.networkmanagement.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.

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.

connectivityTestPath(project, test)

connectivityTestPath(project: string, test: string): string;

Return a fully-qualified connectivityTest resource name string.

Parameters

Name	Description
project	`string`
test	`string`

Returns

Type	Description
string	{string} Resource name string.

createConnectivityTest(request, options)

createConnectivityTest(request?: protos.google.cloud.networkmanagement.v1.ICreateConnectivityTestRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.ICreateConnectivityTestRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

createConnectivityTest(request, options, callback)

createConnectivityTest(request: protos.google.cloud.networkmanagement.v1.ICreateConnectivityTestRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.ICreateConnectivityTestRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createConnectivityTest(request, callback)

createConnectivityTest(request: protos.google.cloud.networkmanagement.v1.ICreateConnectivityTestRequest, callback: Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.ICreateConnectivityTestRequest`
callback	`Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteConnectivityTest(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IDeleteConnectivityTestRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

deleteConnectivityTest(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

deleteConnectivityTest(request, callback)

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

Parameters

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

Returns

Type	Description
void

getConnectivityTest(request, options)

getConnectivityTest(request?: protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkmanagement.v1.IConnectivityTest,
        (protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.networkmanagement.v1.IConnectivityTest, (protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest \| undefined), {} \| undefined ]>

getConnectivityTest(request, options, callback)

getConnectivityTest(request: protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getConnectivityTest(request, callback)

getConnectivityTest(request: protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest, callback: Callback<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest`
callback	`Callback<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IGetConnectivityTestRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

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

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.

listConnectivityTests(request, options)

listConnectivityTests(request?: protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.networkmanagement.v1.IConnectivityTest[],
        protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest | null,
        protos.google.cloud.networkmanagement.v1.IListConnectivityTestsResponse
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.networkmanagement.v1.IConnectivityTest[], protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest \| null, protos.google.cloud.networkmanagement.v1.IListConnectivityTestsResponse ]>

listConnectivityTests(request, options, callback)

listConnectivityTests(request: protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest, protos.google.cloud.networkmanagement.v1.IListConnectivityTestsResponse | null | undefined, protos.google.cloud.networkmanagement.v1.IConnectivityTest>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest, protos.google.cloud.networkmanagement.v1.IListConnectivityTestsResponse \| null \| undefined, protos.google.cloud.networkmanagement.v1.IConnectivityTest>`

Returns

Type	Description
void

listConnectivityTests(request, callback)

listConnectivityTests(request: protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest, callback: PaginationCallback<protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest, protos.google.cloud.networkmanagement.v1.IListConnectivityTestsResponse | null | undefined, protos.google.cloud.networkmanagement.v1.IConnectivityTest>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest`
callback	`PaginationCallback<protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest, protos.google.cloud.networkmanagement.v1.IListConnectivityTestsResponse \| null \| undefined, protos.google.cloud.networkmanagement.v1.IConnectivityTest>`

Returns

Type	Description
void

listConnectivityTestsAsync(request, options)

listConnectivityTestsAsync(request?: protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkmanagement.v1.IConnectivityTest>;

Equivalent to listConnectivityTests, but returns an iterable object.

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

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.networkmanagement.v1.IConnectivityTest>

{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 [ConnectivityTest]. 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.

listConnectivityTestsStream(request, options)

listConnectivityTestsStream(request?: protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IListConnectivityTestsRequest` 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 [ConnectivityTest] 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 listConnectivityTestsAsync() 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.

matchProjectFromConnectivityTestName(connectivityTestName)

matchProjectFromConnectivityTestName(connectivityTestName: string): string | number;

Parse the project from ConnectivityTest resource.

Parameter

Name	Description
connectivityTestName	`string` A fully-qualified path representing ConnectivityTest resource.

Returns

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

matchTestFromConnectivityTestName(connectivityTestName)

matchTestFromConnectivityTestName(connectivityTestName: string): string | number;

Parse the test from ConnectivityTest resource.

Parameter

Name	Description
connectivityTestName	`string` A fully-qualified path representing ConnectivityTest resource.

Returns

Type	Description
string \| number	{string} A string representing the test.

rerunConnectivityTest(request, options)

rerunConnectivityTest(request?: protos.google.cloud.networkmanagement.v1.IRerunConnectivityTestRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IRerunConnectivityTestRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

rerunConnectivityTest(request, options, callback)

rerunConnectivityTest(request: protos.google.cloud.networkmanagement.v1.IRerunConnectivityTestRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IRerunConnectivityTestRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

rerunConnectivityTest(request, callback)

rerunConnectivityTest(request: protos.google.cloud.networkmanagement.v1.IRerunConnectivityTestRequest, callback: Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IRerunConnectivityTestRequest`
callback	`Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateConnectivityTest(request, options)

updateConnectivityTest(request?: protos.google.cloud.networkmanagement.v1.IUpdateConnectivityTestRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IUpdateConnectivityTestRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

updateConnectivityTest(request, options, callback)

updateConnectivityTest(request: protos.google.cloud.networkmanagement.v1.IUpdateConnectivityTestRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IUpdateConnectivityTestRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateConnectivityTest(request, callback)

updateConnectivityTest(request: protos.google.cloud.networkmanagement.v1.IUpdateConnectivityTestRequest, callback: Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.networkmanagement.v1.IUpdateConnectivityTestRequest`
callback	`Callback<LROperation<protos.google.cloud.networkmanagement.v1.IConnectivityTest, protos.google.cloud.networkmanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void