Class Environment.Builder (0.36.0)

public static final class Environment.Builder extends GeneratedMessageV3.Builder<Environment.Builder> implements EnvironmentOrBuilder

An Environment describes a collection of environment variables to set when executing Tasks.

Protobuf type google.cloud.batch.v1.Environment

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Environment.Builder
Overrides

build()

public Environment build()
Returns
Type Description
Environment

buildPartial()

public Environment buildPartial()
Returns
Type Description
Environment

clear()

public Environment.Builder clear()
Returns
Type Description
Environment.Builder
Overrides

clearEncryptedVariables()

public Environment.Builder clearEncryptedVariables()

An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

.google.cloud.batch.v1.Environment.KMSEnvMap encrypted_variables = 3;

Returns
Type Description
Environment.Builder

clearField(Descriptors.FieldDescriptor field)

public Environment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Environment.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Environment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Environment.Builder
Overrides

clearSecretVariables()

public Environment.Builder clearSecretVariables()
Returns
Type Description
Environment.Builder

clearVariables()

public Environment.Builder clearVariables()
Returns
Type Description
Environment.Builder

clone()

public Environment.Builder clone()
Returns
Type Description
Environment.Builder
Overrides

containsSecretVariables(String key)

public boolean containsSecretVariables(String key)

A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.

map<string, string> secret_variables = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsVariables(String key)

public boolean containsVariables(String key)

A map of environment variable names to values.

map<string, string> variables = 1;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public Environment getDefaultInstanceForType()
Returns
Type Description
Environment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEncryptedVariables()

public Environment.KMSEnvMap getEncryptedVariables()

An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

.google.cloud.batch.v1.Environment.KMSEnvMap encrypted_variables = 3;

Returns
Type Description
Environment.KMSEnvMap

The encryptedVariables.

getEncryptedVariablesBuilder()

public Environment.KMSEnvMap.Builder getEncryptedVariablesBuilder()

An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

.google.cloud.batch.v1.Environment.KMSEnvMap encrypted_variables = 3;

Returns
Type Description
Environment.KMSEnvMap.Builder

getEncryptedVariablesOrBuilder()

public Environment.KMSEnvMapOrBuilder getEncryptedVariablesOrBuilder()

An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

.google.cloud.batch.v1.Environment.KMSEnvMap encrypted_variables = 3;

Returns
Type Description
Environment.KMSEnvMapOrBuilder

getMutableSecretVariables() (deprecated)

public Map<String,String> getMutableSecretVariables()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableVariables() (deprecated)

public Map<String,String> getMutableVariables()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getSecretVariables() (deprecated)

public Map<String,String> getSecretVariables()
Returns
Type Description
Map<String,String>

getSecretVariablesCount()

public int getSecretVariablesCount()

A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.

map<string, string> secret_variables = 2;

Returns
Type Description
int

getSecretVariablesMap()

public Map<String,String> getSecretVariablesMap()

A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.

map<string, string> secret_variables = 2;

Returns
Type Description
Map<String,String>

getSecretVariablesOrDefault(String key, String defaultValue)

public String getSecretVariablesOrDefault(String key, String defaultValue)

A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.

map<string, string> secret_variables = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getSecretVariablesOrThrow(String key)

public String getSecretVariablesOrThrow(String key)

A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.

map<string, string> secret_variables = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getVariables() (deprecated)

public Map<String,String> getVariables()

Use #getVariablesMap() instead.

Returns
Type Description
Map<String,String>

getVariablesCount()

public int getVariablesCount()

A map of environment variable names to values.

map<string, string> variables = 1;

Returns
Type Description
int

getVariablesMap()

public Map<String,String> getVariablesMap()

A map of environment variable names to values.

map<string, string> variables = 1;

Returns
Type Description
Map<String,String>

getVariablesOrDefault(String key, String defaultValue)

public String getVariablesOrDefault(String key, String defaultValue)

A map of environment variable names to values.

map<string, string> variables = 1;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getVariablesOrThrow(String key)

public String getVariablesOrThrow(String key)

A map of environment variable names to values.

map<string, string> variables = 1;

Parameter
Name Description
key String
Returns
Type Description
String

hasEncryptedVariables()

public boolean hasEncryptedVariables()

An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

.google.cloud.batch.v1.Environment.KMSEnvMap encrypted_variables = 3;

Returns
Type Description
boolean

Whether the encryptedVariables field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEncryptedVariables(Environment.KMSEnvMap value)

public Environment.Builder mergeEncryptedVariables(Environment.KMSEnvMap value)

An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

.google.cloud.batch.v1.Environment.KMSEnvMap encrypted_variables = 3;

Parameter
Name Description
value Environment.KMSEnvMap
Returns
Type Description
Environment.Builder

mergeFrom(Environment other)

public Environment.Builder mergeFrom(Environment other)
Parameter
Name Description
other Environment
Returns
Type Description
Environment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Environment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Environment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Environment.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Environment.Builder
Overrides

putAllSecretVariables(Map<String,String> values)

public Environment.Builder putAllSecretVariables(Map<String,String> values)

A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.

map<string, string> secret_variables = 2;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Environment.Builder

putAllVariables(Map<String,String> values)

public Environment.Builder putAllVariables(Map<String,String> values)

A map of environment variable names to values.

map<string, string> variables = 1;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Environment.Builder

putSecretVariables(String key, String value)

public Environment.Builder putSecretVariables(String key, String value)

A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.

map<string, string> secret_variables = 2;

Parameters
Name Description
key String
value String
Returns
Type Description
Environment.Builder

putVariables(String key, String value)

public Environment.Builder putVariables(String key, String value)

A map of environment variable names to values.

map<string, string> variables = 1;

Parameters
Name Description
key String
value String
Returns
Type Description
Environment.Builder

removeSecretVariables(String key)

public Environment.Builder removeSecretVariables(String key)

A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.

map<string, string> secret_variables = 2;

Parameter
Name Description
key String
Returns
Type Description
Environment.Builder

removeVariables(String key)

public Environment.Builder removeVariables(String key)

A map of environment variable names to values.

map<string, string> variables = 1;

Parameter
Name Description
key String
Returns
Type Description
Environment.Builder

setEncryptedVariables(Environment.KMSEnvMap value)

public Environment.Builder setEncryptedVariables(Environment.KMSEnvMap value)

An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

.google.cloud.batch.v1.Environment.KMSEnvMap encrypted_variables = 3;

Parameter
Name Description
value Environment.KMSEnvMap
Returns
Type Description
Environment.Builder

setEncryptedVariables(Environment.KMSEnvMap.Builder builderForValue)

public Environment.Builder setEncryptedVariables(Environment.KMSEnvMap.Builder builderForValue)

An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.

.google.cloud.batch.v1.Environment.KMSEnvMap encrypted_variables = 3;

Parameter
Name Description
builderForValue Environment.KMSEnvMap.Builder
Returns
Type Description
Environment.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Environment.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Environment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Environment.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Environment.Builder
Overrides