Package com.google.cloud.notebooks.v2

Interface InstanceOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Instance, Instance.Builder
    public interface InstanceOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • hasGceSetup

        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:
        Whether the gceSetup field is set.

      • getGceSetup

        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:
        The gceSetup.

      • getGceSetupOrBuilder

        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];

      • getProxyUri

        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:
        The proxyUri.

      • getProxyUriBytes

        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];
        Returns:
        The bytes for proxyUri.

      • getInstanceOwnersList

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

      • getInstanceOwnersCount

        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:
        The count of instanceOwners.

      • getInstanceOwners

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

      • getInstanceOwnersBytes

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the instanceOwners at the given index.

      • getCreator

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

      • getCreatorBytes

        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];
        Returns:
        The bytes for creator.

      • getStateValue

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

      • getState

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

      • getUpgradeHistoryList

        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];

      • getUpgradeHistory

        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];

      • getUpgradeHistoryCount

        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];

      • getUpgradeHistoryOrBuilderList

        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];

      • getUpgradeHistoryOrBuilder

        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];

      • getId

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

      • getIdBytes

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

      • getHealthStateValue

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

      • getHealthState

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

      • getHealthInfoCount

        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];

      • containsHealthInfo

        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];

      • getHealthInfoMap

        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 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];

      • getHealthInfoOrThrow

        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];

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Instance creation time.
        .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Instance update time.
        .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getDisableProxyAccess

        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:
        The disableProxyAccess.

      • getLabelsCount

        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];

      • containsLabels

        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];

      • getLabelsMap

        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 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];

      • getLabelsOrThrow

        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];