Runtime

google.cloud.notebooks.v1. Runtime

Represents a Runtime.

Constructor

new Runtime(propertiesopt)

Constructs a new Runtime.

Parameters:
Name Type Attributes Description
properties google.cloud.notebooks.v1.IRuntime <optional>

Properties to set

Implements:
  • IRuntime

Members

accessConfig

Runtime accessConfig.

createTime

Runtime createTime.

healthState

Runtime healthState.

metrics

Runtime metrics.

name

Runtime name.

runtimeType

Runtime runtimeType.

softwareConfig

Runtime softwareConfig.

state

Runtime state.

updateTime

Runtime updateTime.

virtualMachine

Runtime virtualMachine.

HealthState

HealthState enum.

Properties:
Name Type Description
HEALTH_STATE_UNSPECIFIED number

HEALTH_STATE_UNSPECIFIED value

HEALTHY number

HEALTHY value

UNHEALTHY number

UNHEALTHY value

AGENT_NOT_INSTALLED number

AGENT_NOT_INSTALLED value

AGENT_NOT_RUNNING number

AGENT_NOT_RUNNING value

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

STARTING number

STARTING value

PROVISIONING number

PROVISIONING value

ACTIVE number

ACTIVE value

STOPPING number

STOPPING value

STOPPED number

STOPPED value

DELETING number

DELETING value

UPGRADING number

UPGRADING value

INITIALIZING number

INITIALIZING value

Methods

toJSON() → {Object.<string, *>}

Converts this Runtime to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.notebooks.v1.Runtime}

Creates a new Runtime instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.notebooks.v1.IRuntime <optional>

Properties to set

Returns:
Type Description
google.cloud.notebooks.v1.Runtime

Runtime instance

(static) decode(reader, lengthopt) → {google.cloud.notebooks.v1.Runtime}

Decodes a Runtime message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.notebooks.v1.Runtime

Runtime

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.notebooks.v1.Runtime}

Decodes a Runtime message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.notebooks.v1.Runtime

Runtime

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Runtime message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.notebooks.v1.IRuntime

Runtime message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Runtime message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.notebooks.v1.IRuntime

Runtime message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.notebooks.v1.Runtime}

Creates a Runtime message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.notebooks.v1.Runtime

Runtime

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Runtime

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Runtime message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.notebooks.v1.Runtime

Runtime

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Runtime message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not