Class v1beta.RegionsClient (6.5.0)

The Regions API. v1beta

Package

@google-cloud/compute

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);

Construct an instance of RegionsClient.

Parameters
NameDescription
optsClientOptions
gaxInstancetypeofgax | typeoffallback

: loaded instance ofgoogle-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new RegionsClient({fallback: true}, gax); ```

Properties

apiEndpoint

getapiEndpoint():string;

The DNS address for this API service.

apiEndpoint

staticgetapiEndpoint():string;

The DNS address for this API service - same as servicePath.

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.

universeDomain

getuniverseDomain():string;

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

get(request, options)

get(request?:protos.google.cloud.compute.v1beta.IGetRegionRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1beta.IRegion,protos.google.cloud.compute.v1beta.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.

This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (theitems.quotas field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

Parameters
NameDescription
requestIGetRegionRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1beta.IRegion,protos.google.cloud.compute.v1beta.IGetRegionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation 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.   *//**   *  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').v1beta;// 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.v1beta.IGetRegionRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1beta.IRegion,protos.google.cloud.compute.v1beta.IGetRegionRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRegionRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1beta.IRegion,protos.google.cloud.compute.v1beta.IGetRegionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, callback)

get(request:protos.google.cloud.compute.v1beta.IGetRegionRequest,callback:Callback<protos.google.cloud.compute.v1beta.IRegion,protos.google.cloud.compute.v1beta.IGetRegionRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRegionRequest
callbackCallback<protos.google.cloud.compute.v1beta.IRegion,protos.google.cloud.compute.v1beta.IGetRegionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId():Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback:Callback<string,undefined,undefined>):void;
Parameter
NameDescription
callbackCallback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]:Function; }>

{Promise} A promise that resolves to an authenticated service stub.

list(request, options)

list(request?:protos.google.cloud.compute.v1beta.IListRegionsRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1beta.IRegion[],protos.google.cloud.compute.v1beta.IListRegionsRequest|null,protos.google.cloud.compute.v1beta.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.

This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (theitems.quotas field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

Parameters
NameDescription
requestIListRegionsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1beta.IRegion[],protos.google.cloud.compute.v1beta.IListRegionsRequest | null,protos.google.cloud.compute.v1beta.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 usinglistAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

list(request, options, callback)

list(request:protos.google.cloud.compute.v1beta.IListRegionsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1beta.IListRegionsRequest,protos.google.cloud.compute.v1beta.IRegionList|null|undefined,protos.google.cloud.compute.v1beta.IRegion>):void;
Parameters
NameDescription
requestIListRegionsRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.compute.v1beta.IListRegionsRequest,protos.google.cloud.compute.v1beta.IRegionList | null | undefined,protos.google.cloud.compute.v1beta.IRegion>
Returns
TypeDescription
void

list(request, callback)

list(request:protos.google.cloud.compute.v1beta.IListRegionsRequest,callback:PaginationCallback<protos.google.cloud.compute.v1beta.IListRegionsRequest,protos.google.cloud.compute.v1beta.IRegionList|null|undefined,protos.google.cloud.compute.v1beta.IRegion>):void;
Parameters
NameDescription
requestIListRegionsRequest
callbackPaginationCallback<protos.google.cloud.compute.v1beta.IListRegionsRequest,protos.google.cloud.compute.v1beta.IRegionList | null | undefined,protos.google.cloud.compute.v1beta.IRegion>
Returns
TypeDescription
void

listAsync(request, options)

listAsync(request?:protos.google.cloud.compute.v1beta.IListRegionsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1beta.IRegion>;

Equivalent tolist, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
requestIListRegionsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1beta.IRegion>

{Object} An iterable Object that allowsasync iteration. 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 thedocumentation 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.   *//***Afilterexpressionthatfiltersresourceslistedintheresponse.Most*Computeresourcessupporttwotypesoffilterexpressions:*expressionsthatsupportregularexpressionsandexpressionsthatfollow*APIimprovementproposalAIP-160.*Thesetwotypesoffilterexpressionscannotbemixedinonerequest.*IfyouwanttouseAIP-160,yourexpressionmustspecifythefieldname,an*operator,andthevaluethatyouwanttouseforfiltering.Thevalue*mustbeastring,anumber,oraboolean.Theoperator*mustbeeither`=`,`!=`,`>`,`<`,><=`, `="">=` or `:`.   *  For example, if you are filtering Compute Engine instances, you can   *  exclude instances named `example-instance` by specifying   *  `name!=example-instance`.   *  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:*   *
  • You can also filter nested fields. For example, you could specify
  • scheduling.automaticRestart = false to include instances only
  • if they are not scheduled for automatic restarts. You can use filtering
  • on nested fields to filter based onresource labels.
  • To filter on multiple expressions, provide each separate expression within
  • parentheses. For example:
  • (scheduling.automaticRestart = true)
  • (cpuPlatform = "Intel Skylake")
  • By default, each expression is anAND expression. However, you
  • can includeAND andOR expressions explicitly.
  • For example:
  • (cpuPlatform = "Intel Skylake") OR
  • (cpuPlatform = "Intel Broadwell") AND
  • (scheduling.automaticRestart = true)
  • If you want to use a regular expression, use theeq (equal) orne
  • (not equal) operator against a single un-parenthesized expression with or
  • without quotes or against multiple parenthesized expressions. Examples:
  • fieldname eq unquoted literal
  • fieldname eq 'single quoted literal'
  • fieldname eq "double quoted literal"
  • (fieldname1 eq literal) (fieldname2 ne "literal")
  • The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
  • The literal value must match the entire field.
  • For example, to filter for instances that do not end with name "instance",
  • you would usename ne .*instance.
  • You cannot combine constraints on multiple fields using regular
  • expressions./// const filter = 'abc123'/*
  • The maximum number of results per page that should be returned.
  • If the number of available results is larger thanmaxResults,
  • Compute Engine returns anextPageToken that can be used to get
  • the next page of results in subsequent list requests. Acceptable values are
  • 0 to500, 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 usingorderBy="creationTimestamp desc". This sorts
  • results based on thecreationTimestamp field 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 byname or
  • creationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to the
  • nextPageToken returned 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.
  • For example, when partial success behavior is enabled, aggregatedList for a
  • single zone scope either returns all resources in the zone or no resources,
  • with an error code.*/// const returnPartialSuccess = true

    // Imports the Compute libraryconst {RegionsClient} = require('@google-cloud/compute').v1beta;

    // Instantiates a clientconst computeClient = new RegionsClient();

    async function callList() {// Construct requestconst request = {project,};

    // Run requestconst iterable = computeClient.listAsync(request);for await (const response of iterable) { console.log(response);}}

    callList();

listStream(request, options)

listStream(request?:protos.google.cloud.compute.v1beta.IListRegionsRequest,options?:CallOptions):Transform;

Equivalent tolist, but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListRegionsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
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 usinglistAsync() method described below for async iteration which you can stop as needed. Please see thedocumentation for more details and examples.

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.