Send feedback Class v1.VpnGatewaysClient (3.0.0) Stay organized with collections Save and categorize content based on your preferences. Version 3.0.0keyboard_arrow_down Package @google-cloud/compute Constructors (constructor)(opts)
constructor ( opts ?: ClientOptions ); Construct an instance of VpnGatewaysClient.
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.
auth descriptors innerApiCalls
innerApiCalls : { [ name : string ] : Function ; }; port The port for this API service.
scopes
static get scopes () : string []; The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath () : string ; The DNS address for this API service.
vpnGatewaysStub
vpnGatewaysStub ?: Promise <{ [ name : string ] : Function ; }>; warn
warn : ( code : string , message : string , warnType ?: string ) = >void ; Methods aggregatedListAsync(request, options)
aggregatedListAsync ( request ?: protos . google . cloud . compute . v1 . IAggregatedListVpnGatewaysRequest , options ?: CallOptions ) : AsyncIterable <[ string , protos . google . cloud . compute . v1 . IVpnGatewaysScopedList ]>; Equivalent toaggregatedList, 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.compute.v1.IAggregatedListVpnGatewaysRequest The request object that will be sent.
options CallOptions Call options. SeeCallOptions for more details.
Returns Type Description AsyncIterable <[ string, protos.google.cloud.compute.v1.IVpnGatewaysScopedList ]>{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 as tuple [string, [VpnGatewaysScopedList]]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
Example
const iterable = client . aggregatedListAsync ( request ); for await ( const [ key , value ] of iterable ) { // process response } 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.
delete(request, options)
delete ( request ?: protos . google . cloud . compute . v1 . IDeleteVpnGatewayRequest , options ?: CallOptions ) : Promise <[ LROperation<protos . google . cloud . compute . v1 . IOperation , null >, protos . google . cloud . compute . v1 . IOperation | undefined , {} | undefined ]>; Parameters Name Description request protos.google.cloud.compute.v1.IDeleteVpnGatewayRequest options CallOptions
Returns Type Description Promise <[LROperation <protos.google.cloud.compute.v1.IOperation , null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>
delete(request, options, callback)
delete ( request : protos . google . cloud . compute . v1 . IDeleteVpnGatewayRequest , options : CallOptions , callback : Callback<protos . google . cloud . compute . v1 . IOperation , protos . google . cloud . compute . v1 . IDeleteVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IDeleteVpnGatewayRequest options CallOptions callback Callback <protos.google.cloud.compute.v1.IOperation , protos.google.cloud.compute.v1.IDeleteVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns delete(request, callback)
delete ( request : protos . google . cloud . compute . v1 . IDeleteVpnGatewayRequest , callback : Callback<protos . google . cloud . compute . v1 . IOperation , protos . google . cloud . compute . v1 . IDeleteVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IDeleteVpnGatewayRequest callback Callback <protos.google.cloud.compute.v1.IOperation , protos.google.cloud.compute.v1.IDeleteVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns get(request, options)
get ( request ?: protos . google . cloud . compute . v1 . IGetVpnGatewayRequest , options ?: CallOptions ) : Promise <[ protos . google . cloud . compute . v1 . IVpnGateway , protos . google . cloud . compute . v1 . IGetVpnGatewayRequest | undefined , {} | undefined ]>; Parameters Name Description request protos.google.cloud.compute.v1.IGetVpnGatewayRequest options CallOptions
Returns Type Description Promise <[ protos.google.cloud.compute.v1.IVpnGateway , protos.google.cloud.compute.v1.IGetVpnGatewayRequest | undefined, {} | undefined ]>
get(request, options, callback)
get ( request : protos . google . cloud . compute . v1 . IGetVpnGatewayRequest , options : CallOptions , callback : Callback<protos . google . cloud . compute . v1 . IVpnGateway , protos . google . cloud . compute . v1 . IGetVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IGetVpnGatewayRequest options CallOptions callback Callback <protos.google.cloud.compute.v1.IVpnGateway , protos.google.cloud.compute.v1.IGetVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns get(request, callback)
get ( request : protos . google . cloud . compute . v1 . IGetVpnGatewayRequest , callback : Callback<protos . google . cloud . compute . v1 . IVpnGateway , protos . google . cloud . compute . v1 . IGetVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IGetVpnGatewayRequest callback Callback <protos.google.cloud.compute.v1.IVpnGateway , protos.google.cloud.compute.v1.IGetVpnGatewayRequest | 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 getStatus(request, options)
getStatus ( request ?: protos . google . cloud . compute . v1 . IGetStatusVpnGatewayRequest , options ?: CallOptions ) : Promise <[ protos . google . cloud . compute . v1 . IVpnGatewaysGetStatusResponse , protos . google . cloud . compute . v1 . IGetStatusVpnGatewayRequest | undefined , {} | undefined ]>; Parameters Name Description request protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest options CallOptions
Returns Type Description Promise <[ protos.google.cloud.compute.v1.IVpnGatewaysGetStatusResponse , protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest | undefined, {} | undefined ]>
getStatus(request, options, callback)
getStatus ( request : protos . google . cloud . compute . v1 . IGetStatusVpnGatewayRequest , options : CallOptions , callback : Callback<protos . google . cloud . compute . v1 . IVpnGatewaysGetStatusResponse , protos . google . cloud . compute . v1 . IGetStatusVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest options CallOptions callback Callback <protos.google.cloud.compute.v1.IVpnGatewaysGetStatusResponse , protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns getStatus(request, callback)
getStatus ( request : protos . google . cloud . compute . v1 . IGetStatusVpnGatewayRequest , callback : Callback<protos . google . cloud . compute . v1 . IVpnGatewaysGetStatusResponse , protos . google . cloud . compute . v1 . IGetStatusVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest callback Callback <protos.google.cloud.compute.v1.IVpnGatewaysGetStatusResponse , protos.google.cloud.compute.v1.IGetStatusVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns 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.
insert(request, options)
insert ( request ?: protos . google . cloud . compute . v1 . IInsertVpnGatewayRequest , options ?: CallOptions ) : Promise <[ LROperation<protos . google . cloud . compute . v1 . IOperation , null >, protos . google . cloud . compute . v1 . IOperation | undefined , {} | undefined ]>; Parameters Name Description request protos.google.cloud.compute.v1.IInsertVpnGatewayRequest options CallOptions
Returns Type Description Promise <[LROperation <protos.google.cloud.compute.v1.IOperation , null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>
insert(request, options, callback)
insert ( request : protos . google . cloud . compute . v1 . IInsertVpnGatewayRequest , options : CallOptions , callback : Callback<protos . google . cloud . compute . v1 . IOperation , protos . google . cloud . compute . v1 . IInsertVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IInsertVpnGatewayRequest options CallOptions callback Callback <protos.google.cloud.compute.v1.IOperation , protos.google.cloud.compute.v1.IInsertVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns insert(request, callback)
insert ( request : protos . google . cloud . compute . v1 . IInsertVpnGatewayRequest , callback : Callback<protos . google . cloud . compute . v1 . IOperation , protos . google . cloud . compute . v1 . IInsertVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IInsertVpnGatewayRequest callback Callback <protos.google.cloud.compute.v1.IOperation , protos.google.cloud.compute.v1.IInsertVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns list(request, options)
list ( request ?: protos . google . cloud . compute . v1 . IListVpnGatewaysRequest , options ?: CallOptions ) : Promise <[ protos . google . cloud . compute . v1 . IVpnGateway [], protos . google . cloud . compute . v1 . IListVpnGatewaysRequest | null , protos . google . cloud . compute . v1 . IVpnGatewayList ]>; Parameters Name Description request protos.google.cloud.compute.v1.IListVpnGatewaysRequest options CallOptions
Returns Type Description Promise <[ protos.google.cloud.compute.v1.IVpnGateway [], protos.google.cloud.compute.v1.IListVpnGatewaysRequest | null, protos.google.cloud.compute.v1.IVpnGatewayList ]>
list(request, options, callback)
list ( request : protos . google . cloud . compute . v1 . IListVpnGatewaysRequest , options : CallOptions , callback : PaginationCallback<protos . google . cloud . compute . v1 . IListVpnGatewaysRequest , protos . google . cloud . compute . v1 . IVpnGatewayList | null | undefined , protos . google . cloud . compute . v1 . IVpnGateway >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IListVpnGatewaysRequest options CallOptions callback PaginationCallback <protos.google.cloud.compute.v1.IListVpnGatewaysRequest , protos.google.cloud.compute.v1.IVpnGatewayList | null | undefined, protos.google.cloud.compute.v1.IVpnGateway >
Returns list(request, callback)
list ( request : protos . google . cloud . compute . v1 . IListVpnGatewaysRequest , callback : PaginationCallback<protos . google . cloud . compute . v1 . IListVpnGatewaysRequest , protos . google . cloud . compute . v1 . IVpnGatewayList | null | undefined , protos . google . cloud . compute . v1 . IVpnGateway >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.IListVpnGatewaysRequest callback PaginationCallback <protos.google.cloud.compute.v1.IListVpnGatewaysRequest , protos.google.cloud.compute.v1.IVpnGatewayList | null | undefined, protos.google.cloud.compute.v1.IVpnGateway >
Returns listAsync(request, options)
listAsync ( request ?: protos . google . cloud . compute . v1 . IListVpnGatewaysRequest , options ?: CallOptions ) : AsyncIterable<protos . google . cloud . compute . v1 . IVpnGateway >; Equivalent tolist, 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.compute.v1.IListVpnGatewaysRequest The request object that will be sent.
options CallOptions Call options. SeeCallOptions for more details.
Returns Type Description AsyncIterable <protos.google.cloud.compute.v1.IVpnGateway >{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 [VpnGateway]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
Example
const iterable = client . listAsync ( request ); for await ( const response of iterable ) { // process response } listStream(request, options)
listStream ( request ?: protos . google . cloud . compute . v1 . IListVpnGatewaysRequest , options ?: CallOptions ) : Transform ; Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.
Parameters Name Description request protos.google.cloud.compute.v1.IListVpnGatewaysRequest The request object that will be sent.
options CallOptions Call options. SeeCallOptions for more details.
Returns Type Description Transform {Stream} An object stream which emits an object representing [VpnGateway] 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 usinglistAsync() 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.
setLabels(request, options)
setLabels ( request ?: protos . google . cloud . compute . v1 . ISetLabelsVpnGatewayRequest , options ?: CallOptions ) : Promise <[ LROperation<protos . google . cloud . compute . v1 . IOperation , null >, protos . google . cloud . compute . v1 . IOperation | undefined , {} | undefined ]>; Parameters Name Description request protos.google.cloud.compute.v1.ISetLabelsVpnGatewayRequest options CallOptions
Returns Type Description Promise <[LROperation <protos.google.cloud.compute.v1.IOperation , null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>
setLabels(request, options, callback)
setLabels ( request : protos . google . cloud . compute . v1 . ISetLabelsVpnGatewayRequest , options : CallOptions , callback : Callback<protos . google . cloud . compute . v1 . IOperation , protos . google . cloud . compute . v1 . ISetLabelsVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.ISetLabelsVpnGatewayRequest options CallOptions callback Callback <protos.google.cloud.compute.v1.IOperation , protos.google.cloud.compute.v1.ISetLabelsVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns setLabels(request, callback)
setLabels ( request : protos . google . cloud . compute . v1 . ISetLabelsVpnGatewayRequest , callback : Callback<protos . google . cloud . compute . v1 . IOperation , protos . google . cloud . compute . v1 . ISetLabelsVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.ISetLabelsVpnGatewayRequest callback Callback <protos.google.cloud.compute.v1.IOperation , protos.google.cloud.compute.v1.ISetLabelsVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns testIamPermissions(request, options)
testIamPermissions ( request ?: protos . google . cloud . compute . v1 . ITestIamPermissionsVpnGatewayRequest , options ?: CallOptions ) : Promise <[ protos . google . cloud . compute . v1 . ITestPermissionsResponse , ( protos . google . cloud . compute . v1 . ITestIamPermissionsVpnGatewayRequest | undefined ), {} | undefined ]>; Parameters Name Description request protos.google.cloud.compute.v1.ITestIamPermissionsVpnGatewayRequest options CallOptions
Returns Type Description Promise <[ protos.google.cloud.compute.v1.ITestPermissionsResponse , (protos.google.cloud.compute.v1.ITestIamPermissionsVpnGatewayRequest | undefined), {} | undefined ]>
testIamPermissions(request, options, callback)
testIamPermissions ( request : protos . google . cloud . compute . v1 . ITestIamPermissionsVpnGatewayRequest , options : CallOptions , callback : Callback<protos . google . cloud . compute . v1 . ITestPermissionsResponse , protos . google . cloud . compute . v1 . ITestIamPermissionsVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.ITestIamPermissionsVpnGatewayRequest options CallOptions callback Callback <protos.google.cloud.compute.v1.ITestPermissionsResponse , protos.google.cloud.compute.v1.ITestIamPermissionsVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns testIamPermissions(request, callback)
testIamPermissions ( request : protos . google . cloud . compute . v1 . ITestIamPermissionsVpnGatewayRequest , callback : Callback<protos . google . cloud . compute . v1 . ITestPermissionsResponse , protos . google . cloud . compute . v1 . ITestIamPermissionsVpnGatewayRequest | null | undefined , {} | null | undefined >) : void ; Parameters Name Description request protos.google.cloud.compute.v1.ITestIamPermissionsVpnGatewayRequest callback Callback <protos.google.cloud.compute.v1.ITestPermissionsResponse , protos.google.cloud.compute.v1.ITestIamPermissionsVpnGatewayRequest | null | undefined, {} | null | undefined>
Returns Send feedback
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License , and code samples are licensed under theApache 2.0 License . For details, see theGoogle Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.
Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-12-03 UTC."],[],[]]
