Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

Snapshot

Type: object

Snapshot is the detailed snapshot view. uid must equal the immutable resource ID in name
captureMode

Schema: CaptureMode

capture_mode is the mode the snapshot was captured with.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/CaptureMode",
  "description": "capture_mode is the mode the snapshot was captured with."
}
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."
}
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": "^snapshots/[^/]+$",
  "type": "string"
}
platform

Schema: Platform

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

Schema: Resources

resources describes the captured sandbox resources.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Resources",
  "description": "resources describes the captured sandbox resources."
}
sandbox

Type: string

sandbox is the resource name recorded for this reference.
All schema constraints and annotations
{
  "description": "sandbox is the resource name recorded for this reference.",
  "type": "string"
}
sandboxUid · response only

Type: string | null

sandbox_uid retains the observed backing incarnation when the backend provides one.
All schema constraints and annotations
{
  "description": "sandbox_uid retains the observed backing incarnation when the backend provides one.",
  "readOnly": true,
  "type": [
    "string",
    "null"
  ]
}
status · required · response only

Schema: SnapshotStatus

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

Type: integer | string

total_size_bytes is the approximate stored snapshot size.
All schema constraints and annotations
{
  "description": "total_size_bytes is the approximate stored snapshot 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"
  ]
}
All schema constraints and annotations
{
  "description": "Snapshot is the detailed snapshot view.\nuid must equal the immutable resource ID in name",
  "properties": {
    "captureMode": {
      "$ref": "#/components/schemas/CaptureMode",
      "description": "capture_mode is the mode the snapshot was captured with."
    },
    "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."
    },
    "name": {
      "description": "(IDENTIFIER) name ends in the immutable backing ID and never changes with display_name.",
      "pattern": "^snapshots/[^/]+$",
      "type": "string"
    },
    "platform": {
      "$ref": "#/components/schemas/Platform",
      "description": "platform is the captured sandbox platform."
    },
    "resources": {
      "$ref": "#/components/schemas/Resources",
      "description": "resources describes the captured sandbox resources."
    },
    "sandbox": {
      "description": "sandbox is the resource name recorded for this reference.",
      "type": "string"
    },
    "sandboxUid": {
      "description": "sandbox_uid retains the observed backing incarnation when the backend provides one.",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "$ref": "#/components/schemas/SnapshotStatus",
      "description": "status is the snapshot readiness state.",
      "not": {
        "enum": [
          "unspecified"
        ]
      },
      "readOnly": true
    },
    "totalSizeBytes": {
      "description": "total_size_bytes is the approximate stored snapshot 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"
      ]
    }
  },
  "required": [
    "uid",
    "name",
    "status",
    "createdAt",
    "etag"
  ],
  "title": "Snapshot",
  "type": "object"
}