Package com.google.cloud.notebooks.v1

Class Environment

  • All Implemented Interfaces:
    EnvironmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Environment
extends com.google.protobuf.GeneratedMessageV3
implements EnvironmentOrBuilder
     Definition of a software environment that is used to start a notebook
 instance.
    Protobuf type google.cloud.notebooks.v1.Environment
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Environment.Builder
      Definition of a software environment that is used to start a notebook instance.
      static class  Environment.ImageTypeCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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()

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. Name of this environment.
 Format:
 `projects/{project_id}/locations/{location}/environments/{environment_id}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface EnvironmentOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Name of this environment.
 Format:
 `projects/{project_id}/locations/{location}/environments/{environment_id}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface EnvironmentOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Display name of this environment for the UI.
        string display_name = 2;
        Specified by:
        getDisplayName in interface EnvironmentOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Display name of this environment for the UI.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface EnvironmentOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         A brief description of this environment.
        string description = 3;
        Specified by:
        getDescription in interface EnvironmentOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A brief description of this environment.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface EnvironmentOrBuilder
        Returns:
        The bytes for description.

      • hasVmImage

        public boolean hasVmImage()
         Use a Compute Engine VM image to start the notebook instance.
        .google.cloud.notebooks.v1.VmImage vm_image = 6;
        Specified by:
        hasVmImage in interface EnvironmentOrBuilder
        Returns:
        Whether the vmImage field is set.

      • getVmImage

        public VmImage getVmImage()
         Use a Compute Engine VM image to start the notebook instance.
        .google.cloud.notebooks.v1.VmImage vm_image = 6;
        Specified by:
        getVmImage in interface EnvironmentOrBuilder
        Returns:
        The vmImage.

      • hasContainerImage

        public boolean hasContainerImage()
         Use a container image to start the notebook instance.
        .google.cloud.notebooks.v1.ContainerImage container_image = 7;
        Specified by:
        hasContainerImage in interface EnvironmentOrBuilder
        Returns:
        Whether the containerImage field is set.

      • getContainerImage

        public ContainerImage getContainerImage()
         Use a container image to start the notebook instance.
        .google.cloud.notebooks.v1.ContainerImage container_image = 7;
        Specified by:
        getContainerImage in interface EnvironmentOrBuilder
        Returns:
        The containerImage.

      • getPostStartupScript

        public String getPostStartupScript()
         Path to a Bash script that automatically runs after a notebook instance
 fully boots up. The path must be a URL or
 Cloud Storage path. Example: `"gs://path-to-file/file-name"`
        string post_startup_script = 8;
        Specified by:
        getPostStartupScript in interface EnvironmentOrBuilder
        Returns:
        The postStartupScript.

      • getPostStartupScriptBytes

        public com.google.protobuf.ByteString getPostStartupScriptBytes()
         Path to a Bash script that automatically runs after a notebook instance
 fully boots up. The path must be a URL or
 Cloud Storage path. Example: `"gs://path-to-file/file-name"`
        string post_startup_script = 8;
        Specified by:
        getPostStartupScriptBytes in interface EnvironmentOrBuilder
        Returns:
        The bytes for postStartupScript.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time at which this environment was created.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface EnvironmentOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time at which this environment was created.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface EnvironmentOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time at which this environment was created.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface EnvironmentOrBuilder

      • 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 Environment parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Environment getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Environment> 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 Environment getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder