Class v1.GlobalOperationsClient (4.8.0) Stay organized with collections Save and categorize content based on your preferences.
The GlobalOperations API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts, gaxInstance)
constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);Construct an instance of GlobalOperationsClient.
| Parameters | |
|---|---|
| Name | Description |
opts | ClientOptions |
gaxInstance | typeofgax | typeoffallback: loaded instance of |
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;globalOperationsStub
globalOperationsStub?:Promise<{[name:string]:Function;}>;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.
universeDomain
getuniverseDomain():string;warn
warn:(code:string,message:string,warnType?:string)=>void;Methods
aggregatedListAsync(request, options)
aggregatedListAsync(request?:protos.google.cloud.compute.v1.IAggregatedListGlobalOperationsRequest,options?:CallOptions):AsyncIterable<[string,protos.google.cloud.compute.v1.IOperationsScopedList]>;Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set thereturnPartialSuccess parameter totrue.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request | IAggregatedListGlobalOperationsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<[ string,protos.google.cloud.compute.v1.IOperationsScopedList ]> | {Object} An iterable Object that allowsasync iteration. When you iterate the returned iterable, each element will be an object representing as tuple [string,OperationsScopedList]. 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. |
/** * 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:*
(scheduling.automaticRestart=true)(cpuPlatform="Intel Skylake")(cpuPlatform="Intel Skylake")OR(cpuPlatform="Intel Broadwell")AND(scheduling.automaticRestart=true)/ // const filter = 'abc123' /*
- Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included./// const includeAllScopes = true/*
- 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. 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/*
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.*/// const serviceProjectNumber = 1234
// Imports the Compute libraryconst {GlobalOperationsClient} = require('@google-cloud/compute').v1;
// Instantiates a clientconst computeClient = new GlobalOperationsClient();
async function callAggregatedList() {// Construct requestconst request = {project,};
// Run requestconst iterable = computeClient.aggregatedListAsync(request);for await (const [key, value] of iterable) { console.log(response);}}
callAggregatedList();
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. |
delete(request, options)
delete(request?:protos.google.cloud.compute.v1.IDeleteGlobalOperationRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IDeleteGlobalOperationResponse,protos.google.cloud.compute.v1.IDeleteGlobalOperationRequest|undefined,{}|undefined]>;Deletes the specified Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | IDeleteGlobalOperationRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IDeleteGlobalOperationResponse,protos.google.cloud.compute.v1.IDeleteGlobalOperationRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingDeleteGlobalOperationResponse. Please see thedocumentation 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. *//** * Name of the Operations resource to delete, or its unique numeric identifier. */// const operation = 'abc123'/** * Project ID for this request. */// const project = 'my-project'// Imports the Compute libraryconst{GlobalOperationsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newGlobalOperationsClient();asyncfunctioncallDelete(){// Construct requestconstrequest={operation,project,};// Run requestconstresponse=awaitcomputeClient.delete(request);console.log(response);}callDelete();delete(request, options, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteGlobalOperationRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IDeleteGlobalOperationResponse,protos.google.cloud.compute.v1.IDeleteGlobalOperationRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteGlobalOperationRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IDeleteGlobalOperationResponse,protos.google.cloud.compute.v1.IDeleteGlobalOperationRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
delete(request, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteGlobalOperationRequest,callback:Callback<protos.google.cloud.compute.v1.IDeleteGlobalOperationResponse,protos.google.cloud.compute.v1.IDeleteGlobalOperationRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteGlobalOperationRequest |
callback | Callback<protos.google.cloud.compute.v1.IDeleteGlobalOperationResponse,protos.google.cloud.compute.v1.IDeleteGlobalOperationRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
get(request, options)
get(request?:protos.google.cloud.compute.v1.IGetGlobalOperationRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetGlobalOperationRequest|undefined,{}|undefined]>;Retrieves the specified Operations resource.
| Parameters | |
|---|---|
| Name | Description |
request | IGetGlobalOperationRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetGlobalOperationRequest | 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. |
/** * 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, or its unique numeric identifier. */// const operation = 'abc123'/** * Project ID for this request. */// const project = 'my-project'// Imports the Compute libraryconst{GlobalOperationsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newGlobalOperationsClient();asyncfunctioncallGet(){// Construct requestconstrequest={operation,project,};// Run requestconstresponse=awaitcomputeClient.get(request);console.log(response);}callGet();get(request, options, callback)
get(request:protos.google.cloud.compute.v1.IGetGlobalOperationRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetGlobalOperationRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetGlobalOperationRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetGlobalOperationRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
get(request, callback)
get(request:protos.google.cloud.compute.v1.IGetGlobalOperationRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetGlobalOperationRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetGlobalOperationRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IGetGlobalOperationRequest | 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.IListGlobalOperationsRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IOperation[],protos.google.cloud.compute.v1.IListGlobalOperationsRequest|null,protos.google.cloud.compute.v1.IOperationList]>;Retrieves a list of Operation resources contained within the specified project.
| Parameters | |
|---|---|
| Name | Description |
request | IListGlobalOperationsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IOperation[],protos.google.cloud.compute.v1.IListGlobalOperationsRequest | 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 using |
list(request, options, callback)
list(request:protos.google.cloud.compute.v1.IListGlobalOperationsRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListGlobalOperationsRequest,protos.google.cloud.compute.v1.IOperationList|null|undefined,protos.google.cloud.compute.v1.IOperation>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListGlobalOperationsRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListGlobalOperationsRequest,protos.google.cloud.compute.v1.IOperationList | null | undefined,protos.google.cloud.compute.v1.IOperation> |
| Returns | |
|---|---|
| Type | Description |
void | |
list(request, callback)
list(request:protos.google.cloud.compute.v1.IListGlobalOperationsRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListGlobalOperationsRequest,protos.google.cloud.compute.v1.IOperationList|null|undefined,protos.google.cloud.compute.v1.IOperation>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListGlobalOperationsRequest |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListGlobalOperationsRequest,protos.google.cloud.compute.v1.IOperationList | null | undefined,protos.google.cloud.compute.v1.IOperation> |
| Returns | |
|---|---|
| Type | Description |
void | |
listAsync(request, options)
listAsync(request?:protos.google.cloud.compute.v1.IListGlobalOperationsRequest,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 | |
|---|---|
| Name | Description |
request | IListGlobalOperationsRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
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. |
/** * 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:*
(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. 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 {GlobalOperationsClient} = require('@google-cloud/compute').v1;
// Instantiates a clientconst computeClient = new GlobalOperationsClient();
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.v1.IListGlobalOperationsRequest,options?:CallOptions):Transform;Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListGlobalOperationsRequestThe 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 |
wait(request, options)
wait(request?:protos.google.cloud.compute.v1.IWaitGlobalOperationRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitGlobalOperationRequest|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 | |
|---|---|
| Name | Description |
request | IWaitGlobalOperationRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitGlobalOperationRequest | 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. |
/** * 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, or its unique numeric identifier. */// const operation = 'abc123'/** * Project ID for this request. */// const project = 'my-project'// Imports the Compute libraryconst{GlobalOperationsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newGlobalOperationsClient();asyncfunctioncallWait(){// Construct requestconstrequest={operation,project,};// Run requestconstresponse=awaitcomputeClient.wait(request);console.log(response);}callWait();wait(request, options, callback)
wait(request:protos.google.cloud.compute.v1.IWaitGlobalOperationRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitGlobalOperationRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IWaitGlobalOperationRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitGlobalOperationRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
wait(request, callback)
wait(request:protos.google.cloud.compute.v1.IWaitGlobalOperationRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitGlobalOperationRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IWaitGlobalOperationRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IWaitGlobalOperationRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
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.