Reference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::VmImage.
Definition of a custom Compute Engine virtual machine image for starting a
notebook instance with the environment installed directly on the VM.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#image_family
defimage_family()->::String
Returns
(::String) — Use this VM image family to find the image; the newest image in this
family will be used.
Note: The following fields are mutually exclusive: image_family, image_name. If a field in that set is populated, all other fields in the set will automatically be cleared.
#image_family=
defimage_family=(value)->::String
Parameter
value (::String) — Use this VM image family to find the image; the newest image in this
family will be used.
Note: The following fields are mutually exclusive: image_family, image_name. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — Use this VM image family to find the image; the newest image in this
family will be used.
Note: The following fields are mutually exclusive: image_family, image_name. If a field in that set is populated, all other fields in the set will automatically be cleared.
#image_name
defimage_name()->::String
Returns
(::String) — Use VM image name to find the image.
Note: The following fields are mutually exclusive: image_name, image_family. If a field in that set is populated, all other fields in the set will automatically be cleared.
#image_name=
defimage_name=(value)->::String
Parameter
value (::String) — Use VM image name to find the image.
Note: The following fields are mutually exclusive: image_name, image_family. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — Use VM image name to find the image.
Note: The following fields are mutually exclusive: image_name, image_family. If a field in that set is populated, all other fields in the set will automatically be cleared.
#project
defproject()->::String
Returns
(::String) — Required. The name of the Google Cloud project that this VM image belongs to.
Format: {project_id}
#project=
defproject=(value)->::String
Parameter
value (::String) — Required. The name of the Google Cloud project that this VM image belongs to.
Format: {project_id}
Returns
(::String) — Required. The name of the Google Cloud project that this VM image belongs to.
Format: {project_id}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# AI Platform Notebooks V1 API - Class Google::Cloud::Notebooks::V1::VmImage (v1.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.0 (latest)](/ruby/docs/reference/google-cloud-notebooks-v1/latest/Google-Cloud-Notebooks-V1-VmImage)\n- [1.0.1](/ruby/docs/reference/google-cloud-notebooks-v1/1.0.1/Google-Cloud-Notebooks-V1-VmImage)\n- [0.11.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.11.0/Google-Cloud-Notebooks-V1-VmImage)\n- [0.10.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.10.0/Google-Cloud-Notebooks-V1-VmImage)\n- [0.9.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.9.1/Google-Cloud-Notebooks-V1-VmImage)\n- [0.8.2](/ruby/docs/reference/google-cloud-notebooks-v1/0.8.2/Google-Cloud-Notebooks-V1-VmImage)\n- [0.7.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.7.0/Google-Cloud-Notebooks-V1-VmImage)\n- [0.6.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.6.1/Google-Cloud-Notebooks-V1-VmImage)\n- [0.5.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.5.0/Google-Cloud-Notebooks-V1-VmImage)\n- [0.4.2](/ruby/docs/reference/google-cloud-notebooks-v1/0.4.2/Google-Cloud-Notebooks-V1-VmImage)\n- [0.3.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.3.0/Google-Cloud-Notebooks-V1-VmImage)\n- [0.2.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.2.1/Google-Cloud-Notebooks-V1-VmImage)\n- [0.1.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.1.0/Google-Cloud-Notebooks-V1-VmImage) \nReference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::VmImage.\n\nDefinition of a custom Compute Engine virtual machine image for starting a\nnotebook instance with the environment installed directly on the VM. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #image_family\n\n def image_family() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Use this VM image family to find the image; the newest image in this family will be used.\n\n Note: The following fields are mutually exclusive: `image_family`, `image_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #image_family=\n\n def image_family=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Use this VM image family to find the image; the newest image in this family will be used.\n\n\nNote: The following fields are mutually exclusive: `image_family`, `image_name`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- Use this VM image family to find the image; the newest image in this family will be used.\n\n Note: The following fields are mutually exclusive: `image_family`, `image_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #image_name\n\n def image_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Use VM image name to find the image.\n\n Note: The following fields are mutually exclusive: `image_name`, `image_family`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #image_name=\n\n def image_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Use VM image name to find the image.\n\n\nNote: The following fields are mutually exclusive: `image_name`, `image_family`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- Use VM image name to find the image.\n\n Note: The following fields are mutually exclusive: `image_name`, `image_family`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #project\n\n def project() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`\n\n### #project=\n\n def project=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}` \n**Returns**\n\n- (::String) --- Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`"]]
