List images in a project
Stay organized with collections
Save and categorize content based on your preferences.
This sample demonstrates how to list all the images available in a given project.
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[[["\u003cp\u003eThis content demonstrates how to retrieve a list of all available images within a specified Google Cloud project using Java and Python.\u003c/p\u003e\n"],["\u003cp\u003eThe code samples provided utilize the Compute Engine client libraries for Java and Python to interact with the Google Cloud API.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication to Compute Engine is required and can be set up using Application Default Credentials.\u003c/p\u003e\n"],["\u003cp\u003eThe sample code showcases the use of the \u003ccode\u003eImagesClient\u003c/code\u003e in both Java and Python to list the project's images by project id.\u003c/p\u003e\n"]]],[],null,["# List images in a project\n\nThis sample demonstrates how to list all the images available in a given project.\n\nCode sample\n-----------\n\n### Java\n\n\nBefore trying this sample, follow the Java setup instructions in the\n[Compute Engine quickstart using\nclient libraries](/compute/docs/api/using-libraries).\n\n\nFor more information, see the\n[Compute Engine Java API\nreference documentation](/java/docs/reference/google-cloud-compute/latest/overview).\n\n\nTo authenticate to Compute Engine, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n\n import com.google.cloud.compute.v1.https://cloud.google.com/java/docs/reference/google-cloud-compute/latest/com.google.cloud.compute.v1.Image.html;\n import com.google.cloud.compute.v1.https://cloud.google.com/java/docs/reference/google-cloud-compute/latest/com.google.cloud.compute.v1.ImagesClient.html;\n import com.google.cloud.compute.v1.https://cloud.google.com/java/docs/reference/google-cloud-compute/latest/com.google.cloud.compute.v1.ListImagesRequest.html;\n import com.google.common.collect.Lists;\n import java.io.IOException;\n import java.util.ArrayList;\n import java.util.List;\n\n public class ListImages {\n public static void main(String[] args) throws IOException {\n // TODO(developer): Replace these variables before running the sample.\n // Project ID or project number of the Google Cloud project you want to use.\n String projectId = \"your-project-id\";\n\n listImages(projectId);\n }\n\n // Retrieve a list of images available in given project.\n public static List\u003cImage\u003e listImages(String projectId) throws IOException {\n // Initialize client that will be used to send requests. This client only needs to be created\n // once, and can be reused for multiple requests.\n try (https://cloud.google.com/java/docs/reference/google-cloud-compute/latest/com.google.cloud.compute.v1.ImagesClient.html client = https://cloud.google.com/java/docs/reference/google-cloud-compute/latest/com.google.cloud.compute.v1.ImagesClient.html.create()) {\n https://cloud.google.com/java/docs/reference/google-cloud-compute/latest/com.google.cloud.compute.v1.ListImagesRequest.html request = https://cloud.google.com/java/docs/reference/google-cloud-compute/latest/com.google.cloud.compute.v1.ListImagesRequest.html.newBuilder()\n .setProject(projectId)\n .build();\n\n ArrayList\u003cImage\u003e images = Lists.newArrayList(client.list(request).iterateAll());\n\n System.out.printf(\"'%s' images has been retrieved successfully\", images.size());\n\n return images;\n }\n }\n }\n\n### Python\n\n\nBefore trying this sample, follow the Python setup instructions in the\n[Compute Engine quickstart using\nclient libraries](/compute/docs/api/using-libraries).\n\n\nFor more information, see the\n[Compute Engine Python API\nreference documentation](/python/docs/reference/compute/latest).\n\n\nTo authenticate to Compute Engine, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n from __future__ import annotations\n\n from collections.abc import Iterable\n\n from google.cloud import compute_v1\n\n\n def list_images(project_id: str) -\u003e Iterable[compute_v1.Image]:\n \"\"\"\n Retrieve a list of images available in given project.\n\n Args:\n project_id: project ID or project number of the Cloud project you want to list images from.\n\n Returns:\n An iterable collection of compute_v1.Image objects.\n \"\"\"\n image_client = compute_v1.ImagesClient()\n return image_client.list(project=project_id)\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=compute)."]]
