ProcessService

Lists all processes.

Authorization: Only the creator of the parent SandboxEngine is allowed to call this method.

get/v1/{parent}/processes

Request

Path parameters

parentstring required

Required. The parent resource to list processes from. Format: workspaces/{workspace}/sandboxEngines/{sandbox_engine}

Query parameters

pageSizeinteger

The maximum number of processes to return.

pageTokenstring

A page token from a previous ListProcesses call.

filterstring

Optional. A filter expression to filter processes by state.

Syntax: "state = STATE_VALUE"

Where STATE_VALUE must be one of:

  • STATE_PENDING
  • STATE_RUNNING
  • STATE_SUCCEEDED
  • STATE_FAILED

Examples:

  • "state = STATE_RUNNING" - returns only running processes
  • "state = STATE_SUCCEEDED" - returns only succeeded processes

If empty or unspecified, returns all processes.

Response

A successful response.

nextPageTokenstring

A token to retrieve the next page of results.

Changes

No recorded changes to this operation across all 1 revision of this API.