DAIEngineService

Returns a collection of DAIEngines within a workspace.

get/v1/{parent}/daiEngines

Request

Path parameters

parentstring required

Workspace resource name. Format: workspaces/{workspace}

Authorization may require the following permission on the engine's parent workspace:

  • actions/enginemanager/daiEngines/LIST

Query parameters

pageSizeinteger

Maximum number of DAIEngines to return in a response. If unspecified (or set to 0), at most 50 DAIEngines will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring

Leave unset to receive the initial page. To list any subsequent pages use the value of 'next_page_token' returned from the ListDAIEnginesResponse.

orderBystring

Used to specify the sorting order.

When unset, DAIEngines are ordered by their time of creation in descending order. This is equivalent to "create_time desc".

When specified, the value must be a comma separated list of supported fields. The supported fields are:

  • name
  • cpu
  • gpu
  • memory_bytes
  • storage_bytes
  • creator
  • create_time
  • update_time
  • delete_time
  • resume_time
  • display_name
  • max_idle_duration
  • max_running_duration
  • uid

The default sorting order is ascending. For example: "name" and "name asc" are equivalent values.

To specify descending order for a field, append a " desc" suffix. For example: "name desc".

Redundant space characters are insignificant. For example these values are all equal:

  • " name, cpu desc"
  • "name, cpu desc"
  • "name , cpu desc "

Undefined (empty) time is interpreted as a zero time (0s since epoch, i.e. 1970-01-01T00:00:00Z).

Undefined (empty) duration is interpreted as a zero duration (0 seconds).

filterstring

Used to filter DAIEngines. When unset, no filtering is applied.

Filtering implements specification https://google.aip.dev/160.

Supported filter fields:

  • name
  • dai_engine_id
  • state
  • cpu
  • gpu
  • memory_bytes
  • storage_bytes
  • creator
  • creator_display_name
  • create_time
  • update_time
  • delete_time
  • resume_time
  • reconciling
  • uid
  • display_name
  • max_idle_duration
  • max_running_duration
  • current_idle_duration
  • current_running_duration

Examples:

  • cpu > 5
  • gpu < 3
  • cpu >= 5 AND gpu <= 3
  • cpu != 5 OR gpu == 3
  • NOT (cpu > 5 OR gpu < 3)
  • -(cpu > 5 OR gpu < 3)
  • NOT (cpu > 5 OR (gpu < 3))
  • (cpu > 5 OR gpu < 3) AND memory_bytes != 1000
  • (cpu > 5 OR gpu < 3) AND (NOT ((((memory_bytes = 1000)))))
  • state = STATE_RUNNING AND create_time > "2012-04-21T11:30:00-04:00"
  • max_running_duration > "1s" AND max_running_duration != "5s"
  • reconciling = true OR reconciling = false (supporting bool literals)
  • dai_engine_id = "*e*" OR display_name = "*e*" (supporting prefix/suffix wildcard * for string fields equality comparison)

Response

A successful response.

nextPageTokenstring

Used to retrieve the next page of results. When unset, no further items are available (this response was the last page).

totalSizeinteger

Total number of DAIEngines matched by the List request.

Changes

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