Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

ImageSummary

Type: object

ImageSummary is the list view of an image. uid must equal the immutable resource ID in name
captureMode

Schema: CaptureMode

capture_mode records whether captured content includes memory.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/CaptureMode",
  "description": "capture_mode records whether captured content includes memory."
}
createdAt · required

Schema: Timestamp

created_at is the creation timestamp.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Timestamp",
  "description": "created_at is the creation timestamp."
}
displayName

Type: string

display_name is a scoped label and never selects the resource.
All schema constraints and annotations
{
  "description": "display_name is a scoped label and never selects the resource.",
  "type": "string"
}
imageDigest

Type: string

image_digest is the content digest when known.
All schema constraints and annotations
{
  "description": "image_digest is the content digest when known.",
  "type": "string"
}
imageRef

Type: string

image_ref is the registry or backend image reference when available.
All schema constraints and annotations
{
  "description": "image_ref is the registry or backend image reference when available.",
  "type": "string"
}
name · required

Type: string

name ends in the immutable backing ID and never changes with display_name.
All schema constraints and annotations
{
  "description": "name ends in the immutable backing ID and never changes with display_name.",
  "pattern": "^images/[^/]+$",
  "type": "string"
}
platform

Schema: Platform

platform is the image platform.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Platform",
  "description": "platform is the image platform."
}
source

Schema: ImageSource

source records how the image was created.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/ImageSource",
  "description": "source records how the image was created."
}
status · required

Schema: ImageStatus

status is the image readiness state.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/ImageStatus",
  "description": "status is the image readiness state.",
  "not": {
    "enum": [
      "unspecified"
    ]
  }
}
totalSizeBytes

Type: integer | string

total_size_bytes is the approximate stored image size.
All schema constraints and annotations
{
  "description": "total_size_bytes is the approximate stored image size.",
  "format": "int64",
  "type": [
    "integer",
    "string"
  ]
}
uid · required · response only

Type: string

(IMMUTABLE) uid is the existing backing ID, equal to the resource name's terminal segment.
All schema constraints and annotations
{
  "description": "(IMMUTABLE) uid is the existing backing ID, equal to the resource name's terminal segment.",
  "minLength": 1,
  "readOnly": true,
  "type": [
    "string"
  ]
}
updatedAt · required

Schema: Timestamp

updated_at is the last update timestamp.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Timestamp",
  "description": "updated_at is the last update timestamp."
}
All schema constraints and annotations
{
  "description": "ImageSummary is the list view of an image.\nuid must equal the immutable resource ID in name",
  "properties": {
    "captureMode": {
      "$ref": "#/components/schemas/CaptureMode",
      "description": "capture_mode records whether captured content includes memory."
    },
    "createdAt": {
      "$ref": "#/components/schemas/Timestamp",
      "description": "created_at is the creation timestamp."
    },
    "displayName": {
      "description": "display_name is a scoped label and never selects the resource.",
      "type": "string"
    },
    "imageDigest": {
      "description": "image_digest is the content digest when known.",
      "type": "string"
    },
    "imageRef": {
      "description": "image_ref is the registry or backend image reference when available.",
      "type": "string"
    },
    "name": {
      "description": "name ends in the immutable backing ID and never changes with display_name.",
      "pattern": "^images/[^/]+$",
      "type": "string"
    },
    "platform": {
      "$ref": "#/components/schemas/Platform",
      "description": "platform is the image platform."
    },
    "source": {
      "$ref": "#/components/schemas/ImageSource",
      "description": "source records how the image was created."
    },
    "status": {
      "$ref": "#/components/schemas/ImageStatus",
      "description": "status is the image readiness state.",
      "not": {
        "enum": [
          "unspecified"
        ]
      }
    },
    "totalSizeBytes": {
      "description": "total_size_bytes is the approximate stored image size.",
      "format": "int64",
      "type": [
        "integer",
        "string"
      ]
    },
    "uid": {
      "description": "(IMMUTABLE) uid is the existing backing ID, equal to the resource name's terminal segment.",
      "minLength": 1,
      "readOnly": true,
      "type": [
        "string"
      ]
    },
    "updatedAt": {
      "$ref": "#/components/schemas/Timestamp",
      "description": "updated_at is the last update timestamp."
    }
  },
  "required": [
    "uid",
    "name",
    "status",
    "createdAt",
    "updatedAt"
  ],
  "title": "ImageSummary",
  "type": "object"
}