Class Runtime

public final class Runtime extends GeneratedMessageV3 implements RuntimeOrBuilder

The definition of a Runtime for a managed notebook instance.

Protobuf type google.cloud.notebooks.v1.Runtime

Implements

RuntimeOrBuilder

Fields

ACCESS_CONFIG_FIELD_NUMBER

public static final int ACCESS_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

HEALTH_STATE_FIELD_NUMBER

public static final int HEALTH_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SOFTWARE_CONFIG_FIELD_NUMBER

public static final int SOFTWARE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

VIRTUAL_MACHINE_FIELD_NUMBER

public static final int VIRTUAL_MACHINE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAccessConfig()

public RuntimeAccessConfig getAccessConfig()

The config settings for accessing runtime.

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

Returns
TypeDescription
RuntimeAccessConfig

The accessConfig.

getAccessConfigOrBuilder()

public RuntimeAccessConfigOrBuilder getAccessConfigOrBuilder()

The config settings for accessing runtime.

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

Returns
TypeDescription
RuntimeAccessConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Runtime creation time.

.google.protobuf.Timestamp create_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Runtime creation time.

.google.protobuf.Timestamp create_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstance()

public static Runtime getDefaultInstance()
Returns
TypeDescription
Runtime

getDefaultInstanceForType()

public Runtime getDefaultInstanceForType()
Returns
TypeDescription
Runtime

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getHealthState()

public Runtime.HealthState getHealthState()

Output only. Runtime health_state.

.google.cloud.notebooks.v1.Runtime.HealthState health_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Runtime.HealthState

The healthState.

getHealthStateValue()

public int getHealthStateValue()

Output only. Runtime health_state.

.google.cloud.notebooks.v1.Runtime.HealthState health_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for healthState.

getMetrics()

public RuntimeMetrics getMetrics()

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

.google.cloud.notebooks.v1.RuntimeMetrics metrics = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
RuntimeMetrics

The metrics.

getMetricsOrBuilder()

public RuntimeMetricsOrBuilder getMetricsOrBuilder()

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

.google.cloud.notebooks.v1.RuntimeMetrics metrics = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
RuntimeMetricsOrBuilder

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Runtime> getParserForType()
Returns
TypeDescription
Parser<Runtime>
Overrides

getRuntimeTypeCase()

public Runtime.RuntimeTypeCase getRuntimeTypeCase()
Returns
TypeDescription
Runtime.RuntimeTypeCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSoftwareConfig()

public RuntimeSoftwareConfig getSoftwareConfig()

The config settings for software inside the runtime.

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

Returns
TypeDescription
RuntimeSoftwareConfig

The softwareConfig.

getSoftwareConfigOrBuilder()

public RuntimeSoftwareConfigOrBuilder getSoftwareConfigOrBuilder()

The config settings for software inside the runtime.

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

Returns
TypeDescription
RuntimeSoftwareConfigOrBuilder

getState()

public Runtime.State getState()

Output only. Runtime state.

.google.cloud.notebooks.v1.Runtime.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Runtime.State

The state.

getStateValue()

public int getStateValue()

Output only. Runtime state.

.google.cloud.notebooks.v1.Runtime.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Runtime update time.

.google.protobuf.Timestamp update_time = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Runtime update time.

.google.protobuf.Timestamp update_time = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getVirtualMachine()

public VirtualMachine getVirtualMachine()

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

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

Returns
TypeDescription
VirtualMachine

The virtualMachine.

getVirtualMachineOrBuilder()

public VirtualMachineOrBuilder getVirtualMachineOrBuilder()

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

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

Returns
TypeDescription
VirtualMachineOrBuilder

hasAccessConfig()

public boolean hasAccessConfig()

The config settings for accessing runtime.

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

Returns
TypeDescription
boolean

Whether the accessConfig field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Runtime creation time.

.google.protobuf.Timestamp create_time = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.cloud.notebooks.v1.RuntimeMetrics metrics = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the metrics field is set.

hasSoftwareConfig()

public boolean hasSoftwareConfig()

The config settings for software inside the runtime.

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

Returns
TypeDescription
boolean

Whether the softwareConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Runtime update time.

.google.protobuf.Timestamp update_time = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hasVirtualMachine()

public boolean hasVirtualMachine()

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

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

Returns
TypeDescription
boolean

Whether the virtualMachine field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Runtime.Builder newBuilder()
Returns
TypeDescription
Runtime.Builder

newBuilder(Runtime prototype)

public static Runtime.Builder newBuilder(Runtime prototype)
Parameter
NameDescription
prototypeRuntime
Returns
TypeDescription
Runtime.Builder

newBuilderForType()

public Runtime.Builder newBuilderForType()
Returns
TypeDescription
Runtime.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Runtime.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Runtime.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Runtime parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Runtime parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Runtime parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Runtime parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Runtime parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Runtime parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Runtime parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Runtime parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Runtime
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Runtime> parser()
Returns
TypeDescription
Parser<Runtime>

toBuilder()

public Runtime.Builder toBuilder()
Returns
TypeDescription
Runtime.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException