# Class Environment (1.17.0)

1.17.0 (latest) 1.16.0 1.15.0 1.14.0 1.13.3 1.12.0 1.11.1 1.10.5 1.9.0 1.8.0 1.7.1 1.6.1 1.5.1 1.4.4 1.3.2 1.2.1 1.1.1 1.0.0 0.4.3 0.3.2 0.2.0 0.1.2

    Environment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has `oneof`_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.

.. _oneof: <https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields>

| ## Attributes ||
|---|---|
| **Name** | **Description** |
| `name` | `str` Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}` |
| `display_name` | `str` Display name of this environment for the UI. |
| `description` | `str` A brief description of this environment. |
| `vm_image` | `https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.VmImage` Use a Compute Engine VM image to start the notebook instance. This field is a member of `oneof`_ `image_type`. |
| `container_image` | `https://docs.cloud.google.com/python/docs/reference/notebooks/latest/google.cloud.notebooks_v1.types.ContainerImage` Use a container image to start the notebook instance. This field is a member of `oneof`_ `image_type`. |
| `post_startup_script` | `str` 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"` |
| `create_time` | `google.protobuf.timestamp_pb2.Timestamp` Output only. The time at which this environment was created. |