Note: The following fields are mutually exclusive: container_image, vm_image. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: container_image, vm_image. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: container_image, vm_image. If a field in that set is populated, all other fields in the set will automatically be cleared.
(::String) — A brief description of this environment.
#description=
defdescription=(value)->::String
Parameter
value (::String) — A brief description of this environment.
Returns
(::String) — A brief description of this environment.
#display_name
defdisplay_name()->::String
Returns
(::String) — Display name of this environment for the UI.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::String) — Display name of this environment for the UI.
Returns
(::String) — Display name of this environment for the UI.
#name
defname()->::String
Returns
(::String) — Output only. Name of this environment.
Format:
projects/{project_id}/locations/{location}/environments/{environment_id}
#post_startup_script
defpost_startup_script()->::String
Returns
(::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"
#post_startup_script=
defpost_startup_script=(value)->::String
Parameter
value (::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"
Returns
(::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"
Note: The following fields are mutually exclusive: vm_image, container_image. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: vm_image, container_image. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: vm_image, container_image. If a field in that set is populated, all other fields in the set will automatically be cleared.
[[["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 V1beta1 API - Class Google::Cloud::Notebooks::V1beta1::Environment (v0.13.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.0 (latest)](/ruby/docs/reference/google-cloud-notebooks-v1beta1/latest/Google-Cloud-Notebooks-V1beta1-Environment)\n- [0.12.1](/ruby/docs/reference/google-cloud-notebooks-v1beta1/0.12.1/Google-Cloud-Notebooks-V1beta1-Environment)\n- [0.11.0](/ruby/docs/reference/google-cloud-notebooks-v1beta1/0.11.0/Google-Cloud-Notebooks-V1beta1-Environment)\n- [0.10.1](/ruby/docs/reference/google-cloud-notebooks-v1beta1/0.10.1/Google-Cloud-Notebooks-V1beta1-Environment)\n- [0.9.2](/ruby/docs/reference/google-cloud-notebooks-v1beta1/0.9.2/Google-Cloud-Notebooks-V1beta1-Environment)\n- [0.8.0](/ruby/docs/reference/google-cloud-notebooks-v1beta1/0.8.0/Google-Cloud-Notebooks-V1beta1-Environment)\n- [0.7.1](/ruby/docs/reference/google-cloud-notebooks-v1beta1/0.7.1/Google-Cloud-Notebooks-V1beta1-Environment)\n- [0.6.1](/ruby/docs/reference/google-cloud-notebooks-v1beta1/0.6.1/Google-Cloud-Notebooks-V1beta1-Environment)\n- [0.5.0](/ruby/docs/reference/google-cloud-notebooks-v1beta1/0.5.0/Google-Cloud-Notebooks-V1beta1-Environment)\n- [0.4.5](/ruby/docs/reference/google-cloud-notebooks-v1beta1/0.4.5/Google-Cloud-Notebooks-V1beta1-Environment) \nReference documentation and code samples for the AI Platform Notebooks V1beta1 API class Google::Cloud::Notebooks::V1beta1::Environment.\n\nDefinition of a software environment that is used to start a notebook\ninstance. \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### #container_image\n\n def container_image() -\u003e ::Google::Cloud::Notebooks::V1beta1::ContainerImage\n\n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1beta1::ContainerImage](./Google-Cloud-Notebooks-V1beta1-ContainerImage)) --- Use a container image to start the notebook instance.\n\n\n Note: The following fields are mutually exclusive: `container_image`, `vm_image`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #container_image=\n\n def container_image=(value) -\u003e ::Google::Cloud::Notebooks::V1beta1::ContainerImage\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Notebooks::V1beta1::ContainerImage](./Google-Cloud-Notebooks-V1beta1-ContainerImage)) --- Use a container image to start the notebook instance.\n\n\nNote: The following fields are mutually exclusive: `container_image`, `vm_image`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1beta1::ContainerImage](./Google-Cloud-Notebooks-V1beta1-ContainerImage)) --- Use a container image to start the notebook instance.\n\n\n Note: The following fields are mutually exclusive: `container_image`, `vm_image`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time at which this environment was created.\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A brief description of this environment.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A brief description of this environment. \n**Returns**\n\n- (::String) --- A brief description of this environment.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Display name of this environment for the UI.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Display name of this environment for the UI. \n**Returns**\n\n- (::String) --- Display name of this environment for the UI.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`\n\n### #post_startup_script\n\n def post_startup_script() -\u003e ::String\n\n**Returns**\n\n- (::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\"`\n\n### #post_startup_script=\n\n def post_startup_script=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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\"` \n**Returns**\n\n- (::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\"`\n\n### #vm_image\n\n def vm_image() -\u003e ::Google::Cloud::Notebooks::V1beta1::VmImage\n\n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1beta1::VmImage](./Google-Cloud-Notebooks-V1beta1-VmImage)) --- Use a Compute Engine VM image to start the notebook instance.\n\n\n Note: The following fields are mutually exclusive: `vm_image`, `container_image`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #vm_image=\n\n def vm_image=(value) -\u003e ::Google::Cloud::Notebooks::V1beta1::VmImage\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Notebooks::V1beta1::VmImage](./Google-Cloud-Notebooks-V1beta1-VmImage)) --- Use a Compute Engine VM image to start the notebook instance.\n\n\nNote: The following fields are mutually exclusive: `vm_image`, `container_image`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1beta1::VmImage](./Google-Cloud-Notebooks-V1beta1-VmImage)) --- Use a Compute Engine VM image to start the notebook instance.\n\n\n Note: The following fields are mutually exclusive: `vm_image`, `container_image`. If a field in that set is populated, all other fields in the set will automatically be cleared."]]
