public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder
The definition of a notebook instance.
Protobuf type google.cloud.notebooks.v2.Instance
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATOR_FIELD_NUMBER
public static final int CREATOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISABLE_PROXY_ACCESS_FIELD_NUMBER
public static final int DISABLE_PROXY_ACCESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GCE_SETUP_FIELD_NUMBER
public static final int GCE_SETUP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HEALTH_INFO_FIELD_NUMBER
public static final int HEALTH_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HEALTH_STATE_FIELD_NUMBER
public static final int HEALTH_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INSTANCE_OWNERS_FIELD_NUMBER
public static final int INSTANCE_OWNERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROXY_URI_FIELD_NUMBER
public static final int PROXY_URI_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 |
|
UPGRADE_HISTORY_FIELD_NUMBER
public static final int UPGRADE_HISTORY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Instance getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Instance.Builder newBuilder()
newBuilder(Instance prototype)
public static Instance.Builder newBuilder(Instance prototype)
| Parameter |
| Name |
Description |
prototype |
Instance
|
public static Instance parseDelimitedFrom(InputStream input)
public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Instance parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Instance parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(CodedInputStream input)
public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(InputStream input)
public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Instance parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Instance> parser()
Methods
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
|
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Instance creation time.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
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()
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.
|
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];
getHealthInfo() (deprecated)
public Map<String,String> getHealthInfo()
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];
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];
| 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];
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()
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()
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];
getLabels() (deprecated)
public Map<String,String> getLabels()
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];
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];
| 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 |
|
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.
|
getParserForType()
public Parser<Instance> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Instance update time.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
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
|
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];
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
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Instance.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Instance.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
