Interface InstanceOrBuilder (1.32.0)

Version 1.32.0

• 1.51.0 (latest)
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.3
• 1.0.6
• 0.6.2

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsHealthInfo(String key)

public abstract 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 abstract 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 abstract 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.

getCreateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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.

getDisableProxyAccess()

public abstract 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 abstract 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.

getGceSetupOrBuilder()

public abstract 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 abstract Map<String,String> getHealthInfo()

Use #getHealthInfoMap() instead.

Returns
Type	Description
Map<String,String>

getHealthInfoCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Instance.InfrastructureCase getInfrastructureCase()

Returns
Type	Description
Instance.InfrastructureCase

getInstanceOwners(int index)

public abstract String getInstanceOwners(int index)

Optional. Input only. The owner of this instance after creation. Format: [e-mail]

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 abstract ByteString getInstanceOwnersBytes(int index)

Optional. Input only. The owner of this instance after creation. Format: [e-mail]

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 abstract int getInstanceOwnersCount()

Optional. Input only. The owner of this instance after creation. Format: [e-mail]

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 abstract List<String> getInstanceOwnersList()

Optional. Input only. The owner of this instance after creation. Format: [e-mail]

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
List<String>	A list containing the instanceOwners.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getUpdateTimeOrBuilder()

public abstract 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 abstract 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

getUpgradeHistoryCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.