Class: Google::Cloud::Notebooks::V1beta1::Instance

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/notebooks/v1beta1/instance.rb

Overview

The definition of a notebook instance.

Defined Under Namespace

Modules: AcceleratorType, DiskEncryption, DiskType, NicType, State Classes: AcceleratorConfig, LabelsEntry, MetadataEntry

Instance Attribute Summary collapse

Instance Attribute Details

#accelerator_config::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorConfig

Returns The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#boot_disk_size_gb::Integer

Returns Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

Returns:

  • (::Integer)

    Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#boot_disk_type::Google::Cloud::Notebooks::V1beta1::Instance::DiskType

Returns Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#can_ip_forward::Boolean

Returns Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#container_image::Google::Cloud::Notebooks::V1beta1::ContainerImage

Returns Use a container image to start the notebook instance.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#create_time::Google::Protobuf::Timestamp (readonly)

Returns Output only. Instance creation time.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#custom_gpu_driver_path::String

Returns Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

Returns:

  • (::String)

    Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#data_disk_size_gb::Integer

Returns Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

Returns:

  • (::Integer)

    Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#data_disk_type::Google::Cloud::Notebooks::V1beta1::Instance::DiskType

Returns Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#disk_encryption::Google::Cloud::Notebooks::V1beta1::Instance::DiskEncryption

Returns Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#install_gpu_driver::Boolean

Returns Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.

Returns:

  • (::Boolean)

    Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#instance_owners::Array<::String>

Returns Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

Returns:

  • (::Array<::String>)

    Input only. The owner of this instance after creation. Format: alias@example.com

    Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#kms_key::String

Returns Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Learn more about using your own encryption keys.

Returns:

  • (::String)

    Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

    Learn more about using your own encryption keys.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#labels::Google::Protobuf::Map{::String => ::String}

Returns Labels to apply to this instance. These can be later modified by the setLabels method.

Returns:

  • (::Google::Protobuf::Map{::String => ::String})

    Labels to apply to this instance. These can be later modified by the setLabels method.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#machine_type::String

Returns Required. The Compute Engine machine type of this instance.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#metadata::Google::Protobuf::Map{::String => ::String}

Returns Custom metadata to apply to this instance.

Returns:

  • (::Google::Protobuf::Map{::String => ::String})

    Custom metadata to apply to this instance.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#name::String (readonly)

Returns Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}.

Returns:

  • (::String)

    Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#network::String

Returns The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}.

Returns:

  • (::String)

    The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#nic_type::Google::Cloud::Notebooks::V1beta1::Instance::NicType

Returns Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#no_proxy_access::Boolean

Returns If true, the notebook instance will not register with the proxy.

Returns:

  • (::Boolean)

    If true, the notebook instance will not register with the proxy.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#no_public_ip::Boolean

Returns If true, no public IP will be assigned to this instance.

Returns:

  • (::Boolean)

    If true, no public IP will be assigned to this instance.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#no_remove_data_disk::Boolean

Returns Input only. If true, the data disk will not be auto deleted when deleting the instance.

Returns:

  • (::Boolean)

    Input only. If true, the data disk will not be auto deleted when deleting the instance.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#post_startup_script::String

