Class Environment.Builder (0.42.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Environment.Builder

Implements

EnvironmentOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Environment.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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()

Use #getSecretVariablesMap() instead.

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

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

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Environment.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Environment.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Environment.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)