Class: Google::Cloud::AIPlatform::V1::NotebookRuntime

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb

Overview

A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.

Defined Under Namespace

Modules: HealthState, RuntimeState Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when this NotebookRuntime was created.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#description ⇒ ::String

Returns The description of the NotebookRuntime.

Returns:

  • (::String) —

    The description of the NotebookRuntime.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#display_name ⇒ ::String

Returns Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns:

  • (::String) —

    Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec (readonly)

Returns Output only. Customer-managed encryption key spec for the notebook runtime.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#expiration_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this NotebookRuntime will be expired:

  1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted.
  2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Timestamp when this NotebookRuntime will be expired:

    1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted.
    2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.


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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#health_state ⇒ ::Google::Cloud::AIPlatform::V1::NotebookRuntime::HealthState (readonly)

Returns Output only. The health state of the NotebookRuntime.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#idle_shutdown_config ⇒ ::Google::Cloud::AIPlatform::V1::NotebookIdleShutdownConfig (readonly)

Returns Output only. The idle shutdown configuration of the notebook runtime.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#is_upgradable ⇒ ::Boolean (readonly)

Returns Output only. Whether NotebookRuntime is upgradable.

Returns:

  • (::Boolean) —

    Output only. Whether NotebookRuntime is upgradable.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

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

Returns The labels with user-defined metadata to organize your NotebookRuntime.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime:

  • "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id.
  • "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.

Returns:

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

    The labels with user-defined metadata to organize your NotebookRuntime.

    Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded).

    See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime:

    • "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id.
    • "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.


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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the NotebookRuntime.

Returns:

  • (::String) —

    Output only. The resource name of the NotebookRuntime.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#network_tags ⇒ ::Array<::String>

Returns Optional. The Compute Engine tags to add to runtime (see Tagging instances).

Returns:

  • (::Array<::String>) —

    Optional. The Compute Engine tags to add to runtime (see Tagging instances).



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#notebook_runtime_template_ref ⇒ ::Google::Cloud::AIPlatform::V1::NotebookRuntimeTemplateRef (readonly)

Returns Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#notebook_runtime_type ⇒ ::Google::Cloud::AIPlatform::V1::NotebookRuntimeType (readonly)

Returns Output only. The type of the notebook runtime.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#proxy_uri ⇒ ::String (readonly)

Returns Output only. The proxy endpoint used to access the NotebookRuntime.

Returns:

  • (::String) —

    Output only. The proxy endpoint used to access the NotebookRuntime.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#runtime_state ⇒ ::Google::Cloud::AIPlatform::V1::NotebookRuntime::RuntimeState (readonly)

Returns Output only. The runtime (instance) state of the NotebookRuntime.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#runtime_user ⇒ ::String

Returns Required. The user email of the NotebookRuntime.

Returns:

  • (::String) —

    Required. The user email of the NotebookRuntime.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#service_account ⇒ ::String (readonly)

Returns Output only. The service account that the NotebookRuntime workload runs as.

Returns:

  • (::String) —

    Output only. The service account that the NotebookRuntime workload runs as.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

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

Returns Output only. Timestamp when this NotebookRuntime was most recently updated.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end

#version ⇒ ::String (readonly)

Returns Output only. The VM os image version of NotebookRuntime.

Returns:

  • (::String) —

    Output only. The VM os image version of NotebookRuntime.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_runtime.rb', line 208

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

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

  # The substate of the NotebookRuntime to display health information.
  module HealthState
    # Unspecified health state.
    HEALTH_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in healthy state. Applies to ACTIVE state.
    HEALTHY = 1

    # NotebookRuntime is in unhealthy state. Applies to ACTIVE state.
    UNHEALTHY = 2
  end

  # The substate of the NotebookRuntime to display state of runtime.
  # The resource of NotebookRuntime is in ACTIVE state for these sub state.
  module RuntimeState
    # Unspecified runtime state.
    RUNTIME_STATE_UNSPECIFIED = 0

    # NotebookRuntime is in running state.
    RUNNING = 1

    # NotebookRuntime is in starting state.
    BEING_STARTED = 2

    # NotebookRuntime is in stopping state.
    BEING_STOPPED = 3

    # NotebookRuntime is in stopped state.
    STOPPED = 4

    # NotebookRuntime is in upgrading state. It is in the middle of upgrading
    # process.
    BEING_UPGRADED = 5

    # NotebookRuntime was unable to start/stop properly.
    ERROR = 100

    # NotebookRuntime is in invalid state. Cannot be recovered.
    INVALID = 101
  end
end