H2h2o
H2OEngineService

Creates and starts a new H2OEngine within a specified workspace.

post/v1/{parent}/h2oEngines

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/h2oEngines/CREATE

Query parameters

h2oEngineIdstring required

Specify the H2OEngine ID, which will become a part of the H2OEngine resource name.

It must:

  • contain 1-63 characters
  • contain only lowercase alphanumeric characters or hyphen ('-')
  • start with an alphabetic character
  • end with an alphanumeric character

This matches a regular expression: ^a-z?$

validateOnlyboolean

When set, request is only validated but no changes are made.

Request body

namestring

H2OEngine resource name.

uidstring

Globally unique identifier of the resource.

creatorstring

Name of na entity that created the H2OEngine.

creatorDisplayNamestring

Human-readable name of creator.

profilestring required

Required. The resource name of the H2OEngineProfile that is used by this H2OEngine. Format is workspaces/*/h2oEngineProfiles/*.

state'STATE_UNSPECIFIED' | 'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_PAUSING' | 'STATE_PAUSED' | 'STATE_FAILED' | 'STATE_DELETING' | 'STATE_CONNECTING' | 'STATE_TERMINATING' | 'STATE_TERMINATED'

All possible H2OEngine states.

  • STATE_UNSPECIFIED: H2OEngine state is unspecified or unknown.
  • STATE_STARTING: H2OEngine is starting.
  • STATE_RUNNING: H2OEngine is running and can be used.
  • STATE_PAUSING: H2OEngine is pausing. Deprecated, use STATE_TERMINATING.
  • STATE_PAUSED: H2OEngine is paused and CANNOT be resumed again. Deprecated, use STATE_TERMINATED.
  • STATE_FAILED: H2OEngine has failed.
  • STATE_DELETING: H2OEngine is being deleted.
  • STATE_CONNECTING: H2OEngine is establishing a connection with the AI Engine Manager.
  • STATE_TERMINATING: H2OEngine is terminating.
  • STATE_TERMINATED: H2OEngine is terminated. This is a final state.
reconcilingboolean

Indicates whether changes to the resource are in progress. If true, current state of the H2OEngine does not match the intended state.

createTimestring date-time

Time when the H2OEngine creation was requested.

deleteTimestring date-time nullable

Time when the H2OEngine was deleted.

updateTimestring date-time nullable

Time when the H2OEngine was last updated.

apiUrlstring

The URL address to access the engine API.

loginUrlstring

The URL address to initiate login flow.

annotationsobject

Additional arbitrary metadata associated with the H2OEngine.

Annotations are key/value pairs. The key must:

  • be 63 characters or less
  • begin and end with an alphanumeric character ([a-z0-9A-Z])
  • with dashes (-), underscores (_), dots (.), and alphanumerics between
  • regex used for validation is: ^A-Za-z0-9?$
displayNamestring

Human-readable name of the H2OEngine. Must contain at most 63 characters. Does not have to be unique.

cpuinteger nullable

The amount of CPU units per node requested by this H2OEngine.

gpuinteger nullable

The amount of GPU units per node requested by this H2OEngine.

memoryBytesstring int64 nullable

The amount of memory in bytes per node requested by this H2OEngine.

maxIdleDurationstring nullable

Maximum time an H2OEngine can be idle. When exceeded, the H2OEngine will terminate.

maxRunningDurationstring nullable

Maximum time an H2OEngine can be running. When exceeded, the H2OEngine will terminate.

currentIdleDurationstring nullable

Current time the H2OEngine is idle.

currentRunningDurationstring nullable

Current time the H2OEngine is running.

nodeCountinteger nullable

The number of nodes requested by this H2OEngine.

h2oEngineVersionstring required

Response

A successful response.

Changes

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