Returns 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 (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 (gs://path-to-file/file-name).



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#proxy_uri::String (readonly)

Returns Output only. The proxy endpoint that is used to access the Jupyter notebook.

Returns:

  • (::String)

    Output only. The proxy endpoint that is used to access the Jupyter notebook.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#reservation_affinity::Google::Cloud::Notebooks::V1beta1::ReservationAffinity

Returns Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#service_account::String

Returns The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

Returns:

  • (::String)

    The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance.

    If not specified, the Compute Engine default service account is used.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#state::Google::Cloud::Notebooks::V1beta1::Instance::State (readonly)

Returns Output only. The state of this instance.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#subnet::String

Returns The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}.

Returns:

  • (::String)

    The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#update_time::Google::Protobuf::Timestamp (readonly)

Returns Output only. Instance update time.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end

#vm_image::Google::Cloud::Notebooks::V1beta1::VmImage

Returns Use a Compute Engine VM image to start the notebook instance.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'proto_docs/google/cloud/notebooks/v1beta1/instance.rb', line 191

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Definition of a hardware accelerator. Note that not all combinations
  # of `type` and `core_count` are valid. Check [GPUs on Compute
  # Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a
  # valid combination. TPUs are not supported.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Notebooks::V1beta1::Instance::AcceleratorType]
  #     Type of this accelerator.
  # @!attribute [rw] core_count
  #   @return [::Integer]
  #     Count of cores of this accelerator.
  class AcceleratorConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Definition of the types of hardware accelerators that can be used on this
  # instance.
  module AcceleratorType
    # Accelerator type is not specified.
    ACCELERATOR_TYPE_UNSPECIFIED = 0

    # Accelerator type is Nvidia Tesla K80.
    NVIDIA_TESLA_K80 = 1

    # Accelerator type is Nvidia Tesla P100.
    NVIDIA_TESLA_P100 = 2

    # Accelerator type is Nvidia Tesla V100.
    NVIDIA_TESLA_V100 = 3

    # Accelerator type is Nvidia Tesla P4.
    NVIDIA_TESLA_P4 = 4

    # Accelerator type is Nvidia Tesla T4.
    NVIDIA_TESLA_T4 = 5

    # Accelerator type is NVIDIA Tesla T4 Virtual Workstations.
    NVIDIA_TESLA_T4_VWS = 8

    # Accelerator type is NVIDIA Tesla P100 Virtual Workstations.
    NVIDIA_TESLA_P100_VWS = 9

    # Accelerator type is NVIDIA Tesla P4 Virtual Workstations.
    NVIDIA_TESLA_P4_VWS = 10

    # (Coming soon) Accelerator type is TPU V2.
    TPU_V2 = 6

    # (Coming soon) Accelerator type is TPU V3.
    TPU_V3 = 7
  end

  # The definition of the states of this instance.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The control logic is starting the instance.
    STARTING = 1

    # The control logic is installing required frameworks and registering the
    # instance with notebook proxy
    PROVISIONING = 2

    # The instance is running.
    ACTIVE = 3

    # The control logic is stopping the instance.
    STOPPING = 4

    # The instance is stopped.
    STOPPED = 5

    # The instance is deleted.
    DELETED = 6

    # The instance is upgrading.
    UPGRADING = 7

    # The instance is being created.
    INITIALIZING = 8

    # The instance is getting registered.
    REGISTERING = 9

    # The instance is suspending.
    SUSPENDING = 10

    # The instance is suspended.
    SUSPENDED = 11
  end

  # Possible disk types for notebook instances.
  module DiskType
    # Disk type not set.
    DISK_TYPE_UNSPECIFIED = 0

    # Standard persistent disk type.
    PD_STANDARD = 1

    # SSD persistent disk type.
    PD_SSD = 2

    # Balanced persistent disk type.
    PD_BALANCED = 3
  end

  # Definition of the disk encryption options.
  module DiskEncryption
    # Disk encryption is not specified.
    DISK_ENCRYPTION_UNSPECIFIED = 0

    # Use Google managed encryption keys to encrypt the boot disk.
    GMEK = 1

    # Use customer managed encryption keys to encrypt the boot disk.
    CMEK = 2
  end

  # The type of vNIC driver.
  module NicType
    # No type specified. Default should be UNSPECIFIED_NIC_TYPE.
    UNSPECIFIED_NIC_TYPE = 0

    # VIRTIO. Default in Notebooks DLVM.
    VIRTIO_NET = 1

    # GVNIC. Alternative to VIRTIO.
    # https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux
    GVNIC = 2
  end
end