Class Instance.Builder (1.47.0) 

public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> implements InstanceOrBuilder

The definition of a notebook instance.

Protobuf type google.cloud.notebooks.v2.Instance

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Instance.Builder

Implements

InstanceOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllInstanceOwners(Iterable<String> values)

public Instance.Builder addAllInstanceOwners(Iterable<String> values)

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The instanceOwners to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addAllUpgradeHistory(Iterable<? extends UpgradeHistoryEntry> values)

public Instance.Builder addAllUpgradeHistory(Iterable<? extends UpgradeHistoryEntry> values)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.notebooks.v2.UpgradeHistoryEntry>
Returns
Type Description
Instance.Builder

addInstanceOwners(String value)

public Instance.Builder addInstanceOwners(String value)

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The instanceOwners to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addInstanceOwnersBytes(ByteString value)

public Instance.Builder addInstanceOwnersBytes(ByteString value)

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the instanceOwners to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addUpgradeHistory(UpgradeHistoryEntry value)

public Instance.Builder addUpgradeHistory(UpgradeHistoryEntry value)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value UpgradeHistoryEntry
Returns
Type Description
Instance.Builder

addUpgradeHistory(UpgradeHistoryEntry.Builder builderForValue)

public Instance.Builder addUpgradeHistory(UpgradeHistoryEntry.Builder builderForValue)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue UpgradeHistoryEntry.Builder
Returns
Type Description
Instance.Builder

addUpgradeHistory(int index, UpgradeHistoryEntry value)

public Instance.Builder addUpgradeHistory(int index, UpgradeHistoryEntry value)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value UpgradeHistoryEntry
Returns
Type Description
Instance.Builder

addUpgradeHistory(int index, UpgradeHistoryEntry.Builder builderForValue)

public Instance.Builder addUpgradeHistory(int index, UpgradeHistoryEntry.Builder builderForValue)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue UpgradeHistoryEntry.Builder
Returns
Type Description
Instance.Builder

addUpgradeHistoryBuilder()

public UpgradeHistoryEntry.Builder addUpgradeHistoryBuilder()

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UpgradeHistoryEntry.Builder

addUpgradeHistoryBuilder(int index)

public UpgradeHistoryEntry.Builder addUpgradeHistoryBuilder(int index)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
UpgradeHistoryEntry.Builder

build()

public Instance build()
Returns
Type Description
Instance

buildPartial()

public Instance buildPartial()
Returns
Type Description
Instance

clear()

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

clearCreateTime()

public Instance.Builder clearCreateTime()

Output only. Instance creation time.

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

Returns
Type Description
Instance.Builder

clearCreator()

public Instance.Builder clearCreator()

Output only. Email address of entity that sent original CreateInstance request.

string creator = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearDisableProxyAccess()

public Instance.Builder clearDisableProxyAccess()

Optional. If true, the notebook instance will not register with the proxy.

bool disable_proxy_access = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearGceSetup()

public Instance.Builder clearGceSetup()

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

.google.cloud.notebooks.v2.GceSetup gce_setup = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

clearHealthInfo()

public Instance.Builder clearHealthInfo()
Returns
Type Description
Instance.Builder

clearHealthState()

public Instance.Builder clearHealthState()

Output only. Instance health_state.

.google.cloud.notebooks.v2.HealthState health_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearId()

public Instance.Builder clearId()

Output only. Unique ID of the resource.

string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearInfrastructure()

public Instance.Builder clearInfrastructure()
Returns
Type Description
Instance.Builder

clearInstanceOwners()

public Instance.Builder clearInstanceOwners()

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearLabels()

public Instance.Builder clearLabels()
Returns
Type Description
Instance.Builder

clearName()

public Instance.Builder clearName()

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

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

Returns
Type Description
Instance.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProxyUri()

public Instance.Builder clearProxyUri()

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string proxy_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearState()

public Instance.Builder clearState()

Output only. The state of this instance.

.google.cloud.notebooks.v2.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearUpdateTime()

public Instance.Builder clearUpdateTime()

Output only. Instance update time.

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

Returns
Type Description
Instance.Builder

