Constructor
new IdentityAwareProxyAdminServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of IdentityAwareProxyAdminServiceClient.
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.
apiEndpoint
The DNS address for this API service - same as servicePath.
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
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. |
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. |
listTunnelDestGroupsAsync(request, optionsopt) → {Object}
Equivalent to listTunnelDestGroups, 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 TunnelDestGroup. 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. Google Cloud Project ID and location.
* In the following format:
* `projects/{project_number/id}/iap_tunnel/locations/{location}`.
* A `-` can be used for the location to group across all locations.
*/
// const parent = 'abc123'
/**
* The maximum number of groups to return. The service might return fewer than
* this value.
* If unspecified, at most 100 groups are returned.
* The maximum value is 1000; values above 1000 are coerced to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListTunnelDestGroups`
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListTunnelDestGroups` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
// Imports the Iap library
const {IdentityAwareProxyAdminServiceClient} = require('@google-cloud/iap').v1;
// Instantiates a client
const iapClient = new IdentityAwareProxyAdminServiceClient();
async function callListTunnelDestGroups() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = iapClient.listTunnelDestGroupsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListTunnelDestGroups();
listTunnelDestGroupsStream(request, optionsopt) → {Stream}
Equivalent to listTunnelDestGroups, 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 TunnelDestGroup 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 |
matchDestGroupFromTunnelDestGroupName(tunnelDestGroupName) → {string}
Parse the dest_group from TunnelDestGroup resource.
Parameters:
| Name | Type | Description |
|---|---|---|
tunnelDestGroupName |
string |
A fully-qualified path representing TunnelDestGroup resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the dest_group. |
matchLocationFromTunnelDestGroupName(tunnelDestGroupName) → {string}
Parse the location from TunnelDestGroup resource.
Parameters:
| Name | Type | Description |
|---|---|---|
tunnelDestGroupName |
string |
A fully-qualified path representing TunnelDestGroup resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromTunnelLocationName(tunnelLocationName) → {string}
Parse the location from TunnelLocation resource.
Parameters:
| Name | Type | Description |
|---|---|---|
tunnelLocationName |
string |
A fully-qualified path representing TunnelLocation resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchProjectFromProjectName(projectName) → {string}
Parse the project from Project resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectName |
string |
A fully-qualified path representing Project resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromTunnelDestGroupName(tunnelDestGroupName) → {string}
Parse the project from TunnelDestGroup resource.
Parameters:
| Name | Type | Description |
|---|---|---|
tunnelDestGroupName |
string |
A fully-qualified path representing TunnelDestGroup resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromTunnelLocationName(tunnelLocationName) → {string}
Parse the project from TunnelLocation resource.
Parameters:
| Name | Type | Description |
|---|---|---|
tunnelLocationName |
string |
A fully-qualified path representing TunnelLocation resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
projectPath(project) → {string}
Return a fully-qualified project resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
tunnelDestGroupPath(project, location, dest_group) → {string}
Return a fully-qualified tunnelDestGroup resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
dest_group |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
tunnelLocationPath(project, location) → {string}
Return a fully-qualified tunnelLocation resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |