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. v1alpha1
Package
@google-cloud/network-connectivity!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of HubServiceClient.
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
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
hubServiceStub
hubServiceStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
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
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
Methods
checkCreateHubProgress(name)
checkCreateHubProgress(name: string): Promise<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.Hub, protos.google.cloud.networkconnectivity.v1alpha1.OperationMetadata>>;
Check the status of the long running operation returned by createHub()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.Hub, protos.google.cloud.networkconnectivity.v1alpha1.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.
|
checkCreateSpokeProgress(name)
checkCreateSpokeProgress(name: string): Promise<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.Spoke, protos.google.cloud.networkconnectivity.v1alpha1.OperationMetadata>>;
Check the status of the long running operation returned by createSpoke()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.Spoke, protos.google.cloud.networkconnectivity.v1alpha1.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.
|
checkDeleteHubProgress(name)
checkDeleteHubProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkconnectivity.v1alpha1.OperationMetadata>>;
Check the status of the long running operation returned by deleteHub()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkconnectivity.v1alpha1.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.
|
checkDeleteSpokeProgress(name)
checkDeleteSpokeProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkconnectivity.v1alpha1.OperationMetadata>>;
Check the status of the long running operation returned by deleteSpoke()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.networkconnectivity.v1alpha1.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.
|
checkUpdateHubProgress(name)
checkUpdateHubProgress(name: string): Promise<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.Hub, protos.google.cloud.networkconnectivity.v1alpha1.OperationMetadata>>;
Check the status of the long running operation returned by updateHub()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.Hub, protos.google.cloud.networkconnectivity.v1alpha1.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.
|
checkUpdateSpokeProgress(name)
checkUpdateSpokeProgress(name: string): Promise<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.Spoke, protos.google.cloud.networkconnectivity.v1alpha1.OperationMetadata>>;
Check the status of the long running operation returned by updateSpoke()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.Spoke, protos.google.cloud.networkconnectivity.v1alpha1.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()
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.
|
createHub(request, options)
createHub(request?: protos.google.cloud.networkconnectivity.v1alpha1.ICreateHubRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.ICreateHubRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
createHub(request, options, callback)
createHub(request: protos.google.cloud.networkconnectivity.v1alpha1.ICreateHubRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.ICreateHubRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
createHub(request, callback)
createHub(request: protos.google.cloud.networkconnectivity.v1alpha1.ICreateHubRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.ICreateHubRequest
|
callback |
Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
createSpoke(request, options)
createSpoke(request?: protos.google.cloud.networkconnectivity.v1alpha1.ICreateSpokeRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.ICreateSpokeRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
createSpoke(request, options, callback)
createSpoke(request: protos.google.cloud.networkconnectivity.v1alpha1.ICreateSpokeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.ICreateSpokeRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
createSpoke(request, callback)
createSpoke(request: protos.google.cloud.networkconnectivity.v1alpha1.ICreateSpokeRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.ICreateSpokeRequest
|
callback |
Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteHub(request, options)
deleteHub(request?: protos.google.cloud.networkconnectivity.v1alpha1.IDeleteHubRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IDeleteHubRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteHub(request, options, callback)
deleteHub(request: protos.google.cloud.networkconnectivity.v1alpha1.IDeleteHubRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IDeleteHubRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteHub(request, callback)
deleteHub(request: protos.google.cloud.networkconnectivity.v1alpha1.IDeleteHubRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IDeleteHubRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteSpoke(request, options)
deleteSpoke(request?: protos.google.cloud.networkconnectivity.v1alpha1.IDeleteSpokeRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IDeleteSpokeRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteSpoke(request, options, callback)
deleteSpoke(request: protos.google.cloud.networkconnectivity.v1alpha1.IDeleteSpokeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IDeleteSpokeRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteSpoke(request, callback)
deleteSpoke(request: protos.google.cloud.networkconnectivity.v1alpha1.IDeleteSpokeRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IDeleteSpokeRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
getHub(request, options)
getHub(request?: protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest, options?: CallOptions): Promise<[
protos.google.cloud.networkconnectivity.v1alpha1.IHub,
(protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.networkconnectivity.v1alpha1.IHub,
(protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest | undefined),
{} | undefined
]> | |
getHub(request, options, callback)
getHub(request: protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest | null | undefined, {} | null | undefined>
|
Returns
getHub(request, callback)
getHub(request: protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest, callback: Callback<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest
|
callback |
Callback<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IGetHubRequest | null | undefined, {} | null | undefined>
|
Returns
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
getSpoke(request, options)
getSpoke(request?: protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest, options?: CallOptions): Promise<[
protos.google.cloud.networkconnectivity.v1alpha1.ISpoke,
(protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.networkconnectivity.v1alpha1.ISpoke,
(protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest | undefined),
{} | undefined
]> | |
getSpoke(request, options, callback)
getSpoke(request: protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest, options: CallOptions, callback: Callback<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest | null | undefined, {} | null | undefined>
|
Returns
getSpoke(request, callback)
getSpoke(request: protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest, callback: Callback<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest
|
callback |
Callback<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IGetSpokeRequest | null | undefined, {} | null | undefined>
|
Returns
hubPath(project, hub)
hubPath(project: string, hub: string): string;
Return a fully-qualified hub resource name string.
Parameters
Name | Description |
project |
string
|
hub |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
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.
|
instancePath(project, zone, instance)
instancePath(project: string, zone: string, instance: string): string;
Return a fully-qualified instance resource name string.
Parameters
Name | Description |
project |
string
|
zone |
string
|
instance |
string
|
Returns
Type | Description |
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
Name | Description |
project |
string
|
region |
string
|
resourceId |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
listHubs(request, options)
listHubs(request?: protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest, options?: CallOptions): Promise<[
protos.google.cloud.networkconnectivity.v1alpha1.IHub[],
protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest | null,
protos.google.cloud.networkconnectivity.v1alpha1.IListHubsResponse
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.networkconnectivity.v1alpha1.IHub[],
protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest | null,
protos.google.cloud.networkconnectivity.v1alpha1.IListHubsResponse
]> | |
listHubs(request, options, callback)
listHubs(request: protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest, protos.google.cloud.networkconnectivity.v1alpha1.IListHubsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1alpha1.IHub>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest, protos.google.cloud.networkconnectivity.v1alpha1.IListHubsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1alpha1.IHub>
|
Returns
listHubs(request, callback)
listHubs(request: protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest, protos.google.cloud.networkconnectivity.v1alpha1.IListHubsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1alpha1.IHub>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest
|
callback |
PaginationCallback<protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest, protos.google.cloud.networkconnectivity.v1alpha1.IListHubsResponse | null | undefined, protos.google.cloud.networkconnectivity.v1alpha1.IHub>
|
Returns
listHubsAsync(request, options)
listHubsAsync(request?: protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkconnectivity.v1alpha1.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
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.networkconnectivity.v1alpha1.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.
|
listHubsStream(request, options)
listHubsStream(request?: protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListHubsRequest
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 [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.v1alpha1.IListSpokesRequest, options?: CallOptions): Promise<[
protos.google.cloud.networkconnectivity.v1alpha1.ISpoke[],
protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest | null,
protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesResponse
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.networkconnectivity.v1alpha1.ISpoke[],
protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest | null,
protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesResponse
]> | |
listSpokes(request, options, callback)
listSpokes(request: protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1alpha1.ISpoke>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1alpha1.ISpoke>
|
Returns
listSpokes(request, callback)
listSpokes(request: protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, callback: PaginationCallback<protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1alpha1.ISpoke>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest
|
callback |
PaginationCallback<protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesResponse | null | undefined, protos.google.cloud.networkconnectivity.v1alpha1.ISpoke>
|
Returns
listSpokesAsync(request, options)
listSpokesAsync(request?: protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.networkconnectivity.v1alpha1.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
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.networkconnectivity.v1alpha1.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.
|
listSpokesStream(request, options)
listSpokesStream(request?: protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest
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 [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
Name | Description |
project |
string
|
location |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
matchHubFromHubName(hubName)
matchHubFromHubName(hubName: string): string | number;
Parse the hub from Hub resource.
Parameter
Name | Description |
hubName |
string
A fully-qualified path representing Hub resource.
|
Returns
Type | Description |
string | number | {string} A string representing the hub.
|
matchInstanceFromInstanceName(instanceName)
matchInstanceFromInstanceName(instanceName: string): string | number;
Parse the instance from Instance resource.
Parameter
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource.
|
Returns
Type | Description |
string | number | {string} A string representing the instance.
|
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromSpokeName(spokeName)
matchLocationFromSpokeName(spokeName: string): string | number;
Parse the location from Spoke resource.
Parameter
Name | Description |
spokeName |
string
A fully-qualified path representing Spoke resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchProjectFromHubName(hubName)
matchProjectFromHubName(hubName: string): string | number;
Parse the project from Hub resource.
Parameter
Name | Description |
hubName |
string
A fully-qualified path representing Hub resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromInstanceName(instanceName)
matchProjectFromInstanceName(instanceName: string): string | number;
Parse the project from Instance resource.
Parameter
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromInterconnectAttachmentName(interconnectAttachmentName)
matchProjectFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;
Parse the project from InterconnectAttachment resource.
Parameter
Name | Description |
interconnectAttachmentName |
string
A fully-qualified path representing InterconnectAttachment resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromSpokeName(spokeName)
matchProjectFromSpokeName(spokeName: string): string | number;
Parse the project from Spoke resource.
Parameter
Name | Description |
spokeName |
string
A fully-qualified path representing Spoke resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromVpnTunnelName(vpnTunnelName)
matchProjectFromVpnTunnelName(vpnTunnelName: string): string | number;
Parse the project from VpnTunnel resource.
Parameter
Name | Description |
vpnTunnelName |
string
A fully-qualified path representing VpnTunnel resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchRegionFromInterconnectAttachmentName(interconnectAttachmentName)
matchRegionFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;
Parse the region from InterconnectAttachment resource.
Parameter
Name | Description |
interconnectAttachmentName |
string
A fully-qualified path representing InterconnectAttachment resource.
|
Returns
Type | Description |
string | number | {string} A string representing the region.
|
matchRegionFromVpnTunnelName(vpnTunnelName)
matchRegionFromVpnTunnelName(vpnTunnelName: string): string | number;
Parse the region from VpnTunnel resource.
Parameter
Name | Description |
vpnTunnelName |
string
A fully-qualified path representing VpnTunnel resource.
|
Returns
Type | Description |
string | number | {string} A string representing the region.
|
matchResourceIdFromInterconnectAttachmentName(interconnectAttachmentName)
matchResourceIdFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;
Parse the resource_id from InterconnectAttachment resource.
Parameter
Name | Description |
interconnectAttachmentName |
string
A fully-qualified path representing InterconnectAttachment resource.
|
Returns
Type | Description |
string | number | {string} A string representing the resource_id.
|
matchResourceIdFromVpnTunnelName(vpnTunnelName)
matchResourceIdFromVpnTunnelName(vpnTunnelName: string): string | number;
Parse the resource_id from VpnTunnel resource.
Parameter
Name | Description |
vpnTunnelName |
string
A fully-qualified path representing VpnTunnel resource.
|
Returns
Type | Description |
string | number | {string} A string representing the resource_id.
|
matchSpokeFromSpokeName(spokeName)
matchSpokeFromSpokeName(spokeName: string): string | number;
Parse the spoke from Spoke resource.
Parameter
Name | Description |
spokeName |
string
A fully-qualified path representing Spoke resource.
|
Returns
Type | Description |
string | number | {string} A string representing the spoke.
|
matchZoneFromInstanceName(instanceName)
matchZoneFromInstanceName(instanceName: string): string | number;
Parse the zone from Instance resource.
Parameter
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource.
|
Returns
Type | Description |
string | number | {string} A string representing the zone.
|
spokePath(project, location, spoke)
spokePath(project: string, location: string, spoke: string): string;
Return a fully-qualified spoke resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
spoke |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
updateHub(request, options)
updateHub(request?: protos.google.cloud.networkconnectivity.v1alpha1.IUpdateHubRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IUpdateHubRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
updateHub(request, options, callback)
updateHub(request: protos.google.cloud.networkconnectivity.v1alpha1.IUpdateHubRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IUpdateHubRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
updateHub(request, callback)
updateHub(request: protos.google.cloud.networkconnectivity.v1alpha1.IUpdateHubRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IUpdateHubRequest
|
callback |
Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.IHub, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
updateSpoke(request, options)
updateSpoke(request?: protos.google.cloud.networkconnectivity.v1alpha1.IUpdateSpokeRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IUpdateSpokeRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
updateSpoke(request, options, callback)
updateSpoke(request: protos.google.cloud.networkconnectivity.v1alpha1.IUpdateSpokeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IUpdateSpokeRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
updateSpoke(request, callback)
updateSpoke(request: protos.google.cloud.networkconnectivity.v1alpha1.IUpdateSpokeRequest, callback: Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.networkconnectivity.v1alpha1.IUpdateSpokeRequest
|
callback |
Callback<LROperation<protos.google.cloud.networkconnectivity.v1alpha1.ISpoke, protos.google.cloud.networkconnectivity.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
vpnTunnelPath(project, region, resourceId)
vpnTunnelPath(project: string, region: string, resourceId: string): string;
Return a fully-qualified vpnTunnel resource name string.
Parameters
Name | Description |
project |
string
|
region |
string
|
resourceId |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|