Class Runtime.Builder (1.53.0)

public static final class Runtime.Builder extends GeneratedMessageV3.Builder<Runtime.Builder> implements RuntimeOrBuilder

The definition of a Runtime for a managed notebook instance.

Protobuf type google.cloud.notebooks.v1.Runtime

Implements

RuntimeOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Runtime.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Runtime.Builder
Overrides

build()

public Runtime build()
Returns
Type Description
Runtime

buildPartial()

public Runtime buildPartial()
Returns
Type Description
Runtime

clear()

public Runtime.Builder clear()
Returns
Type Description
Runtime.Builder
Overrides

clearAccessConfig()

public Runtime.Builder clearAccessConfig()

The config settings for accessing runtime.

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

Returns
Type Description
Runtime.Builder

clearCreateTime()

public Runtime.Builder clearCreateTime()

Output only. Runtime creation time.

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

Returns
Type Description
Runtime.Builder

clearField(Descriptors.FieldDescriptor field)

public Runtime.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Runtime.Builder
Overrides

clearHealthState()

public Runtime.Builder clearHealthState()

Output only. Runtime health_state.

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

Returns
Type Description
Runtime.Builder

This builder for chaining.

clearMetrics()

public Runtime.Builder clearMetrics()

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
Type Description
Runtime.Builder

clearName()

public Runtime.Builder clearName()

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
Type Description
Runtime.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Runtime.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Runtime.Builder
Overrides

clearRuntimeType()

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

clearSoftwareConfig()

public Runtime.Builder clearSoftwareConfig()

The config settings for software inside the runtime.

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

Returns
Type Description
Runtime.Builder

clearState()

public Runtime.Builder clearState()

Output only. Runtime state.

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

Returns
Type Description
Runtime.Builder

This builder for chaining.

clearUpdateTime()

public Runtime.Builder clearUpdateTime()

Output only. Runtime update time.

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

Returns
Type Description
Runtime.Builder

clearVirtualMachine()

public Runtime.Builder clearVirtualMachine()

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

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

Returns
Type Description
Runtime.Builder

clone()

public Runtime.Builder clone()
Returns
Type Description
Runtime.Builder
Overrides

getAccessConfig()

public RuntimeAccessConfig getAccessConfig()

The config settings for accessing runtime.

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

Returns
Type Description
RuntimeAccessConfig

The accessConfig.

getAccessConfigBuilder()

public RuntimeAccessConfig.Builder getAccessConfigBuilder()

The config settings for accessing runtime.

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

Returns
Type Description
RuntimeAccessConfig.Builder

getAccessConfigOrBuilder()

public RuntimeAccessConfigOrBuilder getAccessConfigOrBuilder()

The config settings for accessing runtime.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Runtime creation time.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Runtime creation time.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Runtime getDefaultInstanceForType()
Returns
Type Description
Runtime

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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
Type Description
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
Type Description
RuntimeMetrics

The metrics.

getMetricsBuilder()

public RuntimeMetrics.Builder getMetricsBuilder()

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
Type Description
RuntimeMetrics.Builder

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

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

Returns
Type Description
ByteString

The bytes for name.

getRuntimeTypeCase()

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

getSoftwareConfig()

public RuntimeSoftwareConfig getSoftwareConfig()

The config settings for software inside the runtime.

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

Returns
Type Description
RuntimeSoftwareConfig

The softwareConfig.

getSoftwareConfigBuilder()

public RuntimeSoftwareConfig.Builder getSoftwareConfigBuilder()

The config settings for software inside the runtime.

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

Returns
Type Description
RuntimeSoftwareConfig.Builder

getSoftwareConfigOrBuilder()

public RuntimeSoftwareConfigOrBuilder getSoftwareConfigOrBuilder()

The config settings for software inside the runtime.

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

Returns
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Runtime update time.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Runtime update time.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Runtime update time.

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

Returns
Type Description
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
Type Description
VirtualMachine

The virtualMachine.

getVirtualMachineBuilder()

public VirtualMachine.Builder getVirtualMachineBuilder()

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

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

Returns
Type Description
VirtualMachine.Builder

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
Type Description
VirtualMachineOrBuilder

hasAccessConfig()

public boolean hasAccessConfig()

The config settings for accessing runtime.

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

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

Returns
Type Description
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
Type Description
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
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.cloud.notebooks.v1.VirtualMachine virtual_machine = 2;

Returns
Type Description
boolean

Whether the virtualMachine field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAccessConfig(RuntimeAccessConfig value)

public Runtime.Builder mergeAccessConfig(RuntimeAccessConfig value)

The config settings for accessing runtime.

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

Parameter
Name Description
value RuntimeAccessConfig
Returns
Type Description
Runtime.Builder

mergeCreateTime(Timestamp value)

public Runtime.Builder mergeCreateTime(Timestamp value)

Output only. Runtime creation time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Runtime.Builder

mergeFrom(Runtime other)

