Class v1.RegionOperationsClient (4.6.0)

The RegionOperations API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of RegionOperationsClient.

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 RegionOperationsClient({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.

regionOperationsStub

regionOperationsStub?: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.

delete(request, options)

delete(request?:protos.google.cloud.compute.v1.IDeleteRegionOperationRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IDeleteRegionOperationResponse,protos.google.cloud.compute.v1.IDeleteRegionOperationRequest|undefined,{}|undefined]>;

Deletes the specified region-specific Operations resource.

Parameters
NameDescription
requestIDeleteRegionOperationRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IDeleteRegionOperationResponse,protos.google.cloud.compute.v1.IDeleteRegionOperationRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representingDeleteRegionOperationResponse. 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.   *//**   *  Name of the Operations resource to delete.   */// const operation = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'// Imports the Compute libraryconst{RegionOperationsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRegionOperationsClient();asyncfunctioncallDelete(){// Construct requestconstrequest={operation,project,region,};// Run requestconstresponse=awaitcomputeClient.delete(request);console.log(response);}callDelete();

delete(request, options, callback)

delete(request:protos.google.cloud.compute.v1.IDeleteRegionOperationRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IDeleteRegionOperationResponse,protos.google.cloud.compute.v1.IDeleteRegionOperationRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteRegionOperationRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IDeleteRegionOperationResponse,protos.google.cloud.compute.v1.IDeleteRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

delete(request, callback)

delete(request:protos.google.cloud.compute.v1.IDeleteRegionOperationRequest,callback:Callback<protos.google.cloud.compute.v1.IDeleteRegionOperationResponse,protos.google.cloud.compute.v1.IDeleteRegionOperationRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIDeleteRegionOperationRequest
callbackCallback<protos.google.cloud.compute.v1.IDeleteRegionOperationResponse,protos.google.cloud.compute.v1.IDeleteRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, options)

get(request?:protos.google.cloud.compute.v1.IGetRegionOperationRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetRegionOperationRequest|undefined,{}|undefined]>;

Retrieves the specified region-specific Operations resource.

Parameters
NameDescription
requestIGetRegionOperationRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetRegionOperationRequest | 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.   *//**   *  Name of the Operations resource to return.   */// const operation = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'// Imports the Compute libraryconst{RegionOperationsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRegionOperationsClient();asyncfunctioncallGet(){// Construct requestconstrequest={operation,project,region,};// Run requestconstresponse=awaitcomputeClient.get(request);console.log(response);}callGet();

get(request, options, callback)

get(request:protos.google.cloud.compute.v1.IGetRegionOperationRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetRegionOperationRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRegionOperationRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, callback)

get(request:protos.google.cloud.compute.v1.IGetRegionOperationRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetRegionOperationRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIGetRegionOperationRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetRegionOperationRequest | 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.v1.IListRegionOperationsRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IOperation[],protos.google.cloud.compute.v1.IListRegionOperationsRequest|null,protos.google.cloud.compute.v1.IOperationList]>;

Retrieves a list of Operation resources contained within the specified region.

Parameters
NameDescription
requestIListRegionOperationsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IOperation[],protos.google.cloud.compute.v1.IListRegionOperationsRequest | null,protos.google.cloud.compute.v1.IOperationList ]>

{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.v1.IListRegionOperationsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListRegionOperationsRequest,protos.google.cloud.compute.v1.IOperationList|null|undefined,protos.google.cloud.compute.v1.IOperation>):void;
Parameters
NameDescription
requestIListRegionOperationsRequest
optionsCallOptions
callbackPaginationCallback<protos.google.cloud.compute.v1.IListRegionOperationsRequest,protos.google.cloud.compute.v1.IOperationList | null | undefined,protos.google.cloud.compute.v1.IOperation>
Returns
TypeDescription
void

list(request, callback)

list(request:protos.google.cloud.compute.v1.IListRegionOperationsRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListRegionOperationsRequest,protos.google.cloud.compute.v1.IOperationList|null|undefined,protos.google.cloud.compute.v1.IOperation>):void;
Parameters
NameDescription
requestIListRegionOperationsRequest
callbackPaginationCallback<protos.google.cloud.compute.v1.IListRegionOperationsRequest,protos.google.cloud.compute.v1.IOperationList | null | undefined,protos.google.cloud.compute.v1.IOperation>
Returns
TypeDescription
void

listAsync(request, options)

listAsync(request?:protos.google.cloud.compute.v1.IListRegionOperationsRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IOperation>;

Equivalent tolist, but returns an iterable object.

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

Parameters
NameDescription
requestIListRegionOperationsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.IOperation>

{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.MostComputeresourcessupporttwotypesoffilterexpressions:expressionsthatsupportregularexpressionsandexpressionsthatfollowAPIimprovementproposalAIP-160.Thesetwotypesoffilterexpressionscannotbemixedinonerequest.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 `:*` 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 on resource 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 an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example:
(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)
If you want to use a regular expression, use the `eq` (equal) or `ne` (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 Google RE2 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 use `name 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 are0 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 orcreationTimestamp desc is supported./// const orderBy = 'abc123'/*
  • Specifies a page token to use. SetpageToken to thenextPageToken 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'/*
  • Name of the region for this request./// const region = 'us-central1'/*
  • 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 {RegionOperationsClient} = require('@google-cloud/compute').v1;

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

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

    // 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.v1.IListRegionOperationsRequest,options?:CallOptions):Transform;

Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
requestIListRegionOperationsRequest

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.

wait(request, options)

wait(request?:protos.google.cloud.compute.v1.IWaitRegionOperationRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitRegionOperationRequest|undefined,{}|undefined]>;

Waits for the specified Operation resource to return asDONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from theGET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might beDONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is notDONE.

Parameters
NameDescription
requestIWaitRegionOperationRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitRegionOperationRequest | 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.   *//**   *  Name of the Operations resource to return.   */// const operation = 'abc123'/**   *  Project ID for this request.   */// const project = 'my-project'/**   *  Name of the region for this request.   */// const region = 'us-central1'// Imports the Compute libraryconst{RegionOperationsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newRegionOperationsClient();asyncfunctioncallWait(){// Construct requestconstrequest={operation,project,region,};// Run requestconstresponse=awaitcomputeClient.wait(request);console.log(response);}callWait();

wait(request, options, callback)

wait(request:protos.google.cloud.compute.v1.IWaitRegionOperationRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitRegionOperationRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIWaitRegionOperationRequest
optionsCallOptions
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

wait(request, callback)

wait(request:protos.google.cloud.compute.v1.IWaitRegionOperationRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitRegionOperationRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIWaitRegionOperationRequest
callbackCallback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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.