# Class VmImage (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

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

Definition of a custom Compute Engine virtual machine image
for starting a notebook instance with the environment installed
directly on the VM.

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** |
| `project` | `str` Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}` |
| `image_name` | `str` Use VM image name to find the image. This field is a member of `oneof`_ `image`. |
| `image_family` | `str` Use this VM image family to find the image; the newest image in this family will be used. This field is a member of `oneof`_ `image`. |