List all non-deprecated images in a project

Get a list of all non-deprecated images available in a specified project.

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

C#

Before trying this sample, follow the C# setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine C# API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  using 
  
  Google.Cloud.Compute.V1 
 
 ; 
 using 
  
 System 
 ; 
 using 
  
 System.Threading.Tasks 
 ; 
 public 
  
 class 
  
 ListImagesAsyncSample 
 { 
  
 public 
  
 async 
  
 Task 
  
 ListImagesAsync 
 ( 
  
 // TODO(developer): Set your own default values for these parameters or pass different values when calling this method. 
  
 string 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ) 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
  ImagesClient 
 
  
 client 
  
 = 
  
 await 
  
  ImagesClient 
 
 . 
  CreateAsync 
 
 (); 
  
 // Make the request to list all non-deprecated images in a project. 
  
  ListImagesRequest 
 
  
 request 
  
 = 
  
 new 
  
  ListImagesRequest 
 
  
 { 
  
 Project 
  
 = 
  
 projectId 
 , 
  
 // Listing only non-deprecated images to reduce the size of the reply. 
  
 Filter 
  
 = 
  
 "deprecated.state != DEPRECATED" 
 , 
  
 // MaxResults indicates the maximum number of items that will be returned per page. 
  
 MaxResults 
  
 = 
  
 100 
  
 }; 
  
 // Although the MaxResults parameter is specified in the request, the sequence returned 
  
 // by the ListAsync() method hides the pagination mechanic. The library makes multiple 
  
 // requests to the API for you, so you can simply iterate over all the images. 
  
 await 
  
 foreach 
  
 ( 
 var 
  
 image 
  
 in 
  
 client 
 . 
  ListAsync 
 
 ( 
 request 
 )) 
  
 { 
  
 // The result is an Image collection. 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Image: {image.Name}" 
 ); 
  
 } 
  
 } 
 }

Go

Before trying this sample, follow the Go setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Go API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 computepb 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
  
 "google.golang.org/api/iterator" 
  
 "google.golang.org/protobuf/proto" 
 ) 
 // printImagesList prints a list of all non-deprecated image names available in given project. 
 func 
  
 printImagesList 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "your_project_id" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 imagesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewImagesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewImagesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 imagesClient 
 . 
 Close 
 () 
  
 // Listing only non-deprecated images to reduce the size of the reply. 
  
 req 
  
 := 
  
& computepb 
 . 
 ListImagesRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 MaxResults 
 : 
  
 proto 
 . 
 Uint32 
 ( 
 3 
 ), 
  
 Filter 
 : 
  
 proto 
 . 
 String 
 ( 
 "deprecated.state != DEPRECATED" 
 ), 
  
 } 
  
 // Although the `MaxResults` parameter is specified in the request, the iterator returned 
  
 // by the `list()` method hides the pagination mechanic. The library makes multiple 
  
 // requests to the API for you, so you can simply iterate over all the images. 
  
 it 
  
 := 
  
 imagesClient 
 . 
 List 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 image 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
  Done 
 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "- %s\n" 
 , 
  
 image 
 . 
 GetName 
 ()) 
  
 } 
  
 return 
  
 nil 
 }

Java

Before trying this sample, follow the Java setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Java API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 com.google.cloud.compute.v1. Image 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. ImagesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. ImagesClient 
.ListPage 
 ; 
 import 
  
 com.google.cloud.compute.v1. ListImagesRequest 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
  
 // Prints a list of all non-deprecated image names available in given project. 
  
 public 
  
 static 
  
 void 
  
 listImages 
 ( 
 String 
  
 project 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. After completing all of your requests, call 
  
 // the `instancesClient.close()` method on the client to 
  
 // safely clean up any remaining background resources. 
  
 try 
  
 ( 
  ImagesClient 
 
  
 imagesClient 
  
 = 
  
  ImagesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 // Listing only non-deprecated images to reduce the size of the reply. 
  
  ListImagesRequest 
 
  
 imagesRequest 
  
 = 
  
  ListImagesRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 project 
 ) 
  
 . 
 setMaxResults 
 ( 
 100 
 ) 
  
 . 
 setFilter 
 ( 
 "deprecated.state != DEPRECATED" 
 ) 
  
 . 
 build 
 (); 
  
 // Although the `setMaxResults` parameter is specified in the request, the iterable returned 
  
 // by the `list()` method hides the pagination mechanic. The library makes multiple 
  
 // requests to the API for you, so you can simply iterate over all the images. 
  
 int 
  
 imageCount 
  
 = 
  
 0 
 ; 
  
 for 
  
 ( 
  Image 
 
  
 image 
  
 : 
  
 imagesClient 
 . 
 list 
 ( 
 imagesRequest 
 ). 
 iterateAll 
 ()) 
  
 { 
  
 imageCount 
 ++ 
 ; 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 image 
 . 
 getName 
 ()); 
  
 } 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Image count in %s is: %s" 
 , 
  
 project 
 , 
  
 imageCount 
 ); 
  
 } 
  
 }

Node.js