clearUpgradeHistory()

public Instance.Builder clearUpgradeHistory()

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

clone()

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

containsHealthInfo(String key)

public boolean containsHealthInfo(String key)

Output only. Additional information about instance health. Example:

 healthInfo": {
   "docker_proxy_agent_status": "1",
   "docker_status": "1",
   "jupyterlab_api_status": "-1",
   "jupyterlab_status": "-1",
   "updated": "2020-10-18 09:40:03.573409"
 }

map<string, string> health_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Instance creation time.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Instance creation time.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Instance creation time.

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

Returns
Type Description
TimestampOrBuilder

getCreator()

public String getCreator()

Output only. Email address of entity that sent original CreateInstance request.

string creator = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The creator.

getCreatorBytes()

public ByteString getCreatorBytes()

Output only. Email address of entity that sent original CreateInstance request.

string creator = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for creator.

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
Type Description
Instance

getDescriptorForType()

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

getDisableProxyAccess()

public boolean getDisableProxyAccess()

Optional. If true, the notebook instance will not register with the proxy.

bool disable_proxy_access = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The disableProxyAccess.

getGceSetup()

public GceSetup getGceSetup()

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

.google.cloud.notebooks.v2.GceSetup gce_setup = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GceSetup

The gceSetup.

getGceSetupBuilder()

public GceSetup.Builder getGceSetupBuilder()

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

.google.cloud.notebooks.v2.GceSetup gce_setup = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GceSetup.Builder

getGceSetupOrBuilder()

public GceSetupOrBuilder getGceSetupOrBuilder()

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

.google.cloud.notebooks.v2.GceSetup gce_setup = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GceSetupOrBuilder

getHealthInfo() (deprecated)

public Map<String,String> getHealthInfo()

Use #getHealthInfoMap() instead.

Returns
Type Description
Map<String,String>

getHealthInfoCount()

public int getHealthInfoCount()

Output only. Additional information about instance health. Example:

 healthInfo": {
   "docker_proxy_agent_status": "1",
   "docker_status": "1",
   "jupyterlab_api_status": "-1",
   "jupyterlab_status": "-1",
   "updated": "2020-10-18 09:40:03.573409"
 }

map<string, string> health_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getHealthInfoMap()

public Map<String,String> getHealthInfoMap()

Output only. Additional information about instance health. Example:

 healthInfo": {
   "docker_proxy_agent_status": "1",
   "docker_status": "1",
   "jupyterlab_api_status": "-1",
   "jupyterlab_status": "-1",
   "updated": "2020-10-18 09:40:03.573409"
 }

map<string, string> health_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Map<String,String>

getHealthInfoOrDefault(String key, String defaultValue)

public String getHealthInfoOrDefault(String key, String defaultValue)

Output only. Additional information about instance health. Example:

 healthInfo": {
   "docker_proxy_agent_status": "1",
   "docker_status": "1",
   "jupyterlab_api_status": "-1",
   "jupyterlab_status": "-1",
   "updated": "2020-10-18 09:40:03.573409"
 }

map<string, string> health_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getHealthInfoOrThrow(String key)

public String getHealthInfoOrThrow(String key)

Output only. Additional information about instance health. Example:

 healthInfo": {
   "docker_proxy_agent_status": "1",
   "docker_status": "1",
   "jupyterlab_api_status": "-1",
   "jupyterlab_status": "-1",
   "updated": "2020-10-18 09:40:03.573409"
 }

map<string, string> health_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
String

getHealthState()

public HealthState getHealthState()

Output only. Instance health_state.

.google.cloud.notebooks.v2.HealthState health_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
HealthState

The healthState.

getHealthStateValue()

public int getHealthStateValue()

Output only. Instance health_state.

.google.cloud.notebooks.v2.HealthState health_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for healthState.

getId()

public String getId()

Output only. Unique ID of the resource.

string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Output only. Unique ID of the resource.

string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for id.

getInfrastructureCase()

public Instance.InfrastructureCase getInfrastructureCase()
Returns
Type Description
Instance.InfrastructureCase

getInstanceOwners(int index)

