Answers are generated based on the documentation.

Experimental

API version Product manual Download OpenAPI specification Markdown

Schema

Process

Type: object

Process is the handle returned before interaction begins.

exitCode

Type: integer | null

exit_code is the process exit code, set only when state is exited and absent otherwise.

All schema constraints and annotations

{
  "description": "exit_code is the process exit code, set only when state is exited and absent otherwise.",
  "format": "int32",
  "type": [
    "integer",
    "null"
  ]
}

label · required

Type: string

(IMMUTABLE) label retains the unique, immutable process label and its generated default.

All schema constraints and annotations

{
  "description": "(IMMUTABLE) label retains the unique, immutable process label and its generated default.",
  "minLength": 1,
  "type": "string"
}

lastStreamSequence

Type: integer | string

last_stream_sequence is the highest stream_sequence emitted for the process when this report was assembled; 0 before any output.

All schema constraints and annotations

{
  "description": "last_stream_sequence is the highest stream_sequence emitted for the process when this report was assembled; 0 before any output.",
  "format": "int64",
  "type": [
    "integer",
    "string"
  ]
}

name

Type: string

(IDENTIFIER) name is scoped to the discovered sandbox endpoint API base.

All schema constraints and annotations

{
  "description": "(IDENTIFIER) name is scoped to the discovered sandbox endpoint API base.",
  "type": "string"
}

pid

Type: integer

pid is the process id inside the sandbox when available.

All schema constraints and annotations

{
  "description": "pid is the process id inside the sandbox when available.",
  "format": "int32",
  "type": "integer"
}

receiptKind

Schema: ReceiptKind

receipt_kind classifies this response on CreateProcess; every other operation returning a Process, including ListProcesses, always reports unspecified.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/ReceiptKind",
  "description": "receipt_kind classifies this response on CreateProcess; every other operation\nreturning a Process, including ListProcesses, always reports unspecified."
}

session

Type: string

session is the session tag from the create, empty when untagged.

All schema constraints and annotations

{
  "description": "session is the session tag from the create, empty when untagged.",
  "type": "string"
}

state

Schema: ProcessState

state is the process state, concrete in conforming responses.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/ProcessState",
  "description": "state is the process state, concrete in conforming responses."
}

uid · response only

Type: string | null

(IMMUTABLE) uid is the existing process incarnation, also used as the resource name terminal.

All schema constraints and annotations

{
  "description": "(IMMUTABLE) uid is the existing process incarnation, also used as the resource name terminal.",
  "readOnly": true,
  "type": [
    "string",
    "null"
  ]
}

All schema constraints and annotations

{
  "description": "Process is the handle returned before interaction begins.",
  "properties": {
    "exitCode": {
      "description": "exit_code is the process exit code, set only when state is exited and absent otherwise.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "label": {
      "description": "(IMMUTABLE) label retains the unique, immutable process label and its generated default.",
      "minLength": 1,
      "type": "string"
    },
    "lastStreamSequence": {
      "description": "last_stream_sequence is the highest stream_sequence emitted for the process when this report was assembled; 0 before any output.",
      "format": "int64",
      "type": [
        "integer",
        "string"
      ]
    },
    "name": {
      "description": "(IDENTIFIER) name is scoped to the discovered sandbox endpoint API base.",
      "type": "string"
    },
    "pid": {
      "description": "pid is the process id inside the sandbox when available.",
      "format": "int32",
      "type": "integer"
    },
    "receiptKind": {
      "$ref": "#/components/schemas/ReceiptKind",
      "description": "receipt_kind classifies this response on CreateProcess; every other operation\nreturning a Process, including ListProcesses, always reports unspecified."
    },
    "session": {
      "description": "session is the session tag from the create, empty when untagged.",
      "type": "string"
    },
    "state": {
      "$ref": "#/components/schemas/ProcessState",
      "description": "state is the process state, concrete in conforming responses."
    },
    "uid": {
      "description": "(IMMUTABLE) uid is the existing process incarnation, also used as the resource name terminal.",
      "readOnly": true,
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "label"
  ],
  "title": "Process",
  "type": "object"
}