Package com.google.cloud.workstations.v1

Class WorkstationConfig.Container

    • 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

      • getImage

        public String getImage()
         Optional. A Docker container image that defines a custom environment.

 Cloud Workstations provides a number of
 [preconfigured
 images](https://cloud.google.com/workstations/docs/preconfigured-base-images),
 but you can create your own
 [custom container
 images](https://cloud.google.com/workstations/docs/custom-container-images).
 If using a private image, the `host.gceInstance.serviceAccount` field
 must be specified in the workstation configuration and must have
 permission to pull the specified image. Otherwise, the image must be
 publicly accessible.
        string image = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getImage in interface WorkstationConfig.ContainerOrBuilder
        Returns:
        The image.

      • getImageBytes

        public com.google.protobuf.ByteString getImageBytes()
         Optional. A Docker container image that defines a custom environment.

 Cloud Workstations provides a number of
 [preconfigured
 images](https://cloud.google.com/workstations/docs/preconfigured-base-images),
 but you can create your own
 [custom container
 images](https://cloud.google.com/workstations/docs/custom-container-images).
 If using a private image, the `host.gceInstance.serviceAccount` field
 must be specified in the workstation configuration and must have
 permission to pull the specified image. Otherwise, the image must be
 publicly accessible.
        string image = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getImageBytes in interface WorkstationConfig.ContainerOrBuilder
        Returns:
        The bytes for image.

      • getCommandList

        public com.google.protobuf.ProtocolStringList getCommandList()
         Optional. If set, overrides the default ENTRYPOINT specified by the
 image.
        repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCommandList in interface WorkstationConfig.ContainerOrBuilder
        Returns:
        A list containing the command.

      • getCommandCount

        public int getCommandCount()
         Optional. If set, overrides the default ENTRYPOINT specified by the
 image.
        repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCommandCount in interface WorkstationConfig.ContainerOrBuilder
        Returns:
        The count of command.

      • getCommand

        public String getCommand​(int index)
         Optional. If set, overrides the default ENTRYPOINT specified by the
 image.
        repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCommand in interface WorkstationConfig.ContainerOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The command at the given index.

      • getCommandBytes

        public com.google.protobuf.ByteString getCommandBytes​(int index)
         Optional. If set, overrides the default ENTRYPOINT specified by the
 image.
        repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCommandBytes in interface WorkstationConfig.ContainerOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the command at the given index.

      • getArgsList

        public com.google.protobuf.ProtocolStringList getArgsList()
         Optional. Arguments passed to the entrypoint.
        repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgsList in interface WorkstationConfig.ContainerOrBuilder
        Returns:
        A list containing the args.

      • getArgsCount

        public int getArgsCount()
         Optional. Arguments passed to the entrypoint.
        repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgsCount in interface WorkstationConfig.ContainerOrBuilder
        Returns:
        The count of args.

      • getArgs

        public String getArgs​(int index)
         Optional. Arguments passed to the entrypoint.
        repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgs in interface WorkstationConfig.ContainerOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The args at the given index.

      • getArgsBytes

        public com.google.protobuf.ByteString getArgsBytes​(int index)
         Optional. Arguments passed to the entrypoint.
        repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getArgsBytes in interface WorkstationConfig.ContainerOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the args at the given index.

      • containsEnv

        public boolean containsEnv​(String key)
         Optional. Environment variables passed to the container's entrypoint.
        map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsEnv in interface WorkstationConfig.ContainerOrBuilder

      • getWorkingDir

        public String getWorkingDir()
         Optional. If set, overrides the default DIR specified by the image.
        string working_dir = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getWorkingDir in interface WorkstationConfig.ContainerOrBuilder
        Returns:
        The workingDir.

      • getWorkingDirBytes

        public com.google.protobuf.ByteString getWorkingDirBytes()
         Optional. If set, overrides the default DIR specified by the image.
        string working_dir = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getWorkingDirBytes in interface WorkstationConfig.ContainerOrBuilder
        Returns:
        The bytes for workingDir.

      • getRunAsUser

        public int getRunAsUser()
         Optional. If set, overrides the USER specified in the image with the
 given uid.
        int32 run_as_user = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRunAsUser in interface WorkstationConfig.ContainerOrBuilder
        Returns:
        The runAsUser.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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