Experimental

API version Product manual Download OpenAPI specification Markdown

Schema

Image

Type: object

Image is the detailed managed image view. 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."
}

description

Type: string

description is caller-supplied text.

All schema constraints and annotations

{
  "description": "description is caller-supplied text.",
  "type": "string"
}

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"
}

etag · required · response only

Type: string

etag identifies the observed version of this resource. It is opaque and strong, changes on every visible change, and is what a mutation sends as its precondition.

All schema constraints and annotations

{
  "description": "etag identifies the observed version of this resource. It is opaque and strong,\nchanges on every visible change, and is what a mutation sends as its precondition.",
  "minLength": 1,
  "pattern": "^\"[^\"\\x00-\\x20\\x7f]*\"$",
  "readOnly": true,
  "type": "string"
}

failure

Schema: Error

failure is set when status is FAILED.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/Error",
  "description": "failure is set when status is FAILED."
}

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

(IDENTIFIER) name ends in the immutable backing ID and never changes with display_name.

All schema constraints and annotations

{
  "description": "(IDENTIFIER) 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."
}

pushTarget · response only

Schema: ImagePushTarget

push_target appears only in from_image create responses awaiting upload, never reads.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/ImagePushTarget",
  "description": "push_target appears only in from_image create responses awaiting upload, never reads.",
  "readOnly": true
}

readyCmd

Type: array

ready_cmd is the readiness command used by raw image sandboxes.

Array item

Type: string

All schema constraints and annotations

{
  "type": "string"
}

All schema constraints and annotations

{
  "description": "ready_cmd is the readiness command used by raw image sandboxes.",
  "items": {
    "type": "string"
  },
  "type": "array"
}

resources

Schema: Resources

resources describes the image's preferred runtime resources.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/Resources",
  "description": "resources describes the image's preferred runtime resources."
}

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."
}

startCmd

Type: array

start_cmd is the command used by raw image sandboxes.

Array item

Type: string

All schema constraints and annotations

{
  "type": "string"
}

All schema constraints and annotations

{
  "description": "start_cmd is the command used by raw image sandboxes.",
  "items": {
    "type": "string"
  },
  "type": "array"
}

status · required · response only

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"
    ]
  },
  "readOnly": true
}

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": "Image is the detailed managed image view.\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."
    },
    "description": {
      "description": "description is caller-supplied text.",
      "type": "string"
    },
    "displayName": {
      "description": "display_name is a scoped label and never selects the resource.",
      "type": "string"
    },
    "etag": {
      "description": "etag identifies the observed version of this resource. It is opaque and strong,\nchanges on every visible change, and is what a mutation sends as its precondition.",
      "minLength": 1,
      "pattern": "^\"[^\"\\x00-\\x20\\x7f]*\"$",
      "readOnly": true,
      "type": "string"
    },
    "failure": {
      "$ref": "#/components/schemas/Error",
      "description": "failure is set when status is FAILED."
    },
    "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": "(IDENTIFIER) 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."
    },
    "pushTarget": {
      "$ref": "#/components/schemas/ImagePushTarget",
      "description": "push_target appears only in from_image create responses awaiting upload, never reads.",
      "readOnly": true
    },
    "readyCmd": {
      "description": "ready_cmd is the readiness command used by raw image sandboxes.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "resources": {
      "$ref": "#/components/schemas/Resources",
      "description": "resources describes the image's preferred runtime resources."
    },
    "source": {
      "$ref": "#/components/schemas/ImageSource",
      "description": "source records how the image was created."
    },
    "startCmd": {
      "description": "start_cmd is the command used by raw image sandboxes.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "status": {
      "$ref": "#/components/schemas/ImageStatus",
      "description": "status is the image readiness state.",
      "not": {
        "enum": [
          "unspecified"
        ]
      },
      "readOnly": true
    },
    "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",
    "etag"
  ],
  "title": "Image",
  "type": "object"
}

What can I help you with?

Image