public static final class WorkstationConfig.Container.Builder extends GeneratedMessageV3.Builder<WorkstationConfig.Container.Builder> implements WorkstationConfig.ContainerOrBuilder
A Docker container.
Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.Container
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WorkstationConfig.Container.BuilderImplements
WorkstationConfig.ContainerOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllArgs(Iterable<String> values)
public WorkstationConfig.Container.Builder addAllArgs(Iterable<String> values)
Optional. Arguments passed to the entrypoint.
repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values | Iterable<String> The args to add. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
addAllCommand(Iterable<String> values)
public WorkstationConfig.Container.Builder addAllCommand(Iterable<String> values)
Optional. If set, overrides the default ENTRYPOINT specified by the image.
repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values | Iterable<String> The command to add. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
addArgs(String value)
public WorkstationConfig.Container.Builder addArgs(String value)
Optional. Arguments passed to the entrypoint.
repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | String The args to add. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
addArgsBytes(ByteString value)
public WorkstationConfig.Container.Builder addArgsBytes(ByteString value)
Optional. Arguments passed to the entrypoint.
repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes of the args to add. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
addCommand(String value)
public WorkstationConfig.Container.Builder addCommand(String value)
Optional. If set, overrides the default ENTRYPOINT specified by the image.
repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | String The command to add. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
addCommandBytes(ByteString value)
public WorkstationConfig.Container.Builder addCommandBytes(ByteString value)
Optional. If set, overrides the default ENTRYPOINT specified by the image.
repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes of the command to add. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public WorkstationConfig.Container.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
build()
public WorkstationConfig.Container build()
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container |
buildPartial()
public WorkstationConfig.Container buildPartial()
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container |
clear()
public WorkstationConfig.Container.Builder clear()
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
clearArgs()
public WorkstationConfig.Container.Builder clearArgs()
Optional. Arguments passed to the entrypoint.
repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
clearCommand()
public WorkstationConfig.Container.Builder clearCommand()
Optional. If set, overrides the default ENTRYPOINT specified by the image.
repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
clearEnv()
public WorkstationConfig.Container.Builder clearEnv()
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
clearField(Descriptors.FieldDescriptor field)
public WorkstationConfig.Container.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
clearImage()
public WorkstationConfig.Container.Builder clearImage()
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 |
WorkstationConfig.Container.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public WorkstationConfig.Container.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
clearRunAsUser()
public WorkstationConfig.Container.Builder clearRunAsUser()
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 |
WorkstationConfig.Container.Builder | This builder for chaining. |
clearWorkingDir()
public WorkstationConfig.Container.Builder clearWorkingDir()
Optional. If set, overrides the default DIR specified by the image.
string working_dir = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
clone()
public WorkstationConfig.Container.Builder clone()
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
containsEnv(String key)
public 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 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 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 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 ProtocolStringList getArgsList()
Optional. Arguments passed to the entrypoint.
repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the args. |
getCommand(int index)
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];
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 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 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 ProtocolStringList getCommandList()
Optional. If set, overrides the default ENTRYPOINT specified by the image.
repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the command. |
getDefaultInstanceForType()
public WorkstationConfig.Container getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getEnv() (deprecated)
public Map<String,String> getEnv()
Use #getEnvMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getEnvCount()
public 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 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 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 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 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 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. |
getMutableEnv() (deprecated)
public Map<String,String> getMutableEnv()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
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];
Returns | |
---|---|
Type | Description |
int | The runAsUser. |
getWorkingDir()
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(WorkstationConfig.Container other)
public WorkstationConfig.Container.Builder mergeFrom(WorkstationConfig.Container other)
Parameter | |
---|---|
Name | Description |
other | WorkstationConfig.Container |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WorkstationConfig.Container.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public WorkstationConfig.Container.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final WorkstationConfig.Container.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
putAllEnv(Map<String,String> values)
public WorkstationConfig.Container.Builder putAllEnv(Map<String,String> values)
Optional. Environment variables passed to the container's entrypoint.
map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values | Map<String,String> |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
putEnv(String key, String value)
public WorkstationConfig.Container.Builder putEnv(String key, String value)
Optional. Environment variables passed to the container's entrypoint.
map<string, string> env = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key | String |
value | String |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
removeEnv(String key)
public WorkstationConfig.Container.Builder removeEnv(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 |
WorkstationConfig.Container.Builder |
setArgs(int index, String value)
public WorkstationConfig.Container.Builder setArgs(int index, String value)
Optional. Arguments passed to the entrypoint.
repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The args to set. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
setCommand(int index, String value)
public WorkstationConfig.Container.Builder setCommand(int index, String value)
Optional. If set, overrides the default ENTRYPOINT specified by the image.
repeated string command = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The command to set. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public WorkstationConfig.Container.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
setImage(String value)
public WorkstationConfig.Container.Builder setImage(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The image to set. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
setImageBytes(ByteString value)
public WorkstationConfig.Container.Builder setImageBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for image to set. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public WorkstationConfig.Container.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
setRunAsUser(int value)
public WorkstationConfig.Container.Builder setRunAsUser(int value)
Optional. If set, overrides the USER specified in the image with the given uid.
int32 run_as_user = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | int The runAsUser to set. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final WorkstationConfig.Container.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder |
setWorkingDir(String value)
public WorkstationConfig.Container.Builder setWorkingDir(String value)
Optional. If set, overrides the default DIR specified by the image.
string working_dir = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | String The workingDir to set. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |
setWorkingDirBytes(ByteString value)
public WorkstationConfig.Container.Builder setWorkingDirBytes(ByteString value)
Optional. If set, overrides the default DIR specified by the image.
string working_dir = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for workingDir to set. |
Returns | |
---|---|
Type | Description |
WorkstationConfig.Container.Builder | This builder for chaining. |