Before trying this sample, follow the Node.js setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Node.js API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  /** 
 * TODO(developer): Uncomment and replace these variables before running the sample. 
 */ 
 // const projectId = 'YOUR_PROJECT_ID'; 
 const 
  
 compute 
  
 = 
  
 require 
 ( 
 ' @google-cloud/compute 
' 
 ); 
 async 
  
 function 
  
 listImages 
 () 
  
 { 
  
 const 
  
 imagesClient 
  
 = 
  
 new 
  
 compute 
 . 
  ImagesClient 
 
 (); 
  
 // Listing only non-deprecated images to reduce the size of the reply. 
  
 const 
  
 images 
  
 = 
  
 imagesClient 
 . 
 listAsync 
 ({ 
  
 project 
 : 
  
 projectId 
 , 
  
 maxResults 
 : 
  
 3 
 , 
  
 filter 
 : 
  
 'deprecated.state != DEPRECATED' 
 , 
  
 }); 
  
 // Although the `maxResults` parameter is specified in the request, the iterable returned 
  
 // by the `listAsync()` method hides the pagination mechanic. The library makes multiple 
  
 // requests to the API for you, so you can simply iterate over all the images. 
  
 for 
  
 await 
  
 ( 
 const 
  
 image 
  
 of 
  
 images 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 ` - 
 ${ 
 image 
 . 
 name 
 } 
 ` 
 ); 
  
 } 
 } 
 listImages 
 ();

PHP

Before trying this sample, follow the PHP setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine PHP API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  use Google\Cloud\Compute\V1\Client\ImagesClient; 
 use Google\Cloud\Compute\V1\ListImagesRequest; 
 /** 
 * Prints a list of all non-deprecated image names available in given project. 
 * 
 * @param string $projectId Project ID or project number of the Cloud project you want to list images from. 
 * 
 * @throws \Google\ApiCore\ApiException if the remote call fails. 
 */ 
 function list_all_images(string $projectId) 
 { 
 $imagesClient = new ImagesClient(); 
 // Listing only non-deprecated images to reduce the size of the reply. 
 $optionalArgs = ['maxResults' => 100, 'filter' => 'deprecated.state != DEPRECATED']; 
 /** 
 * Although the maxResults parameter is specified in the request, the iterateAllElements() method 
 * hides the pagination mechanic. The library makes multiple requests to the API for you, 
 * so you can simply iterate over all the images. 
 */ 
 $request = (new ListImagesRequest()) 
 ->setProject($projectId) 
 ->setMaxResults($optionalArgs['maxResults']) 
 ->setFilter($optionalArgs['filter']); 
 $pagedResponse = $imagesClient->list($request); 
 print('=================== Flat list of images ===================' . PHP_EOL); 
 foreach ($pagedResponse->iterateAllElements() as $element) { 
 printf(' - %s' . PHP_EOL, $element->getName()); 
 } 
 }

Python

Before trying this sample, follow the Python setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Python API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 google.cloud.compute_v1 
  
 as 
  
 compute_v1 
 def 
  
 print_images_list 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 : 
  
 """ 
 Prints a list of all non-deprecated image names available in given project. 
 Args: 
 project: project ID or project number of the Cloud project you want to list images from. 
 Returns: 
 The output as a string. 
 """ 
 images_client 
 = 
 compute_v1 
 . 
 ImagesClient 
 () 
 # Listing only non-deprecated images to reduce the size of the reply. 
 images_list_request 
 = 
 compute_v1 
 . 
 ListImagesRequest 
 ( 
 project 
 = 
 project 
 , 
 max_results 
 = 
 100 
 , 
 filter 
 = 
 "deprecated.state != DEPRECATED" 
 ) 
 output 
 = 
 [] 
 # Although the `max_results` parameter is specified in the request, the iterable returned 
 # by the `list()` method hides the pagination mechanic. The library makes multiple 
 # requests to the API for you, so you can simply iterate over all the images. 
 for 
 img 
 in 
 images_client 
 . 
 list 
 ( 
 request 
 = 
 images_list_request 
 ): 
 print 
 ( 
 f 
 " - 
 { 
 img 
 . 
 name 
 } 
 " 
 ) 
 output 
 . 
 append 
 ( 
 f 
 " - 
 { 
 img 
 . 
 name 
 } 
 " 
 ) 
 return 
 " 
 \n 
 " 
 . 
 join 
 ( 
 output 
 )

Ruby

Before trying this sample, follow the Ruby setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Ruby API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  require 
  
 "google/cloud/compute/v1" 
 # Prints a list of all non-deprecated image names available in given project. 
 # 
 # @param [String] project project ID or project number of the Cloud project you want to list images from. 
 def 
  
 print_images_list 
  
 project 
 : 
  
 client 
  
 = 
  
 :: 
 Google 
 :: 
 Cloud 
 :: 
 Compute 
 :: 
 V1 
 :: 
 Images 
 :: 
 Rest 
 :: 
 Client 
 . 
 new 
  
 # Make the request to list all non-deprecated images in a project. 
  
 request 
  
 = 
  
 { 
  
 project 
 : 
  
 project 
 , 
  
 # max_results indicates the maximum number of items that will be returned per page. 
  
 max_results 
 : 
  
 100 
 , 
  
 # Listing only non-deprecated images to reduce the size of the reply. 
  
 filter 
 : 
  
 "deprecated.state != DEPRECATED" 
  
 } 
  
 # Although the `max_results` parameter is specified in the request, the iterable returned 
  
 # by the `list` method hides the pagination mechanic. The library makes multiple 
  
 # requests to the API for you, so you can simply iterate over all the images. 
  
 client 
 . 
 list 
 ( 
 request 
 ) 
 . 
 each 
  
 do 
  
 | 
 image 
 | 
  
 puts 
  
 " - 
 #{ 
 image 
 . 
 name 
 } 
 " 
  
 end 
 end

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

List all non-deprecated images in a project Stay organized with collections Save and categorize content based on your preferences.

Explore further

Code sample

C#

Go

Java

Node.js

PHP

Python

Ruby

What's next

List all non-deprecated images in a project