Class Runtime (0.15.0) 

public final class Runtime extends GeneratedMessageV3 implements RuntimeOrBuilder

The definition of a Runtime for a managed notebook instance.

Protobuf type google.events.cloud.notebooks.v1.Runtime

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Runtime

Implements

RuntimeOrBuilder

Static Fields

ACCESS_CONFIG_FIELD_NUMBER

public static final int ACCESS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

HEALTH_STATE_FIELD_NUMBER

public static final int HEALTH_STATE_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SOFTWARE_CONFIG_FIELD_NUMBER

public static final int SOFTWARE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VIRTUAL_MACHINE_FIELD_NUMBER

public static final int VIRTUAL_MACHINE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Runtime getDefaultInstance()
Returns
Type Description
Runtime

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Runtime.Builder newBuilder()
Returns
Type Description
Runtime.Builder

newBuilder(Runtime prototype)

public static Runtime.Builder newBuilder(Runtime prototype)
Parameter
Name Description
prototype Runtime
Returns
Type Description
Runtime.Builder

parseDelimitedFrom(InputStream input)

public static Runtime parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Runtime
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Runtime parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Runtime
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Runtime parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Runtime
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Runtime
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Runtime parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Runtime
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Runtime
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Runtime parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Runtime
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Runtime
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Runtime parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Runtime
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Runtime
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Runtime parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Runtime
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Runtime
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Runtime> parser()
Returns
Type Description
Parser<Runtime>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. The labels to associate with this Managed Notebook or Runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 23;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccessConfig()

public RuntimeAccessConfig getAccessConfig()

The config settings for accessing runtime.

.google.events.cloud.notebooks.v1.RuntimeAccessConfig access_config = 5;

Returns
Type Description
RuntimeAccessConfig

The accessConfig.

getAccessConfigOrBuilder()

public RuntimeAccessConfigOrBuilder getAccessConfigOrBuilder()

The config settings for accessing runtime.

.google.events.cloud.notebooks.v1.RuntimeAccessConfig access_config = 5;

Returns
Type Description
RuntimeAccessConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Runtime creation time.

.google.protobuf.Timestamp create_time = 20;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Runtime creation time.

.google.protobuf.Timestamp create_time = 20;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Runtime getDefaultInstanceForType()
Returns
Type Description
Runtime

getHealthState()

public Runtime.HealthState getHealthState()

Output only. Runtime health_state.

.google.events.cloud.notebooks.v1.Runtime.HealthState health_state = 4;

Returns
Type Description
Runtime.HealthState

The healthState.

getHealthStateValue()

public int getHealthStateValue()

Output only. Runtime health_state.

.google.events.cloud.notebooks.v1.Runtime.HealthState health_state = 4;

Returns
Type Description
int

The enum numeric value on the wire for healthState.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. The labels to associate with this Managed Notebook or Runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 23;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. The labels to associate with this Managed Notebook or Runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 23;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels to associate with this Managed Notebook or Runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 23;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. The labels to associate with this Managed Notebook or Runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 23;

Parameter
Name Description
key String
Returns
Type Description
String

getMetrics()

public RuntimeMetrics getMetrics()

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

.google.events.cloud.notebooks.v1.RuntimeMetrics metrics = 7;

Returns
Type Description
RuntimeMetrics

The metrics.

getMetricsOrBuilder()

public RuntimeMetricsOrBuilder getMetricsOrBuilder()

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

.google.events.cloud.notebooks.v1.RuntimeMetrics metrics = 7;

Returns
Type Description
RuntimeMetricsOrBuilder

getName()

public String getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Runtime> getParserForType()
Returns
Type Description
Parser<Runtime>
Overrides

getRuntimeTypeCase()

public Runtime.RuntimeTypeCase getRuntimeTypeCase()
Returns
Type Description
Runtime.RuntimeTypeCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSoftwareConfig()

public RuntimeSoftwareConfig getSoftwareConfig()

The config settings for software inside the runtime.

.google.events.cloud.notebooks.v1.RuntimeSoftwareConfig software_config = 6;

Returns
Type Description
RuntimeSoftwareConfig

The softwareConfig.

getSoftwareConfigOrBuilder()

public RuntimeSoftwareConfigOrBuilder getSoftwareConfigOrBuilder()

The config settings for software inside the runtime.

.google.events.cloud.notebooks.v1.RuntimeSoftwareConfig software_config = 6;

Returns
Type Description
RuntimeSoftwareConfigOrBuilder

getState()

public Runtime.State getState()

Output only. Runtime state.

.google.events.cloud.notebooks.v1.Runtime.State state = 3;

Returns
Type Description
Runtime.State

The state.

getStateValue()

public int getStateValue()

Output only. Runtime state.

.google.events.cloud.notebooks.v1.Runtime.State state = 3;

Returns
Type Description
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Runtime update time.

.google.protobuf.Timestamp update_time = 21;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Runtime update time.

.google.protobuf.Timestamp update_time = 21;

Returns
Type Description
TimestampOrBuilder

getVirtualMachine()

public VirtualMachine getVirtualMachine()

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

.google.events.cloud.notebooks.v1.VirtualMachine virtual_machine = 2;

Returns
Type Description
VirtualMachine

The virtualMachine.

getVirtualMachineOrBuilder()

public VirtualMachineOrBuilder getVirtualMachineOrBuilder()

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

.google.events.cloud.notebooks.v1.VirtualMachine virtual_machine = 2;

Returns
Type Description
VirtualMachineOrBuilder

hasAccessConfig()

public boolean hasAccessConfig()

The config settings for accessing runtime.

.google.events.cloud.notebooks.v1.RuntimeAccessConfig access_config = 5;

Returns
Type Description
boolean

Whether the accessConfig field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Runtime creation time.

.google.protobuf.Timestamp create_time = 20;

Returns
Type Description
boolean

Whether the createTime field is set.

hasMetrics()

public boolean hasMetrics()

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

.google.events.cloud.notebooks.v1.RuntimeMetrics metrics = 7;

Returns
Type Description
boolean

Whether the metrics field is set.

hasSoftwareConfig()

public boolean hasSoftwareConfig()

The config settings for software inside the runtime.

.google.events.cloud.notebooks.v1.RuntimeSoftwareConfig software_config = 6;

Returns
Type Description
boolean

Whether the softwareConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Runtime update time.

.google.protobuf.Timestamp update_time = 21;

Returns
Type Description
boolean

Whether the updateTime field is set.

hasVirtualMachine()

public boolean hasVirtualMachine()

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

.google.events.cloud.notebooks.v1.VirtualMachine virtual_machine = 2;

Returns
Type Description
boolean

Whether the virtualMachine field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Runtime.Builder newBuilderForType()
Returns
Type Description
Runtime.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Runtime.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Runtime.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Runtime.Builder toBuilder()
Returns
Type Description
Runtime.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException