Class v1.ZonesClient (3.0.0)
The Zones API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts)
constructor(opts?:ClientOptions);Construct an instance of ZonesClient.
| Name | Description |
| opts | ClientOptions |
Properties
apiEndpoint
staticgetapiEndpoint():string;The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth:gax.GoogleAuth;descriptors
descriptors:Descriptors;innerApiCalls
innerApiCalls:{[name:string]:Function;};port
staticgetport():number;The port for this API service.
scopes
staticgetscopes():string[];The scopes needed to make gRPC calls for every method defined in this service.
servicePath
staticgetservicePath():string;The DNS address for this API service.
warn
warn:(code:string,message:string,warnType?:string)=>void;zonesStub
zonesStub?:Promise<{[name:string]:Function;}>;Methods
close()
close():Promise<void>;Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Type | Description |
| Promise<void> | {Promise} A promise that resolves when the client is closed. |
get(request, options)
get(request?:protos.google.cloud.compute.v1.IGetZoneRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IZone,protos.google.cloud.compute.v1.IGetZoneRequest|undefined,{}|undefined]>;| Name | Description |
| request | protos.google.cloud.compute.v1.IGetZoneRequest |
| options | CallOptions |
| Type | Description |
| Promise<[ protos.google.cloud.compute.v1.IZone, protos.google.cloud.compute.v1.IGetZoneRequest | undefined, {} | undefined ]> |
get(request, options, callback)
get(request:protos.google.cloud.compute.v1.IGetZoneRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IZone,protos.google.cloud.compute.v1.IGetZoneRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IGetZoneRequest |
| options | CallOptions |
| callback | Callback<protos.google.cloud.compute.v1.IZone, protos.google.cloud.compute.v1.IGetZoneRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
get(request, callback)
get(request:protos.google.cloud.compute.v1.IGetZoneRequest,callback:Callback<protos.google.cloud.compute.v1.IZone,protos.google.cloud.compute.v1.IGetZoneRequest|null|undefined,{}|null|undefined>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IGetZoneRequest |
| callback | Callback<protos.google.cloud.compute.v1.IZone, protos.google.cloud.compute.v1.IGetZoneRequest | null | undefined, {} | null | undefined> |
| Type | Description |
| void |
getProjectId()
getProjectId():Promise<string>;| Type | Description |
| Promise<string> |
getProjectId(callback)
getProjectId(callback:Callback<string,undefined,undefined>):void;| Name | Description |
| callback | Callback<string, undefined, undefined> |
| Type | Description |
| void |
initialize()
initialize():Promise<{[name:string]:Function;}>;Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
| Type | Description |
| Promise<{ [name: string]:Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
list(request, options)
list(request?:protos.google.cloud.compute.v1.IListZonesRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IZone[],protos.google.cloud.compute.v1.IListZonesRequest|null,protos.google.cloud.compute.v1.IZoneList]>;| Name | Description |
| request | protos.google.cloud.compute.v1.IListZonesRequest |
| options | CallOptions |
| Type | Description |
| Promise<[ protos.google.cloud.compute.v1.IZone[], protos.google.cloud.compute.v1.IListZonesRequest | null, protos.google.cloud.compute.v1.IZoneList ]> |
list(request, options, callback)
list(request:protos.google.cloud.compute.v1.IListZonesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListZonesRequest,protos.google.cloud.compute.v1.IZoneList|null|undefined,protos.google.cloud.compute.v1.IZone>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IListZonesRequest |
| options | CallOptions |
| callback | PaginationCallback<protos.google.cloud.compute.v1.IListZonesRequest, protos.google.cloud.compute.v1.IZoneList | null | undefined, protos.google.cloud.compute.v1.IZone> |
| Type | Description |
| void |
list(request, callback)
list(request:protos.google.cloud.compute.v1.IListZonesRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListZonesRequest,protos.google.cloud.compute.v1.IZoneList|null|undefined,protos.google.cloud.compute.v1.IZone>):void;| Name | Description |
| request | protos.google.cloud.compute.v1.IListZonesRequest |
| callback | PaginationCallback<protos.google.cloud.compute.v1.IListZonesRequest, protos.google.cloud.compute.v1.IZoneList | null | undefined, protos.google.cloud.compute.v1.IZone> |
| Type | Description |
| void |
listAsync(request, options)
listAsync(request?:protos.google.cloud.compute.v1.IListZonesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IZone>;Equivalent tolist, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Name | Description |
| request | protos.google.cloud.compute.v1.IListZonesRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| AsyncIterable<protos.google.cloud.compute.v1.IZone> | {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 [Zone]. 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. |
constiterable=client.listAsync(request);forawait(constresponseofiterable){// process response}listStream(request, options)
listStream(request?:protos.google.cloud.compute.v1.IListZonesRequest,options?:CallOptions):Transform;Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.
| Name | Description |
| request | protos.google.cloud.compute.v1.IListZonesRequestThe request object that will be sent. |
| options | CallOptionsCall options. SeeCallOptions for more details. |
| Type | Description |
| Transform | {Stream} An object stream which emits an object representing [Zone] 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 |
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.