H2h2o
IDEEngineService

Creates a new IDEEngine within a specified workspace.

post/v1/{parent}/ideEngines

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

Query parameters

ideEngineIdstring required

Specify the IDEEngine ID, which will become a part of the IDEEngine 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

Request body

namestring

Output only. The resource name of the IDEEngine. Format: workspaces/*/ideEngines/*.

displayNamestring

Optional. Human-readable name.

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

The state of the IDEEngine.

  • STATE_UNSPECIFIED: IDEEngine state is unspecified or unknown.
  • STATE_STARTING: IDEEngine is starting.
  • STATE_RUNNING: IDEEngine is running and can be used.
  • STATE_PAUSING: IDEEngine is pausing.
  • STATE_PAUSED: IDEEngine is paused.
  • STATE_FAILED: IDEEngine has failed.
  • STATE_DELETING: IDEEngine is being deleted.
  • STATE_TERMINATED: IDEEngine is terminated.
reconcilingboolean

Output only. Indicates whether changes to the resource are in progress.

uidstring

Output only. Globally unique identifier of the resource.

creatorstring

Output only. Name of entity that created the IDEEngine.

createTimestring date-time

Output only. Time when the IDEEngine was created.

Response

A successful response.

Changes

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