Class: Google::Cloud::Notebooks::V1::Runtime

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

Overview

The definition of a Runtime for a managed notebook instance.

Defined Under Namespace

Modules: HealthState, State

Instance Attribute Summary collapse

Instance Attribute Details

#access_config ⇒ ::Google::Cloud::Notebooks::V1::RuntimeAccessConfig

Returns The config settings for accessing runtime.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 55

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

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

    # The compute layer is starting the runtime. It is not ready for use.
    STARTING = 1

    # The compute layer is installing required frameworks and registering the
    # runtime with notebook proxy. It cannot be used.
    PROVISIONING = 2

    # The runtime is currently running. It is ready for use.
    ACTIVE = 3

    # The control logic is stopping the runtime. It cannot be used.
    STOPPING = 4

    # The runtime is stopped. It cannot be used.
    STOPPED = 5

    # The runtime is being deleted. It cannot be used.
    DELETING = 6

    # The runtime is upgrading. It cannot be used.
    UPGRADING = 7

    # The runtime is being created and set up. It is not ready for use.
    INITIALIZING = 8
  end

  # The runtime substate.
  module HealthState
    # The runtime substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The runtime is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The runtime is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The runtime has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The runtime health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end

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

Returns Output only. Runtime creation time.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 55

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

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

    # The compute layer is starting the runtime. It is not ready for use.
    STARTING = 1

    # The compute layer is installing required frameworks and registering the
    # runtime with notebook proxy. It cannot be used.
    PROVISIONING = 2

    # The runtime is currently running. It is ready for use.
    ACTIVE = 3

    # The control logic is stopping the runtime. It cannot be used.
    STOPPING = 4

    # The runtime is stopped. It cannot be used.
    STOPPED = 5

    # The runtime is being deleted. It cannot be used.
    DELETING = 6

    # The runtime is upgrading. It cannot be used.
    UPGRADING = 7

    # The runtime is being created and set up. It is not ready for use.
    INITIALIZING = 8
  end

  # The runtime substate.
  module HealthState
    # The runtime substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The runtime is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The runtime is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The runtime has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The runtime health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end

#health_state ⇒ ::Google::Cloud::Notebooks::V1::Runtime::HealthState (readonly)

Returns Output only. Runtime health_state.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 55

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

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

    # The compute layer is starting the runtime. It is not ready for use.
    STARTING = 1

    # The compute layer is installing required frameworks and registering the
    # runtime with notebook proxy. It cannot be used.
    PROVISIONING = 2

    # The runtime is currently running. It is ready for use.
    ACTIVE = 3

    # The control logic is stopping the runtime. It cannot be used.
    STOPPING = 4

    # The runtime is stopped. It cannot be used.
    STOPPED = 5

    # The runtime is being deleted. It cannot be used.
    DELETING = 6

    # The runtime is upgrading. It cannot be used.
    UPGRADING = 7

    # The runtime is being created and set up. It is not ready for use.
    INITIALIZING = 8
  end

  # The runtime substate.
  module HealthState
    # The runtime substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The runtime is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The runtime is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The runtime has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The runtime health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end

#metrics ⇒ ::Google::Cloud::Notebooks::V1::RuntimeMetrics (readonly)

Returns Output only. Contains Runtime daemon metrics such as Service status and JupyterLab stats.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 55

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

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

    # The compute layer is starting the runtime. It is not ready for use.
    STARTING = 1

    # The compute layer is installing required frameworks and registering the
    # runtime with notebook proxy. It cannot be used.
    PROVISIONING = 2

    # The runtime is currently running. It is ready for use.
    ACTIVE = 3

    # The control logic is stopping the runtime. It cannot be used.
    STOPPING = 4

    # The runtime is stopped. It cannot be used.
    STOPPED = 5

    # The runtime is being deleted. It cannot be used.
    DELETING = 6

    # The runtime is upgrading. It cannot be used.
    UPGRADING = 7

    # The runtime is being created and set up. It is not ready for use.
    INITIALIZING = 8
  end

  # The runtime substate.
  module HealthState
    # The runtime substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The runtime is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The runtime is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The runtime has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The runtime health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the runtime. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}.

Returns:

  • (::String) —

    Output only. The resource name of the runtime. Format: projects/{project}/locations/{location}/runtimes/{runtimeId}



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 55

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

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

    # The compute layer is starting the runtime. It is not ready for use.
    STARTING = 1

    # The compute layer is installing required frameworks and registering the
    # runtime with notebook proxy. It cannot be used.
    PROVISIONING = 2

    # The runtime is currently running. It is ready for use.
    ACTIVE = 3

    # The control logic is stopping the runtime. It cannot be used.
    STOPPING = 4

    # The runtime is stopped. It cannot be used.
    STOPPED = 5

    # The runtime is being deleted. It cannot be used.
    DELETING = 6

    # The runtime is upgrading. It cannot be used.
    UPGRADING = 7

    # The runtime is being created and set up. It is not ready for use.
    INITIALIZING = 8
  end

  # The runtime substate.
  module HealthState
    # The runtime substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The runtime is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The runtime is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The runtime has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The runtime health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end