public Runtime.Builder mergeFrom(Runtime other)
Parameter
Name Description
other Runtime
Returns
Type Description
Runtime.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Runtime.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Runtime.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Runtime.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Runtime.Builder
Overrides

mergeMetrics(RuntimeMetrics value)

public Runtime.Builder mergeMetrics(RuntimeMetrics value)

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];

Parameter
Name Description
value RuntimeMetrics
Returns
Type Description
Runtime.Builder

mergeSoftwareConfig(RuntimeSoftwareConfig value)

public Runtime.Builder mergeSoftwareConfig(RuntimeSoftwareConfig value)

The config settings for software inside the runtime.

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

Parameter
Name Description
value RuntimeSoftwareConfig
Returns
Type Description
Runtime.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Runtime.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Runtime.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Runtime.Builder mergeUpdateTime(Timestamp value)

Output only. Runtime update time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Runtime.Builder

mergeVirtualMachine(VirtualMachine value)

public Runtime.Builder mergeVirtualMachine(VirtualMachine value)

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

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

Parameter
Name Description
value VirtualMachine
Returns
Type Description
Runtime.Builder

setAccessConfig(RuntimeAccessConfig value)

public Runtime.Builder setAccessConfig(RuntimeAccessConfig value)

The config settings for accessing runtime.

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

Parameter
Name Description
value RuntimeAccessConfig
Returns
Type Description
Runtime.Builder

setAccessConfig(RuntimeAccessConfig.Builder builderForValue)

public Runtime.Builder setAccessConfig(RuntimeAccessConfig.Builder builderForValue)

The config settings for accessing runtime.

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

Parameter
Name Description
builderForValue RuntimeAccessConfig.Builder
Returns
Type Description
Runtime.Builder

setCreateTime(Timestamp value)

public Runtime.Builder setCreateTime(Timestamp value)

Output only. Runtime creation time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Runtime.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Runtime.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Runtime creation time.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Runtime.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Runtime.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Runtime.Builder
Overrides

setHealthState(Runtime.HealthState value)

public Runtime.Builder setHealthState(Runtime.HealthState value)

Output only. Runtime health_state.

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

Parameter
Name Description
value Runtime.HealthState

The healthState to set.

Returns
Type Description
Runtime.Builder

This builder for chaining.

setHealthStateValue(int value)

public Runtime.Builder setHealthStateValue(int value)

Output only. Runtime health_state.

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

Parameter
Name Description
value int

The enum numeric value on the wire for healthState to set.

Returns
Type Description
Runtime.Builder

This builder for chaining.

setMetrics(RuntimeMetrics value)

public Runtime.Builder setMetrics(RuntimeMetrics value)

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];

Parameter
Name Description
value RuntimeMetrics
Returns
Type Description
Runtime.Builder

setMetrics(RuntimeMetrics.Builder builderForValue)

public Runtime.Builder setMetrics(RuntimeMetrics.Builder builderForValue)

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];

Parameter
Name Description
builderForValue RuntimeMetrics.Builder
Returns
Type Description
Runtime.Builder

setName(String value)

public Runtime.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Runtime.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Runtime.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Runtime.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Runtime.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Runtime.Builder
Overrides

setSoftwareConfig(RuntimeSoftwareConfig value)

public Runtime.Builder setSoftwareConfig(RuntimeSoftwareConfig value)

The config settings for software inside the runtime.

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

Parameter
Name Description
value RuntimeSoftwareConfig
Returns
Type Description
Runtime.Builder

setSoftwareConfig(RuntimeSoftwareConfig.Builder builderForValue)

public Runtime.Builder setSoftwareConfig(RuntimeSoftwareConfig.Builder builderForValue)

The config settings for software inside the runtime.

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

Parameter
Name Description
builderForValue RuntimeSoftwareConfig.Builder
Returns
Type Description
Runtime.Builder

setState(Runtime.State value)

public Runtime.Builder setState(Runtime.State value)

Output only. Runtime state.

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

Parameter
Name Description
value Runtime.State

The state to set.

Returns
Type Description
Runtime.Builder

This builder for chaining.

setStateValue(int value)

public Runtime.Builder setStateValue(int value)

Output only. Runtime state.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Runtime.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Runtime.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Runtime.Builder
Overrides

setUpdateTime(Timestamp value)

public Runtime.Builder setUpdateTime(Timestamp value)

Output only. Runtime update time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Runtime.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Runtime.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Runtime update time.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Runtime.Builder

setVirtualMachine(VirtualMachine value)

public Runtime.Builder setVirtualMachine(VirtualMachine value)

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

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

Parameter
Name Description
value VirtualMachine
Returns
Type Description
Runtime.Builder

setVirtualMachine(VirtualMachine.Builder builderForValue)

public Runtime.Builder setVirtualMachine(VirtualMachine.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue VirtualMachine.Builder
Returns
Type Description
Runtime.Builder