Class: Google::Apis::NotebooksV1::Environment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/notebooks_v1/classes.rb,
generated/google/apis/notebooks_v1/representations.rb,
generated/google/apis/notebooks_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Environment

Returns a new instance of Environment.



333
334
335
 
# File 'generated/google/apis/notebooks_v1/classes.rb', line 333

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#container_image ⇒ Google::Apis::NotebooksV1::ContainerImage

Definition of a container image for starting a notebook instance with the environment installed in a container. Corresponds to the JSON property containerImage

Returns:



297
298
299
 
# File 'generated/google/apis/notebooks_v1/classes.rb', line 297

def container_image
  @container_image
end

#create_time ⇒ String

Output only. The time at which this environment was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


302
303
304
 
# File 'generated/google/apis/notebooks_v1/classes.rb', line 302

def create_time
  @create_time
end

#description ⇒ String

A brief description of this environment. Corresponds to the JSON property description

Returns:

  • (String) 


307
308
309
 
# File 'generated/google/apis/notebooks_v1/classes.rb', line 307

def description
  @description
end

#display_name ⇒ String

Display name of this environment for the UI. Corresponds to the JSON property displayName

Returns:

  • (String) 


312
313
314
 
# File 'generated/google/apis/notebooks_v1/classes.rb', line 312

def display_name
  @display_name
end

#name ⇒ String

Output only. Name of this environment. Format: projects/project_id/ locations/location/environments/environment_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


318
319
320
 
# File 'generated/google/apis/notebooks_v1/classes.rb', line 318

def name
  @name
end

#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" Corresponds to the JSON property postStartupScript

Returns:

  • (String) 


325
326
327
 
# File 'generated/google/apis/notebooks_v1/classes.rb', line 325

def post_startup_script
  @post_startup_script
end

#vm_image ⇒ Google::Apis::NotebooksV1::VmImage

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

Returns:



331
332
333
 
# File 'generated/google/apis/notebooks_v1/classes.rb', line 331

def vm_image
  @vm_image
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



338
339
340
341
342
343
344
345
346
 
# File 'generated/google/apis/notebooks_v1/classes.rb', line 338

def update!(**args)
  @container_image = args[:container_image] if args.key?(:container_image)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
  @post_startup_script = args[:post_startup_script] if args.key?(:post_startup_script)
  @vm_image = args[:vm_image] if args.key?(:vm_image)
end