Reference documentation and code samples for the Google Cloud Notebooks V1beta1 Client class Environment.
Definition of a software environment that is used to start a notebook instance.
Generated from protobuf message google.cloud.notebooks.v1beta1.Environment
Namespace
Google \ Cloud \ Notebooks \ V1beta1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}
↳ display_name
string
Display name of this environment for the UI.
↳ description
string
A brief description of this environment.
↳ vm_image
Google\Cloud\Notebooks\V1beta1\VmImage
Use a Compute Engine VM image to start the notebook instance.
↳ container_image
↳ post_startup_script
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"
↳ create_time
getName
Output only. Name of this environment.
Format: projects/{project_id}/locations/{location}/environments/{environment_id}
string
setName
Output only. Name of this environment.
Format: projects/{project_id}/locations/{location}/environments/{environment_id}
var
string
$this
getDisplayName
Display name of this environment for the UI.
string
setDisplayName
Display name of this environment for the UI.
var
string
$this
getDescription
A brief description of this environment.
string
setDescription
A brief description of this environment.
var
string
$this
getVmImage
Use a Compute Engine VM image to start the notebook instance.
hasVmImage
setVmImage
Use a Compute Engine VM image to start the notebook instance.
$this
getContainerImage
Use a container image to start the notebook instance.
hasContainerImage
setContainerImage
Use a container image to start the notebook instance.
$this
getPostStartupScript
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"
string
setPostStartupScript
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"
var
string
$this
getCreateTime
Output only. The time at which this environment was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this environment was created.
$this
getImageType
string
