Interface WorkstationConfig.ContainerOrBuilder (0.34.0) 

public static interface WorkstationConfig.ContainerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsEnv(String key)

public abstract boolean containsEnv(String key)

Optional. Environment variables passed to the container's entrypoint.

map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getArgs(int index)

public abstract String getArgs(int index)

Optional. Arguments passed to the entrypoint.

repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The args at the given index.

getArgsBytes(int index)

public abstract ByteString getArgsBytes(int index)

Optional. Arguments passed to the entrypoint.

repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the args at the given index.

getArgsCount()

public abstract int getArgsCount()

Optional. Arguments passed to the entrypoint.

repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of args.

getArgsList()

public abstract List<String> getArgsList()

Optional. Arguments passed to the entrypoint.

repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the args.

getCommand(int index)

public abstract String getCommand(int index)

Optional. If set, overrides the default ENTRYPOINT specified by the image.

repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The command at the given index.

getCommandBytes(int index)

public abstract ByteString getCommandBytes(int index)

Optional. If set, overrides the default ENTRYPOINT specified by the image.

repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the command at the given index.

getCommandCount()

public abstract int getCommandCount()

Optional. If set, overrides the default ENTRYPOINT specified by the image.

repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of command.

getCommandList()

public abstract List<String> getCommandList()

Optional. If set, overrides the default ENTRYPOINT specified by the image.

repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the command.

getEnv() (deprecated)

public abstract Map<String,String> getEnv()

Use #getEnvMap() instead.

Returns
Type Description
Map<String,String>

getEnvCount()

public abstract int getEnvCount()

Optional. Environment variables passed to the container's entrypoint.

map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getEnvMap()

public abstract Map<String,String> getEnvMap()

Optional. Environment variables passed to the container's entrypoint.

map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getEnvOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getEnvOrThrow(String key)

public abstract String getEnvOrThrow(String key)

Optional. Environment variables passed to the container's entrypoint.

map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getImage()

public abstract String getImage()

Optional. A Docker container image that defines a custom environment.

Cloud Workstations provides a number of preconfigured images, but you can create your own 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
Type Description
String

The image.

getImageBytes()

public abstract ByteString getImageBytes()

Optional. A Docker container image that defines a custom environment.

Cloud Workstations provides a number of preconfigured images, but you can create your own 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
Type Description
ByteString

The bytes for image.

getRunAsUser()

public abstract 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
Type Description
int

The runAsUser.

getWorkingDir()

public abstract String getWorkingDir()

Optional. If set, overrides the default DIR specified by the image.

string working_dir = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The workingDir.

getWorkingDirBytes()

public abstract ByteString getWorkingDirBytes()

Optional. If set, overrides the default DIR specified by the image.

string working_dir = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for workingDir.