Package com.google.cloud.notebooks.v1

Class Environment.Builder

  • All Implemented Interfaces:
    EnvironmentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Environment
    public static final class Environment.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>
implements EnvironmentOrBuilder
     Definition of a software environment that is used to start a notebook
 instance.
    Protobuf type google.cloud.notebooks.v1.Environment

    • Method Detail

      • 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.Builder<Environment.Builder>

      • clear

        public Environment.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Environment.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • setField

        public Environment.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • clearField

        public Environment.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • clearOneof

        public Environment.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • setRepeatedField

        public Environment.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • addRepeatedField

        public Environment.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • mergeFrom

        public Environment.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Environment.Builder>

      • isInitialized

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

      • mergeFrom

        public Environment.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Environment.Builder>
        Throws:
        IOException

      • 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.

      • setName

        public Environment.Builder setName​(String value)
         Output only. Name of this environment.
 Format:
 `projects/{project_id}/locations/{location}/environments/{environment_id}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Environment.Builder clearName()
         Output only. Name of this environment.
 Format:
 `projects/{project_id}/locations/{location}/environments/{environment_id}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setNameBytes

        public Environment.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Output only. Name of this environment.
 Format:
 `projects/{project_id}/locations/{location}/environments/{environment_id}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • 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.

      • setDisplayName

        public Environment.Builder setDisplayName​(String value)
         Display name of this environment for the UI.
        string display_name = 2;
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • clearDisplayName

        public Environment.Builder clearDisplayName()
         Display name of this environment for the UI.
        string display_name = 2;
        Returns:
        This builder for chaining.

      • setDisplayNameBytes

        public Environment.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         Display name of this environment for the UI.
        string display_name = 2;
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

      • 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.

      • setDescription

        public Environment.Builder setDescription​(String value)
         A brief description of this environment.
        string description = 3;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public Environment.Builder clearDescription()
         A brief description of this environment.
        string description = 3;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public Environment.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         A brief description of this environment.
        string description = 3;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

      • 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.

      • setVmImage

        public Environment.Builder setVmImage​(VmImage value)
         Use a Compute Engine VM image to start the notebook instance.
        .google.cloud.notebooks.v1.VmImage vm_image = 6;

      • setVmImage

        public Environment.Builder setVmImage​(VmImage.Builder builderForValue)
         Use a Compute Engine VM image to start the notebook instance.
        .google.cloud.notebooks.v1.VmImage vm_image = 6;

      • mergeVmImage

        public Environment.Builder mergeVmImage​(VmImage value)
         Use a Compute Engine VM image to start the notebook instance.
        .google.cloud.notebooks.v1.VmImage vm_image = 6;

      • clearVmImage

        public Environment.Builder clearVmImage()
         Use a Compute Engine VM image to start the notebook instance.
        .google.cloud.notebooks.v1.VmImage vm_image = 6;

      • getVmImageBuilder

        public VmImage.Builder getVmImageBuilder()
         Use a Compute Engine VM image to start the notebook instance.
        .google.cloud.notebooks.v1.VmImage vm_image = 6;

      • 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.

      • setContainerImage

        public Environment.Builder setContainerImage​(ContainerImage value)
         Use a container image to start the notebook instance.
        .google.cloud.notebooks.v1.ContainerImage container_image = 7;

      • setContainerImage

        public Environment.Builder setContainerImage​(ContainerImage.Builder builderForValue)
         Use a container image to start the notebook instance.
        .google.cloud.notebooks.v1.ContainerImage container_image = 7;

      • mergeContainerImage

        public Environment.Builder mergeContainerImage​(ContainerImage value)
         Use a container image to start the notebook instance.
        .google.cloud.notebooks.v1.ContainerImage container_image = 7;

      • clearContainerImage

        public Environment.Builder clearContainerImage()
         Use a container image to start the notebook instance.
        .google.cloud.notebooks.v1.ContainerImage container_image = 7;

      • getContainerImageBuilder

        public ContainerImage.Builder getContainerImageBuilder()
         Use a container image to start the notebook instance.
        .google.cloud.notebooks.v1.ContainerImage container_image = 7;

      • 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.

      • setPostStartupScript

        public Environment.Builder setPostStartupScript​(String value)
         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;
        Parameters:
        value - The postStartupScript to set.
        Returns:
        This builder for chaining.

      • clearPostStartupScript

        public Environment.Builder clearPostStartupScript()
         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;
        Returns:
        This builder for chaining.

      • setPostStartupScriptBytes

        public Environment.Builder setPostStartupScriptBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for postStartupScript to set.
        Returns:
        This builder for chaining.

      • 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.

      • setCreateTime

        public Environment.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time at which this environment was created.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setCreateTime

        public Environment.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The time at which this environment was created.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeCreateTime

        public Environment.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time at which this environment was created.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearCreateTime

        public Environment.Builder clearCreateTime()
         Output only. The time at which this environment was created.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. The time at which this environment was created.
        .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • 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

      • setUnknownFields

        public final Environment.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • mergeUnknownFields

        public final Environment.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>