public String getInstanceOwners(int index)

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The instanceOwners at the given index.

getInstanceOwnersBytes(int index)

public ByteString getInstanceOwnersBytes(int index)

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the instanceOwners at the given index.

getInstanceOwnersCount()

public int getInstanceOwnersCount()

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of instanceOwners.

getInstanceOwnersList()

public ProtocolStringList getInstanceOwnersList()

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the instanceOwners.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableHealthInfo() (deprecated)

public Map<String,String> getMutableHealthInfo()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

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

Returns
Type Description
ByteString

The bytes for name.

getProxyUri()

public String getProxyUri()

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string proxy_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The proxyUri.

getProxyUriBytes()

public ByteString getProxyUriBytes()

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string proxy_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for proxyUri.

getState()

public State getState()

Output only. The state of this instance.

.google.cloud.notebooks.v2.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
State

The state.

getStateValue()

public int getStateValue()

Output only. The state of this instance.

.google.cloud.notebooks.v2.State state = 6 [(.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. Instance update time.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Instance update time.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Instance update time.

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

Returns
Type Description
TimestampOrBuilder

getUpgradeHistory(int index)

public UpgradeHistoryEntry getUpgradeHistory(int index)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
UpgradeHistoryEntry

getUpgradeHistoryBuilder(int index)

public UpgradeHistoryEntry.Builder getUpgradeHistoryBuilder(int index)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
UpgradeHistoryEntry.Builder

getUpgradeHistoryBuilderList()

public List<UpgradeHistoryEntry.Builder> getUpgradeHistoryBuilderList()

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getUpgradeHistoryCount()

public int getUpgradeHistoryCount()

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getUpgradeHistoryList()

public List<UpgradeHistoryEntry> getUpgradeHistoryList()

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<UpgradeHistoryEntry>

getUpgradeHistoryOrBuilder(int index)

public UpgradeHistoryEntryOrBuilder getUpgradeHistoryOrBuilder(int index)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
UpgradeHistoryEntryOrBuilder

getUpgradeHistoryOrBuilderList()

public List<? extends UpgradeHistoryEntryOrBuilder> getUpgradeHistoryOrBuilderList()

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.notebooks.v2.UpgradeHistoryEntryOrBuilder>

hasCreateTime()

public boolean hasCreateTime()

Output only. Instance creation time.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasGceSetup()

public boolean hasGceSetup()

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

.google.cloud.notebooks.v2.GceSetup gce_setup = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the gceSetup field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Instance update time.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Instance.Builder mergeCreateTime(Timestamp value)

Output only. Instance creation time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

mergeFrom(Instance other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGceSetup(GceSetup value)

public Instance.Builder mergeGceSetup(GceSetup value)

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

.google.cloud.notebooks.v2.GceSetup gce_setup = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GceSetup
Returns
Type Description
Instance.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public Instance.Builder mergeUpdateTime(Timestamp value)

Output only. Instance update time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

putAllHealthInfo(Map<String,String> values)

public Instance.Builder putAllHealthInfo(Map<String,String> values)

Output only. Additional information about instance health. Example:

 healthInfo": {
   "docker_proxy_agent_status": "1",
   "docker_status": "1",
   "jupyterlab_api_status": "-1",
   "jupyterlab_status": "-1",
   "updated": "2020-10-18 09:40:03.573409"
 }

map<string, string> health_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Instance.Builder

putAllLabels(Map<String,String> values)

public Instance.Builder putAllLabels(Map<String,String> values)

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Instance.Builder

putHealthInfo(String key, String value)

public Instance.Builder putHealthInfo(String key, String value)

Output only. Additional information about instance health. Example:

 healthInfo": {
   "docker_proxy_agent_status": "1",
   "docker_status": "1",
   "jupyterlab_api_status": "-1",
   "jupyterlab_status": "-1",
   "updated": "2020-10-18 09:40:03.573409"
 }

map<string, string> health_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
value String
Returns
Type Description
Instance.Builder

putLabels(String key, String value)

public Instance.Builder putLabels(String key, String value)

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
Instance.Builder

removeHealthInfo(String key)

public Instance.Builder removeHealthInfo(String key)

Output only. Additional information about instance health. Example:

 healthInfo": {
   "docker_proxy_agent_status": "1",
   "docker_status": "1",
   "jupyterlab_api_status": "-1",
   "jupyterlab_status": "-1",
   "updated": "2020-10-18 09:40:03.573409"
 }

map<string, string> health_info = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
Instance.Builder

removeLabels(String key)

public Instance.Builder removeLabels(String key)

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Instance.Builder

removeUpgradeHistory(int index)

public Instance.Builder removeUpgradeHistory(int index)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Instance.Builder

setCreateTime(Timestamp value)

public Instance.Builder setCreateTime(Timestamp value)

Output only. Instance creation time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Instance.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Instance creation time.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Instance.Builder

setCreator(String value)

public Instance.Builder setCreator(String value)

Output only. Email address of entity that sent original CreateInstance request.

string creator = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The creator to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setCreatorBytes(ByteString value)

public Instance.Builder setCreatorBytes(ByteString value)

Output only. Email address of entity that sent original CreateInstance request.

string creator = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for creator to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setDisableProxyAccess(boolean value)

public Instance.Builder setDisableProxyAccess(boolean value)

Optional. If true, the notebook instance will not register with the proxy.

bool disable_proxy_access = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The disableProxyAccess to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setGceSetup(GceSetup value)

public Instance.Builder setGceSetup(GceSetup value)

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

.google.cloud.notebooks.v2.GceSetup gce_setup = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GceSetup
Returns
Type Description
Instance.Builder

setGceSetup(GceSetup.Builder builderForValue)

public Instance.Builder setGceSetup(GceSetup.Builder builderForValue)

Optional. Compute Engine setup for the notebook. Uses notebook-defined fields.

.google.cloud.notebooks.v2.GceSetup gce_setup = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue GceSetup.Builder
Returns
Type Description
Instance.Builder

setHealthState(HealthState value)

public Instance.Builder setHealthState(HealthState value)

Output only. Instance health_state.

.google.cloud.notebooks.v2.HealthState health_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value HealthState

The healthState to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setHealthStateValue(int value)

public Instance.Builder setHealthStateValue(int value)

Output only. Instance health_state.

.google.cloud.notebooks.v2.HealthState health_state = 9 [(.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
Instance.Builder

This builder for chaining.

setId(String value)

public Instance.Builder setId(String value)

Output only. Unique ID of the resource.

string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The id to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Instance.Builder setIdBytes(ByteString value)

Output only. Unique ID of the resource.

string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for id to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setInstanceOwners(int index, String value)

public Instance.Builder setInstanceOwners(int index, String value)

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value String

The instanceOwners to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setName(String value)

public Instance.Builder setName(String value)

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Instance.Builder setNameBytes(ByteString value)

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setProxyUri(String value)

public Instance.Builder setProxyUri(String value)

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string proxy_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The proxyUri to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setProxyUriBytes(ByteString value)

public Instance.Builder setProxyUriBytes(ByteString value)

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string proxy_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for proxyUri to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

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

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

setState(State value)

public Instance.Builder setState(State value)

Output only. The state of this instance.

.google.cloud.notebooks.v2.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value State

The state to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setStateValue(int value)

public Instance.Builder setStateValue(int value)

Output only. The state of this instance.

.google.cloud.notebooks.v2.State state = 6 [(.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
Instance.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public Instance.Builder setUpdateTime(Timestamp value)

Output only. Instance update time.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Instance.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Instance update time.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Instance.Builder

setUpgradeHistory(int index, UpgradeHistoryEntry value)

public Instance.Builder setUpgradeHistory(int index, UpgradeHistoryEntry value)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value UpgradeHistoryEntry
Returns
Type Description
Instance.Builder

setUpgradeHistory(int index, UpgradeHistoryEntry.Builder builderForValue)

public Instance.Builder setUpgradeHistory(int index, UpgradeHistoryEntry.Builder builderForValue)

Output only. The upgrade history of this instance.

repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue UpgradeHistoryEntry.Builder
Returns
Type Description
Instance.Builder