Package com.google.cloud.workstations.v1

Interface WorkstationConfig.ContainerOrBuilder

    • Method Detail

      • getImage

        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];
        Returns:
        The image.

      • getImageBytes

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

      • getCommandList

        List<String> getCommandList()
         Optional. If set, overrides the default ENTRYPOINT specified by the
 image.
        repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the command.

      • getCommandCount

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

      • getCommand

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

      • getCommandBytes

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

      • getArgsList

        List<String> getArgsList()
         Optional. Arguments passed to the entrypoint.
        repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the args.

      • getArgsCount

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

      • getArgs

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

      • getArgsBytes

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

      • getEnvCount

        int getEnvCount()
         Optional. Environment variables passed to the container's entrypoint.
        map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];

      • containsEnv

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

      • getEnvMap

        Map<String,​String> getEnvMap()
         Optional. Environment variables passed to the container's entrypoint.
        map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getEnvOrDefault

        String getEnvOrDefault​(String key,
                       String defaultValue)
         Optional. Environment variables passed to the container's entrypoint.
        map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getEnvOrThrow

        String getEnvOrThrow​(String key)
         Optional. Environment variables passed to the container's entrypoint.
        map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getWorkingDir

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

      • getWorkingDirBytes

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

      • getRunAsUser

        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];
        Returns:
        The runAsUser.