#software_config ⇒ ::Google::Cloud::Notebooks::V1::RuntimeSoftwareConfig

Returns The config settings for software inside the runtime.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 55

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

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

    # The compute layer is starting the runtime. It is not ready for use.
    STARTING = 1

    # The compute layer is installing required frameworks and registering the
    # runtime with notebook proxy. It cannot be used.
    PROVISIONING = 2

    # The runtime is currently running. It is ready for use.
    ACTIVE = 3

    # The control logic is stopping the runtime. It cannot be used.
    STOPPING = 4

    # The runtime is stopped. It cannot be used.
    STOPPED = 5

    # The runtime is being deleted. It cannot be used.
    DELETING = 6

    # The runtime is upgrading. It cannot be used.
    UPGRADING = 7

    # The runtime is being created and set up. It is not ready for use.
    INITIALIZING = 8
  end

  # The runtime substate.
  module HealthState
    # The runtime substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The runtime is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The runtime is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The runtime has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The runtime health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end

#state ⇒ ::Google::Cloud::Notebooks::V1::Runtime::State (readonly)

Returns Output only. Runtime state.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 55

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

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

    # The compute layer is starting the runtime. It is not ready for use.
    STARTING = 1

    # The compute layer is installing required frameworks and registering the
    # runtime with notebook proxy. It cannot be used.
    PROVISIONING = 2

    # The runtime is currently running. It is ready for use.
    ACTIVE = 3

    # The control logic is stopping the runtime. It cannot be used.
    STOPPING = 4

    # The runtime is stopped. It cannot be used.
    STOPPED = 5

    # The runtime is being deleted. It cannot be used.
    DELETING = 6

    # The runtime is upgrading. It cannot be used.
    UPGRADING = 7

    # The runtime is being created and set up. It is not ready for use.
    INITIALIZING = 8
  end

  # The runtime substate.
  module HealthState
    # The runtime substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The runtime is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The runtime is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The runtime has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The runtime health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end

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

Returns Output only. Runtime update time.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 55

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

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

    # The compute layer is starting the runtime. It is not ready for use.
    STARTING = 1

    # The compute layer is installing required frameworks and registering the
    # runtime with notebook proxy. It cannot be used.
    PROVISIONING = 2

    # The runtime is currently running. It is ready for use.
    ACTIVE = 3

    # The control logic is stopping the runtime. It cannot be used.
    STOPPING = 4

    # The runtime is stopped. It cannot be used.
    STOPPED = 5

    # The runtime is being deleted. It cannot be used.
    DELETING = 6

    # The runtime is upgrading. It cannot be used.
    UPGRADING = 7

    # The runtime is being created and set up. It is not ready for use.
    INITIALIZING = 8
  end

  # The runtime substate.
  module HealthState
    # The runtime substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The runtime is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The runtime is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The runtime has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The runtime health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end

#virtual_machine ⇒ ::Google::Cloud::Notebooks::V1::VirtualMachine

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

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 55

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

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

    # The compute layer is starting the runtime. It is not ready for use.
    STARTING = 1

    # The compute layer is installing required frameworks and registering the
    # runtime with notebook proxy. It cannot be used.
    PROVISIONING = 2

    # The runtime is currently running. It is ready for use.
    ACTIVE = 3

    # The control logic is stopping the runtime. It cannot be used.
    STOPPING = 4

    # The runtime is stopped. It cannot be used.
    STOPPED = 5

    # The runtime is being deleted. It cannot be used.
    DELETING = 6

    # The runtime is upgrading. It cannot be used.
    UPGRADING = 7

    # The runtime is being created and set up. It is not ready for use.
    INITIALIZING = 8
  end

  # The runtime substate.
  module HealthState
    # The runtime substate is unknown.
    HEALTH_STATE_UNSPECIFIED = 0

    # The runtime is known to be in an healthy state
    # (for example, critical daemons are running)
    # Applies to ACTIVE state.
    HEALTHY = 1

    # The runtime is known to be in an unhealthy state
    # (for example, critical daemons are not running)
    # Applies to ACTIVE state.
    UNHEALTHY = 2

    # The runtime has not installed health monitoring agent.
    # Applies to ACTIVE state.
    AGENT_NOT_INSTALLED = 3

    # The runtime health monitoring agent is not running.
    # Applies to ACTIVE state.
    AGENT_NOT_RUNNING = 4
  end
end