Class v1.ImagesClient (4.9.0) Stay organized with collections Save and categorize content based on your preferences.
The Images API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts, gaxInstance)
constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);Construct an instance of ImagesClient.
| 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;imagesStub
imagesStub?: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
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.IDeleteImageRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Deletes the specified image.
| Parameters | |
|---|---|
| Name | Description |
request | IDeleteImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * 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 image resource to delete. */// const image = 'abc123'/** * Project ID for this request. */// const project = 'my-project'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallDelete(){// Construct requestconstrequest={image,project,};// Run requestconstresponse=awaitcomputeClient.delete(request);console.log(response);}callDelete();delete(request, options, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
delete(request, callback)
delete(request:protos.google.cloud.compute.v1.IDeleteImageRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeleteImageRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeleteImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deprecate(request, options)
deprecate(request?:protos.google.cloud.compute.v1.IDeprecateImageRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.
| Parameters | |
|---|---|
| Name | Description |
request | IDeprecateImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * 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. *//** * The body resource for this request */// const deprecationStatusResource = {}/** * Image name. */// const image = 'abc123'/** * Project ID for this request. */// const project = 'my-project'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallDeprecate(){// Construct requestconstrequest={deprecationStatusResource,image,project,};// Run requestconstresponse=awaitcomputeClient.deprecate(request);console.log(response);}callDeprecate();deprecate(request, options, callback)
deprecate(request:protos.google.cloud.compute.v1.IDeprecateImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeprecateImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeprecateImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeprecateImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
deprecate(request, callback)
deprecate(request:protos.google.cloud.compute.v1.IDeprecateImageRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeprecateImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IDeprecateImageRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IDeprecateImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
get(request, options)
get(request?:protos.google.cloud.compute.v1.IGetImageRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetImageRequest|undefined,{}|undefined]>;Returns the specified image.
| Parameters | |
|---|---|
| Name | Description |
request | IGetImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetImageRequest | 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 image resource to return. */// const image = 'abc123'/** * Project ID for this request. */// const project = 'my-project'// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallGet(){// Construct requestconstrequest={image,project,};// Run requestconstresponse=awaitcomputeClient.get(request);console.log(response);}callGet();get(request, options, callback)
get(request:protos.google.cloud.compute.v1.IGetImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
get(request, callback)
get(request:protos.google.cloud.compute.v1.IGetImageRequest,callback:Callback<protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetImageRequest |
callback | Callback<protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getFromFamily(request, options)
getFromFamily(request?:protos.google.cloud.compute.v1.IGetFromFamilyImageRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetFromFamilyImageRequest|undefined,{}|undefined]>;Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation.
| Parameters | |
|---|---|
| Name | Description |
request | IGetFromFamilyImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetFromFamilyImageRequest | 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 image family to search for. */// const family = 'abc123'/** * The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project. */// const project = 'my-project'// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallGetFromFamily(){// Construct requestconstrequest={family,project,};// Run requestconstresponse=awaitcomputeClient.getFromFamily(request);console.log(response);}callGetFromFamily();getFromFamily(request, options, callback)
getFromFamily(request:protos.google.cloud.compute.v1.IGetFromFamilyImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetFromFamilyImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetFromFamilyImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetFromFamilyImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getFromFamily(request, callback)
getFromFamily(request:protos.google.cloud.compute.v1.IGetFromFamilyImageRequest,callback:Callback<protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetFromFamilyImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetFromFamilyImageRequest |
callback | Callback<protos.google.cloud.compute.v1.IImage,protos.google.cloud.compute.v1.IGetFromFamilyImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getIamPolicy(request, options)
getIamPolicy(request?:protos.google.cloud.compute.v1.IGetIamPolicyImageRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyImageRequest|undefined,{}|undefined]>;Gets the access control policy for a resource. May be empty if no such policy or resource exists.
| Parameters | |
|---|---|
| Name | Description |
request | IGetIamPolicyImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyImageRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingPolicy. 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. *//** * Requested IAM Policy version. */// const optionsRequestedPolicyVersion = 1234/** * Project ID for this request. */// const project = 'my-project'/** * Name or id of the resource for this request. */// const resource = 'abc123'// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallGetIamPolicy(){// Construct requestconstrequest={project,resource,};// Run requestconstresponse=awaitcomputeClient.getIamPolicy(request);console.log(response);}callGetIamPolicy();getIamPolicy(request, options, callback)
getIamPolicy(request:protos.google.cloud.compute.v1.IGetIamPolicyImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetIamPolicyImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
getIamPolicy(request, callback)
getIamPolicy(request:protos.google.cloud.compute.v1.IGetIamPolicyImageRequest,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IGetIamPolicyImageRequest |
callback | Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.IGetIamPolicyImageRequest | 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. |
insert(request, options)
insert(request?:protos.google.cloud.compute.v1.IInsertImageRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Creates an image in the specified project using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request | IInsertImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * 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. *//** * Force image creation if true. */// const forceCreate = true/** * The body resource for this request */// const imageResource = {}/** * Project ID for this request. */// const project = 'my-project'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallInsert(){// Construct requestconstrequest={imageResource,project,};// Run requestconstresponse=awaitcomputeClient.insert(request);console.log(response);}callInsert();insert(request, options, callback)
insert(request:protos.google.cloud.compute.v1.IInsertImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IInsertImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
insert(request, callback)
insert(request:protos.google.cloud.compute.v1.IInsertImageRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IInsertImageRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IInsertImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
list(request, options)
list(request?:protos.google.cloud.compute.v1.IListImagesRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IImage[],protos.google.cloud.compute.v1.IListImagesRequest|null,protos.google.cloud.compute.v1.IImageList]>;Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.
| Parameters | |
|---|---|
| Name | Description |
request | IListImagesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IImage[],protos.google.cloud.compute.v1.IListImagesRequest | null,protos.google.cloud.compute.v1.IImageList ]> | {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.IListImagesRequest,options:CallOptions,callback:PaginationCallback<protos.google.cloud.compute.v1.IListImagesRequest,protos.google.cloud.compute.v1.IImageList|null|undefined,protos.google.cloud.compute.v1.IImage>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListImagesRequest |
options | CallOptions |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListImagesRequest,protos.google.cloud.compute.v1.IImageList | null | undefined,protos.google.cloud.compute.v1.IImage> |
| Returns | |
|---|---|
| Type | Description |
void | |
list(request, callback)
list(request:protos.google.cloud.compute.v1.IListImagesRequest,callback:PaginationCallback<protos.google.cloud.compute.v1.IListImagesRequest,protos.google.cloud.compute.v1.IImageList|null|undefined,protos.google.cloud.compute.v1.IImage>):void;| Parameters | |
|---|---|
| Name | Description |
request | IListImagesRequest |
callback | PaginationCallback<protos.google.cloud.compute.v1.IListImagesRequest,protos.google.cloud.compute.v1.IImageList | null | undefined,protos.google.cloud.compute.v1.IImage> |
| Returns | |
|---|---|
| Type | Description |
void | |
listAsync(request, options)
listAsync(request?:protos.google.cloud.compute.v1.IListImagesRequest,options?:CallOptions):AsyncIterable<protos.google.cloud.compute.v1.IImage>;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 | IListImagesRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.cloud.compute.v1.IImage> | {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 {ImagesClient} = require('@google-cloud/compute').v1;
// Instantiates a clientconst computeClient = new ImagesClient();
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.IListImagesRequest,options?:CallOptions):Transform;Equivalent tomethod.name.toCamelCase(), but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request | IListImagesRequestThe 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 |
patch(request, options)
patch(request?:protos.google.cloud.compute.v1.IPatchImageRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.
| Parameters | |
|---|---|
| Name | Description |
request | IPatchImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * 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 image resource to patch. */// const image = 'abc123'/** * The body resource for this request */// const imageResource = {}/** * Project ID for this request. */// const project = 'my-project'/** * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */// const requestId = 'abc123'// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallPatch(){// Construct requestconstrequest={image,imageResource,project,};// Run requestconstresponse=awaitcomputeClient.patch(request);console.log(response);}callPatch();patch(request, options, callback)
patch(request:protos.google.cloud.compute.v1.IPatchImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IPatchImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
patch(request, callback)
patch(request:protos.google.cloud.compute.v1.IPatchImageRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | IPatchImageRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.IPatchImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
setIamPolicy(request, options)
setIamPolicy(request?:protos.google.cloud.compute.v1.ISetIamPolicyImageRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyImageRequest|undefined,{}|undefined]>;Sets the access control policy on the specified resource. Replaces any existing policy.
| Parameters | |
|---|---|
| Name | Description |
request | ISetIamPolicyImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyImageRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingPolicy. 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. *//** * The body resource for this request */// const globalSetPolicyRequestResource = {}/** * Project ID for this request. */// const project = 'my-project'/** * Name or id of the resource for this request. */// const resource = 'abc123'// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallSetIamPolicy(){// Construct requestconstrequest={globalSetPolicyRequestResource,project,resource,};// Run requestconstresponse=awaitcomputeClient.setIamPolicy(request);console.log(response);}callSetIamPolicy();setIamPolicy(request, options, callback)
setIamPolicy(request:protos.google.cloud.compute.v1.ISetIamPolicyImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISetIamPolicyImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
setIamPolicy(request, callback)
setIamPolicy(request:protos.google.cloud.compute.v1.ISetIamPolicyImageRequest,callback:Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISetIamPolicyImageRequest |
callback | Callback<protos.google.cloud.compute.v1.IPolicy,protos.google.cloud.compute.v1.ISetIamPolicyImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
setLabels(request, options)
setLabels(request?:protos.google.cloud.compute.v1.ISetLabelsImageRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.compute.v1.IOperation,null>,protos.google.cloud.compute.v1.IOperation|undefined,{}|undefined]>;Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
request | ISetLabelsImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[LROperation<protos.google.cloud.compute.v1.IOperation, null>,protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see thedocumentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/** * 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. *//** * The body resource for this request */// const globalSetLabelsRequestResource = {}/** * Project ID for this request. */// const project = 'my-project'/** * Name or id of the resource for this request. */// const resource = 'abc123'// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallSetLabels(){// Construct requestconstrequest={globalSetLabelsRequestResource,project,resource,};// Run requestconstresponse=awaitcomputeClient.setLabels(request);console.log(response);}callSetLabels();setLabels(request, options, callback)
setLabels(request:protos.google.cloud.compute.v1.ISetLabelsImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetLabelsImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISetLabelsImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetLabelsImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
setLabels(request, callback)
setLabels(request:protos.google.cloud.compute.v1.ISetLabelsImageRequest,callback:Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetLabelsImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ISetLabelsImageRequest |
callback | Callback<protos.google.cloud.compute.v1.IOperation,protos.google.cloud.compute.v1.ISetLabelsImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
testIamPermissions(request, options)
testIamPermissions(request?:protos.google.cloud.compute.v1.ITestIamPermissionsImageRequest,options?:CallOptions):Promise<[protos.google.cloud.compute.v1.ITestPermissionsResponse,(protos.google.cloud.compute.v1.ITestIamPermissionsImageRequest|undefined),{}|undefined]>;Returns permissions that a caller has on the specified resource.
| Parameters | |
|---|---|
| Name | Description |
request | ITestIamPermissionsImageRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.cloud.compute.v1.ITestPermissionsResponse, (protos.google.cloud.compute.v1.ITestIamPermissionsImageRequest | undefined), {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representingTestPermissionsResponse. 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. *//** * Project ID for this request. */// const project = 'my-project'/** * Name or id of the resource for this request. */// const resource = 'abc123'/** * The body resource for this request */// const testPermissionsRequestResource = {}// Imports the Compute libraryconst{ImagesClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImagesClient();asyncfunctioncallTestIamPermissions(){// Construct requestconstrequest={project,resource,testPermissionsRequestResource,};// Run requestconstresponse=awaitcomputeClient.testIamPermissions(request);console.log(response);}callTestIamPermissions();testIamPermissions(request, options, callback)
testIamPermissions(request:protos.google.cloud.compute.v1.ITestIamPermissionsImageRequest,options:CallOptions,callback:Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ITestIamPermissionsImageRequest |
options | CallOptions |
callback | Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsImageRequest | null | undefined, {} | null | undefined> |
| Returns | |
|---|---|
| Type | Description |
void | |
testIamPermissions(request, callback)
testIamPermissions(request:protos.google.cloud.compute.v1.ITestIamPermissionsImageRequest,callback:Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsImageRequest|null|undefined,{}|null|undefined>):void;| Parameters | |
|---|---|
| Name | Description |
request | ITestIamPermissionsImageRequest |
callback | Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse,protos.google.cloud.compute.v1.ITestIamPermissionsImageRequest | 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.