Search or ask Docker

BuildCache

BuildCache schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

BuildCache contains information about a build cache record.
CreatedAt

Type: string

Date and time at which the build cache was created in RFC 3339 format with nano-seconds.
All schema constraints and annotations
{
  "description": "Date and time at which the build cache was created in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
  "example": "2016-08-18T10:44:24.496525531Z",
  "format": "dateTime",
  "type": "string"
}
Description

Type: string

Description of the build-step that produced the build cache.
All schema constraints and annotations
{
  "description": "Description of the build-step that produced the build cache.\n",
  "example": "mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \"true\";' \u003e /etc/apt/apt.conf.d/keep-cache",
  "type": "string"
}
ID

Type: string

Unique ID of the build cache record.
All schema constraints and annotations
{
  "description": "Unique ID of the build cache record.\n",
  "example": "ndlpt0hhvkqcdfkputsk4cq9c",
  "type": "string"
}
InUse

Type: boolean

Indicates if the build cache is in use.
All schema constraints and annotations
{
  "description": "Indicates if the build cache is in use.\n",
  "example": false,
  "type": "boolean"
}
LastUsedAt

Type: string

Date and time at which the build cache was last used in RFC 3339 format with nano-seconds.
All schema constraints and annotations
{
  "description": "Date and time at which the build cache was last used in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
  "example": "2017-08-09T07:09:37.632105588Z",
  "format": "dateTime",
  "type": "string",
  "x-nullable": true
}
Parents

Type: array

List of parent build cache record IDs.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "List of parent build cache record IDs.\n",
  "example": [
    "hw53o5aio51xtltp5xjp8v7fx"
  ],
  "items": {
    "type": "string"
  },
  "type": "array",
  "x-nullable": true
}
Shared

Type: boolean

Indicates if the build cache is shared.
All schema constraints and annotations
{
  "description": "Indicates if the build cache is shared.\n",
  "example": true,
  "type": "boolean"
}
Size

Type: integer

Amount of disk space used by the build cache (in bytes).
All schema constraints and annotations
{
  "description": "Amount of disk space used by the build cache (in bytes).\n",
  "example": 51,
  "type": "integer"
}
Type

Type: string

Cache record type.
All schema constraints and annotations
{
  "description": "Cache record type.\n",
  "enum": [
    "internal",
    "frontend",
    "source.local",
    "source.git.checkout",
    "exec.cachemount",
    "regular"
  ],
  "example": "regular",
  "type": "string"
}
UsageCount

Type: integer

All schema constraints and annotations
{
  "example": 26,
  "type": "integer"
}
All schema constraints and annotations
{
  "description": "BuildCache contains information about a build cache record.\n",
  "properties": {
    "CreatedAt": {
      "description": "Date and time at which the build cache was created in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
      "example": "2016-08-18T10:44:24.496525531Z",
      "format": "dateTime",
      "type": "string"
    },
    "Description": {
      "description": "Description of the build-step that produced the build cache.\n",
      "example": "mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \"true\";' \u003e /etc/apt/apt.conf.d/keep-cache",
      "type": "string"
    },
    "ID": {
      "description": "Unique ID of the build cache record.\n",
      "example": "ndlpt0hhvkqcdfkputsk4cq9c",
      "type": "string"
    },
    "InUse": {
      "description": "Indicates if the build cache is in use.\n",
      "example": false,
      "type": "boolean"
    },
    "LastUsedAt": {
      "description": "Date and time at which the build cache was last used in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
      "example": "2017-08-09T07:09:37.632105588Z",
      "format": "dateTime",
      "type": "string",
      "x-nullable": true
    },
    "Parents": {
      "description": "List of parent build cache record IDs.\n",
      "example": [
        "hw53o5aio51xtltp5xjp8v7fx"
      ],
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-nullable": true
    },
    "Shared": {
      "description": "Indicates if the build cache is shared.\n",
      "example": true,
      "type": "boolean"
    },
    "Size": {
      "description": "Amount of disk space used by the build cache (in bytes).\n",
      "example": 51,
      "type": "integer"
    },
    "Type": {
      "description": "Cache record type.\n",
      "enum": [
        "internal",
        "frontend",
        "source.local",
        "source.git.checkout",
        "exec.cachemount",
        "regular"
      ],
      "example": "regular",
      "type": "string"
    },
    "UsageCount": {
      "example": 26,
      "type": "integer"
    }
  },
  "type": "object"
}