Package com.google.cloud.notebooks.v2

Class Instance

  • All Implemented Interfaces:
    InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Instance
extends com.google.protobuf.GeneratedMessageV3
implements InstanceOrBuilder
     The definition of a notebook instance.
    Protobuf type google.cloud.notebooks.v2.Instance
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getName in interface InstanceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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];
        Specified by:
        getNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        hasGceSetup in interface InstanceOrBuilder
        Returns:
        Whether the gceSetup field is set.

      • 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];
        Specified by:
        getGceSetup in interface InstanceOrBuilder
        Returns:
        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];
        Specified by:
        getGceSetupOrBuilder in interface InstanceOrBuilder

      • 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];
        Specified by:
        getProxyUri in interface InstanceOrBuilder
        Returns:
        The proxyUri.

      • getProxyUriBytes

        public com.google.protobuf.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];
        Specified by:
        getProxyUriBytes in interface InstanceOrBuilder
        Returns:
        The bytes for proxyUri.

      • getInstanceOwnersList

        public com.google.protobuf.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];
        Specified by:
        getInstanceOwnersList in interface InstanceOrBuilder
        Returns:
        A list containing the instanceOwners.

      • 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];
        Specified by:
        getInstanceOwnersCount in interface InstanceOrBuilder
        Returns:
        The count of instanceOwners.

      • getInstanceOwners

        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];
        Specified by:
        getInstanceOwners in interface InstanceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The instanceOwners at the given index.

      • getInstanceOwnersBytes

        public com.google.protobuf.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];
        Specified by:
        getInstanceOwnersBytes in interface InstanceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the instanceOwners at the given index.

      • getCreator

        public String getCreator()
         Output only. Email address of entity that sent original CreateInstance
 request.
        string creator = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreator in interface InstanceOrBuilder
        Returns:
        The creator.

      • getCreatorBytes

        public com.google.protobuf.ByteString getCreatorBytes()
         Output only. Email address of entity that sent original CreateInstance
 request.
        string creator = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreatorBytes in interface InstanceOrBuilder
        Returns:
        The bytes for creator.

      • getStateValue

        public int getStateValue()
         Output only. The state of this instance.
        .google.cloud.notebooks.v2.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public State getState()
         Output only. The state of this instance.
        .google.cloud.notebooks.v2.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface InstanceOrBuilder
        Returns:
        The state.

      • 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];
        Specified by:
        getUpgradeHistoryList in interface InstanceOrBuilder

      • 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];
        Specified by:
        getUpgradeHistoryCount in interface InstanceOrBuilder

      • getUpgradeHistory

        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];
        Specified by:
        getUpgradeHistory in interface InstanceOrBuilder

      • getUpgradeHistoryOrBuilder

        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];
        Specified by:
        getUpgradeHistoryOrBuilder in interface InstanceOrBuilder

      • getId

        public String getId()
         Output only. Unique ID of the resource.
        string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface InstanceOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Output only. Unique ID of the resource.
        string id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIdBytes in interface InstanceOrBuilder
        Returns:
        The bytes for id.

      • getHealthStateValue

        public int getHealthStateValue()
         Output only. Instance health_state.
        .google.cloud.notebooks.v2.HealthState health_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getHealthStateValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for healthState.

      • getHealthState

        public HealthState getHealthState()
         Output only. Instance health_state.
        .google.cloud.notebooks.v2.HealthState health_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getHealthState in interface InstanceOrBuilder
        Returns:
        The healthState.

      • getHealthInfoCount

        public int getHealthInfoCount()
        Description copied from interface: InstanceOrBuilder
         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];
        Specified by:
        getHealthInfoCount in interface InstanceOrBuilder

      • containsHealthInfo

        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];
        Specified by:
        containsHealthInfo in interface InstanceOrBuilder

      • 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];
        Specified by:
        getHealthInfoMap in interface InstanceOrBuilder

      • getHealthInfoOrDefault

        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];
        Specified by:
        getHealthInfoOrDefault in interface InstanceOrBuilder

      • getHealthInfoOrThrow

        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];
        Specified by:
        getHealthInfoOrThrow in interface InstanceOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Instance creation time.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface InstanceOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Instance creation time.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface InstanceOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Instance creation time.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface InstanceOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Instance update time.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface InstanceOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Instance update time.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface InstanceOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Instance update time.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface InstanceOrBuilder

      • 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];
        Specified by:
        getDisableProxyAccess in interface InstanceOrBuilder
        Returns:
        The disableProxyAccess.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: InstanceOrBuilder
         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];
        Specified by:
        getLabelsCount in interface InstanceOrBuilder

      • containsLabels

        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];
        Specified by:
        containsLabels in interface InstanceOrBuilder

      • 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];
        Specified by:
        getLabelsMap in interface InstanceOrBuilder

      • getLabelsOrDefault

        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];
        Specified by:
        getLabelsOrDefault in interface InstanceOrBuilder

      • getLabelsOrThrow

        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];
        Specified by:
        getLabelsOrThrow in interface InstanceOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Instance parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Instance.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Instance.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Instance.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Instance getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Instance> parser()

      • getParserForType

        public com.google.protobuf.Parser<Instance> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Instance getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder