AI Platform Notebooks V1beta1 API - Class Google::Cloud::Notebooks::V1beta1::Environment (v0.12.0)

Reference documentation and code samples for the AI Platform Notebooks V1beta1 API class Google::Cloud::Notebooks::V1beta1::Environment.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#container_image

def container_image() -> ::Google::Cloud::Notebooks::V1beta1::ContainerImage
Returns
  • (::Google::Cloud::Notebooks::V1beta1::ContainerImage) — Use a container image to start the notebook instance.

    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.

#container_image=

def container_image=(value) -> ::Google::Cloud::Notebooks::V1beta1::ContainerImage
Parameter
  • value (::Google::Cloud::Notebooks::V1beta1::ContainerImage) — Use a container image to start the notebook instance.

    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.

Returns
  • (::Google::Cloud::Notebooks::V1beta1::ContainerImage) — Use a container image to start the notebook instance.

    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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — A brief description of this environment.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — A brief description of this environment.
Returns
  • (::String) — A brief description of this environment.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Display name of this environment for the UI.

#display_name=

def display_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

def name() -> ::String
Returns
  • (::String) — Output only. Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

#post_startup_script

def post_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=

def post_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"

#vm_image

def vm_image() -> ::Google::Cloud::Notebooks::V1beta1::VmImage
Returns
  • (::Google::Cloud::Notebooks::V1beta1::VmImage) — Use a Compute Engine VM image to start the notebook instance.

    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.

#vm_image=

def vm_image=(value) -> ::Google::Cloud::Notebooks::V1beta1::VmImage
Parameter
  • value (::Google::Cloud::Notebooks::V1beta1::VmImage) — Use a Compute Engine VM image to start the notebook instance.

    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.

Returns
  • (::Google::Cloud::Notebooks::V1beta1::VmImage) — Use a Compute Engine VM image to start the notebook instance.

    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.