## Resource: Environment

Definition of a software environment that is used to start a notebook instance.

| JSON representation |
|---|
| ``` { "name": string, "displayName": string, "description": string, "postStartupScript": string, "createTime": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "vmImage": { object (`https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/VmImage`) }, "containerImage": { object (`https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/ContainerImage`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. Name of this environment. Format: `projects/{projectId}/locations/{location}/environments/{environmentId}` |
| `displayName` | `string` Display name of this environment for the UI. |
| `description` | `string` A brief description of this environment. |
| `postStartupScript` | `string` Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"` |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time at which this environment was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| Type of the environment; can be one of VM image, or container image. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `vmImage` | ``object (`https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/VmImage`)`` Use a Compute Engine VM image to start the notebook instance. |
| `containerImage` | ``object (`https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/ContainerImage`)`` Use a container image to start the notebook instance. |
| End of mutually exclusive fields. ||

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.environments/create` | Creates a new Environment. |
| ### `https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.environments/delete` | Deletes a single Environment. |
| ### `https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.environments/get` | Gets details of a single Environment. |
| ### `https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/reference/rest/v1/projects.locations.environments/list` | Lists environments in a project. |