Answers are generated based on the documentation.

Experimental

API version Product manual Download OpenAPI specification Markdown

Schema

Volume

Type: object

Volume is persistent storage metadata within its owner and contract scope. uid must equal the immutable resource ID in name

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

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

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": "^volumes/[^/]+$",
  "type": "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": "Volume is persistent storage metadata within its owner and contract scope.\nuid must equal the immutable resource ID in name",
  "properties": {
    "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"
    },
    "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"
    },
    "name": {
      "description": "(IDENTIFIER) name ends in the immutable backing ID and never changes with display_name.",
      "pattern": "^volumes/[^/]+$",
      "type": "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",
    "createdAt",
    "etag"
  ],
  "title": "Volume",
  "type": "object"
}