com.google.cloud.notebooks.v2.InstanceOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-notebooks-v2 Show documentation
Show all versions of proto-google-cloud-notebooks-v2 Show documentation
Proto library for google-cloud-notebooks
/*
* Copyright 2023 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/notebooks/v2/instance.proto
package com.google.cloud.notebooks.v2;
public interface InstanceOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.notebooks.v2.Instance)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Optional. Compute Engine setup for the notebook. Uses notebook-defined
* fields.
*
*
*
* .google.cloud.notebooks.v2.GceSetup gce_setup = 2 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the gceSetup field is set.
*/
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];
*
*
* @return The gceSetup.
*/
com.google.cloud.notebooks.v2.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];
*
*/
com.google.cloud.notebooks.v2.GceSetupOrBuilder getGceSetupOrBuilder();
/**
*
*
*
* Output only. The proxy endpoint that is used to access the Jupyter
* notebook.
*
*
* string proxy_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The proxyUri.
*/
java.lang.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];
*
* @return The bytes for proxyUri.
*/
com.google.protobuf.ByteString getProxyUriBytes();
/**
*
*
*
* 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];
*
*
* @return A list containing the instanceOwners.
*/
java.util.List 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];
*
*
* @return The count of instanceOwners.
*/
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];
*
*
* @param index The index of the element to return.
* @return The instanceOwners at the given index.
*/
java.lang.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];
*
*
* @param index The index of the value to return.
* @return The bytes of the instanceOwners at the given index.
*/
com.google.protobuf.ByteString getInstanceOwnersBytes(int index);
/**
*
*
*
* Output only. Email address of entity that sent original CreateInstance
* request.
*
*
* string creator = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The creator.
*/
java.lang.String getCreator();
/**
*
*
*
* Output only. Email address of entity that sent original CreateInstance
* request.
*
*
* string creator = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for creator.
*/
com.google.protobuf.ByteString getCreatorBytes();
/**
*
*
*
* Output only. The state of this instance.
*
*
* .google.cloud.notebooks.v2.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The state of this instance.
*
*
* .google.cloud.notebooks.v2.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.notebooks.v2.State getState();
/**
*
*
*
* Output only. The upgrade history of this instance.
*
*
*
* repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List getUpgradeHistoryList();
/**
*
*
*
* Output only. The upgrade history of this instance.
*
*
*
* repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.notebooks.v2.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];
*
*/
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];
*
*/
java.util.List
getUpgradeHistoryOrBuilderList();
/**
*
*
*
* Output only. The upgrade history of this instance.
*
*
*
* repeated .google.cloud.notebooks.v2.UpgradeHistoryEntry upgrade_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.notebooks.v2.UpgradeHistoryEntryOrBuilder getUpgradeHistoryOrBuilder(int index);
/**
*
*
*
* Output only. Unique ID of the resource.
*
*
* string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The id.
*/
java.lang.String getId();
/**
*
*
*
* Output only. Unique ID of the resource.
*
*
* string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for id.
*/
com.google.protobuf.ByteString getIdBytes();
/**
*
*
*
* Output only. Instance health_state.
*
*
*
* .google.cloud.notebooks.v2.HealthState health_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for healthState.
*/
int getHealthStateValue();
/**
*
*
*
* Output only. Instance health_state.
*
*
*
* .google.cloud.notebooks.v2.HealthState health_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The healthState.
*/
com.google.cloud.notebooks.v2.HealthState getHealthState();
/**
*
*
*
* 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];
*
*/
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];
*
*/
boolean containsHealthInfo(java.lang.String key);
/** Use {@link #getHealthInfoMap()} instead. */
@java.lang.Deprecated
java.util.Map getHealthInfo();
/**
*
*
*
* 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];
*
*/
java.util.Map 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];
*
*/
/* nullable */
java.lang.String getHealthInfoOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*
*/
java.lang.String getHealthInfoOrThrow(java.lang.String key);
/**
*
*
*
* Output only. Instance creation time.
*
*
* .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Instance creation time.
*
*
* .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Instance creation time.
*
*
* .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Instance update time.
*
*
* .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Instance update time.
*
*
* .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. Instance update time.
*
*
* .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Optional. If true, the notebook instance will not register with the proxy.
*
*
* bool disable_proxy_access = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The disableProxyAccess.
*/
boolean getDisableProxyAccess();
/**
*
*
*
* 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];
*/
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];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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];
*/
java.util.Map 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];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
com.google.cloud.notebooks.v2.Instance.InfrastructureCase getInfrastructureCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy