Constructor
new HubServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of HubServiceClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
(async) checkCreateHubProgress(name) → {Promise}
Check the status of the long running operation returned by createHub()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource's name of the Hub.
*/
// const parent = 'abc123'
/**
* Optional. Unique id for the Hub to create.
*/
// const hubId = 'abc123'
/**
* Required. Initial values for a new Hub.
*/
// const hub = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and t
* he request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally 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').v1alpha1;
// Instantiates a client
const networkconnectivityClient = new HubServiceClient();
async function callCreateHub() {
// Construct request
const request = {
parent,
hub,
};
// Run request
const [operation] = await networkconnectivityClient.createHub(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateHub();
(async) checkCreateSpokeProgress(name) → {Promise}
Check the status of the long running operation returned by createSpoke()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent's resource name of the Spoke.
*/
// const parent = 'abc123'
/**
* Optional. Unique id for the Spoke to create.
*/
// const spokeId = 'abc123'
/**
* Required. Initial values for a new Hub.
*/
// const spoke = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and t
* he request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally 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').v1alpha1;
// Instantiates a client
const networkconnectivityClient = new HubServiceClient();
async function callCreateSpoke() {
// Construct request
const request = {
parent,
spoke,
};
// Run request
const [operation] = await networkconnectivityClient.createSpoke(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateSpoke();
(async) checkDeleteHubProgress(name) → {Promise}
Check the status of the long running operation returned by deleteHub()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the Hub to delete.
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and t
* he request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally 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').v1alpha1;
// 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();
(async) checkDeleteSpokeProgress(name) → {Promise}
Check the status of the long running operation returned by deleteSpoke()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the Spoke to delete.
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and t
* he request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally 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').v1alpha1;
// 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();
(async) checkUpdateHubProgress(name) → {Promise}
Check the status of the long running operation returned by updateHub()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. Field mask is used to specify the fields to be overwritten in the
* Hub resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The state that the Hub should be in after the update.
*/
// const hub = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and t
* he request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally 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').v1alpha1;
// 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();
(async) checkUpdateSpokeProgress(name) → {Promise}
Check the status of the long running operation returned by updateSpoke()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. Field mask is used to specify the fields to be overwritten in the
* Spoke resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The state that the Spoke should be in after the update.
*/
// const spoke = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and t
* he request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally 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').v1alpha1;
// 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() → {Promise}
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 |
A promise that resolves when the client is closed. |
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
hubPath(project, hub) → {string}
Return a fully-qualified hub resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
hub |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
initialize() → {Promise}
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 |
A promise that resolves to an authenticated service stub. |
instancePath(project, zone, instance) → {string}
Return a fully-qualified instance resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
zone |
string | |
instance |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
interconnectAttachmentPath(project, region, resource_id) → {string}
Return a fully-qualified interconnectAttachment resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string | |
resource_id |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
listHubsAsync(request, optionsopt) → {Object}
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 | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. 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 for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The 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'
/**
* A filter 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').v1alpha1;
// 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, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
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 |
listSpokesAsync(request, optionsopt) → {Object}
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 | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. 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 for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent's resource name.
*/
// const parent = 'abc123'
/**
* The maximum number of results per page that should be returned.
*/
// const pageSize = 1234
/**
* The page token.
*/
// const pageToken = 'abc123'
/**
* A filter 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').v1alpha1;
// 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, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
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 |
locationPath(project, location) → {string}
Return a fully-qualified location resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
matchHubFromHubName(hubName) → {string}
Parse the hub from Hub resource.
Parameters:
Name | Type | Description |
---|---|---|
hubName |
string |
A fully-qualified path representing Hub resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the hub. |
matchInstanceFromInstanceName(instanceName) → {string}
Parse the instance from Instance resource.
Parameters:
Name | Type | Description |
---|---|---|
instanceName |
string |
A fully-qualified path representing Instance resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the instance. |
matchLocationFromLocationName(locationName) → {string}
Parse the location from Location resource.
Parameters:
Name | Type | Description |
---|---|---|
locationName |
string |
A fully-qualified path representing Location resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromSpokeName(spokeName) → {string}
Parse the location from Spoke resource.
Parameters:
Name | Type | Description |
---|---|---|
spokeName |
string |
A fully-qualified path representing Spoke resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchProjectFromHubName(hubName) → {string}
Parse the project from Hub resource.
Parameters:
Name | Type | Description |
---|---|---|
hubName |
string |
A fully-qualified path representing Hub resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromInstanceName(instanceName) → {string}
Parse the project from Instance resource.
Parameters:
Name | Type | Description |
---|---|---|
instanceName |
string |
A fully-qualified path representing Instance resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromInterconnectAttachmentName(interconnectAttachmentName) → {string}
Parse the project from InterconnectAttachment resource.
Parameters:
Name | Type | Description |
---|---|---|
interconnectAttachmentName |
string |
A fully-qualified path representing InterconnectAttachment resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromLocationName(locationName) → {string}
Parse the project from Location resource.
Parameters:
Name | Type | Description |
---|---|---|
locationName |
string |
A fully-qualified path representing Location resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromSpokeName(spokeName) → {string}
Parse the project from Spoke resource.
Parameters:
Name | Type | Description |
---|---|---|
spokeName |
string |
A fully-qualified path representing Spoke resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromVpnTunnelName(vpnTunnelName) → {string}
Parse the project from VpnTunnel resource.
Parameters:
Name | Type | Description |
---|---|---|
vpnTunnelName |
string |
A fully-qualified path representing VpnTunnel resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchRegionFromInterconnectAttachmentName(interconnectAttachmentName) → {string}
Parse the region from InterconnectAttachment resource.
Parameters:
Name | Type | Description |
---|---|---|
interconnectAttachmentName |
string |
A fully-qualified path representing InterconnectAttachment resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchRegionFromVpnTunnelName(vpnTunnelName) → {string}
Parse the region from VpnTunnel resource.
Parameters:
Name | Type | Description |
---|---|---|
vpnTunnelName |
string |
A fully-qualified path representing VpnTunnel resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the region. |
matchResourceIdFromInterconnectAttachmentName(interconnectAttachmentName) → {string}
Parse the resource_id from InterconnectAttachment resource.
Parameters:
Name | Type | Description |
---|---|---|
interconnectAttachmentName |
string |
A fully-qualified path representing InterconnectAttachment resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the resource_id. |
matchResourceIdFromVpnTunnelName(vpnTunnelName) → {string}
Parse the resource_id from VpnTunnel resource.
Parameters:
Name | Type | Description |
---|---|---|
vpnTunnelName |
string |
A fully-qualified path representing VpnTunnel resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the resource_id. |
matchSpokeFromSpokeName(spokeName) → {string}
Parse the spoke from Spoke resource.
Parameters:
Name | Type | Description |
---|---|---|
spokeName |
string |
A fully-qualified path representing Spoke resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the spoke. |
matchZoneFromInstanceName(instanceName) → {string}
Parse the zone from Instance resource.
Parameters:
Name | Type | Description |
---|---|---|
instanceName |
string |
A fully-qualified path representing Instance resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the zone. |
spokePath(project, location, spoke) → {string}
Return a fully-qualified spoke resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
spoke |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
vpnTunnelPath(project, region, resource_id) → {string}
Return a fully-qualified vpnTunnel resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
region |
string | |
resource_id |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |