Class v1.RegionsClient (3.9.1) Stay organized with collections Save and categorize content based on your preferences.
The Regions API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts, gaxInstance)
constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);Construct an instance of RegionsClient.
| Parameters | |
|---|---|
| Name | Description |
opts | ClientOptions |
gaxInstance | typeof gax | typeof gax.fallback: loaded instance of |
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.
regionsStub
regionsStub?:Promise<{[name:string]:Function;}>;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;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.
| Returns | |
|---|---|
| Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
get(request, options)
get(request?:protos.google.cloud.compute.v1.IGetRegionRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IRegion,protos.google.cloud.compute.v1.IGetRegionRequest|undefined,{}|undefined]>;Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (thequotas field). To exclude one or more fields, set your request'sfields query parameter to only include the fields you need. For example, to only include theid andselfLink fields, add the query parameter?fields=id,selfLink to your request.
| Parameters | |
|---|---|
| Name | Description |
request | protos.google.cloud.compute.v1.IGetRegionRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[ protos.google.cloud.compute.v1.IRegion, protos.google.cloud.compute.v1.IGetRegionRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/** * 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. *//** * Project ID for this request. */// const project = 'my-project'/** * Name of the region resource to return. */// const region = 'us-central1'// Imports the Compute libraryconst{RegionsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRegionsClient();asyncfunctioncallGet(){// Construct requestconstrequest={project,region,};// Run requestconstresponse=awaitcomputeClient.get(request);console.log(response);}callGet();get(request, options, callback)
get(request:protos.google.cloud.compute.v1.IGetRegionRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IRegion,protos.google.cloud.compute.v1.IGetRegionRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | protos.google.cloud.compute.v1.IGetRegionRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IRegion, protos.google.cloud.compute.v1.IGetRegionRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
get(request, callback)
get(request:protos.google.cloud.compute.v1.IGetRegionRequest,callback:Callback<protos.google.cloud.compute.v1.IRegion,protos.google.cloud.compute.v1.IGetRegionRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | protos.google.cloud.compute.v1.IGetRegionRequest |
callback | Callback<protos.google.cloud.compute.v1.IRegion, protos.google.cloud.compute.v1.IGetRegionRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
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 | |
|---|---|
| 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.
| Returns | |
|---|---|
| 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.IListRegionsRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IRegion[],protos.google.cloud.compute.v1.IListRegionsRequest|null,protos.google.cloud.compute.v1.IRegionList]>;Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (theitems.quotas field). To exclude one or more fields, set your request'sfields query parameter to only include the fields you need. For example, to only include theid andselfLink fields, add the query parameter?fields=id,selfLink to your request.
| Parameters | |
|---|---|
| Name | Description |
request | protos.google.cloud.compute.v1.IListRegionsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[ protos.google.cloud.compute.v1.IRegion[], protos.google.cloud.compute.v1.IListRegionsRequest | null, protos.google.cloud.compute.v1.IRegionList ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
list(request, options, callback)
list(request:protos.google.cloud.compute.v1.IListRegionsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListRegionsRequest,protos.google.cloud.compute.v1.IRegionList|null|undefined,protos.google.cloud.compute.v1.IRegion>):void;| Parameters | |
|---|---|
| Name | Description |
request | protos.google.cloud.compute.v1.IListRegionsRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListRegionsRequest, protos.google.cloud.compute.v1.IRegionList | null | undefined, protos.google.cloud.compute.v1.IRegion> |
| Returns | |
|---|---|
| Type | Description |
void | |
list(request, callback)
list(request:protos.google.cloud.compute.v1.IListRegionsRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListRegionsRequest,protos.google.cloud.compute.v1.IRegionList|null|undefined,protos.google.cloud.compute.v1.IRegion>):void;| Parameters | |
|---|---|
| Name | Description |
request | protos.google.cloud.compute.v1.IListRegionsRequest |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListRegionsRequest, protos.google.cloud.compute.v1.IRegionList | null | undefined, protos.google.cloud.compute.v1.IRegion> |
| Returns | |
|---|---|
| Type | Description |
void | |
listAsync(request, options)
listAsync(request?:protos.google.cloud.compute.v1.IListRegionsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IRegion>;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.IListRegionsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.compute.v1.IRegion> | {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 . 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. |
/** * 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. *//***Afilterexpressionthatfiltersresourceslistedintheresponse.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,anoperator,andthevaluethatyouwanttouseforfiltering.Thevaluemustbeastring,anumber,oraboolean.Theoperatormustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name!=example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: labels.owner:*
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)/ // const filter = 'abc123' /*
- The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults, Compute Engine returns anextPageTokenthat can be used to get the next page of results in subsequent list requests. Acceptable values are0to500, inclusive. (Default:500)/// const maxResults = 1234/* - Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc". This sorts results based on thecreationTimestampfield in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting bynameorcreationTimestamp descis supported./// const orderBy = 'abc123'/* - Specifies a page token to use. Set
pageTokento thenextPageTokenreturned by a previous list request to get the next page of results./// const pageToken = 'abc123'/* - Project ID for this request./// const project = 'my-project'/*
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.*/// const returnPartialSuccess = true
// Imports the Compute libraryconst {RegionsClient} = require('@google-cloud/compute').v1;
// Instantiates a clientconst computeClient = new RegionsClient();
async function callList() {// Construct requestconst request = {project,};
// Run requestconst iterable = await computeClient.listAsync(request);for await (const response of iterable) { console.log(response);}}
callList();
listStream(request, options)
listStream(request?:protos.google.cloud.compute.v1.IListRegionsRequest,options?:CallOptions):Transform;Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | protos.google.cloud.compute.v1.IListRegionsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform | {Stream} An object stream which emits an object representing 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.