Class LaunchTemplateParameters.Builder (0.59.0)

public static final class LaunchTemplateParameters.Builder extends GeneratedMessageV3.Builder<LaunchTemplateParameters.Builder> implements LaunchTemplateParametersOrBuilder

Parameters to provide to the template being launched.

Protobuf type google.dataflow.v1beta3.LaunchTemplateParameters

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public LaunchTemplateParameters build()
Returns
Type Description
LaunchTemplateParameters

buildPartial()

public LaunchTemplateParameters buildPartial()
Returns
Type Description
LaunchTemplateParameters

clear()

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

clearEnvironment()

public LaunchTemplateParameters.Builder clearEnvironment()

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Returns
Type Description
LaunchTemplateParameters.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearJobName()

public LaunchTemplateParameters.Builder clearJobName()

Required. The job name to use for the created job.

string job_name = 1;

Returns
Type Description
LaunchTemplateParameters.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParameters()

public LaunchTemplateParameters.Builder clearParameters()
Returns
Type Description
LaunchTemplateParameters.Builder

clearTransformNameMapping()

public LaunchTemplateParameters.Builder clearTransformNameMapping()
Returns
Type Description
LaunchTemplateParameters.Builder

clearUpdate()

public LaunchTemplateParameters.Builder clearUpdate()

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

bool update = 4;

Returns
Type Description
LaunchTemplateParameters.Builder

This builder for chaining.

clone()

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

containsParameters(String key)

public boolean containsParameters(String key)

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsTransformNameMapping(String key)

public boolean containsTransformNameMapping(String key)

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public LaunchTemplateParameters getDefaultInstanceForType()
Returns
Type Description
LaunchTemplateParameters

getDescriptorForType()

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

getEnvironment()

public RuntimeEnvironment getEnvironment()

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Returns
Type Description
RuntimeEnvironment

The environment.

getEnvironmentBuilder()

public RuntimeEnvironment.Builder getEnvironmentBuilder()

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Returns
Type Description
RuntimeEnvironment.Builder

getEnvironmentOrBuilder()

public RuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Returns
Type Description
RuntimeEnvironmentOrBuilder

getJobName()

public String getJobName()

Required. The job name to use for the created job.

string job_name = 1;

Returns
Type Description
String

The jobName.

getJobNameBytes()

public ByteString getJobNameBytes()

Required. The job name to use for the created job.

string job_name = 1;

Returns
Type Description
ByteString

The bytes for jobName.

getMutableParameters() (deprecated)

public Map<String,String> getMutableParameters()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableTransformNameMapping() (deprecated)

public Map<String,String> getMutableTransformNameMapping()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getParameters() (deprecated)

public Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
Type Description
Map<String,String>

getParametersCount()

public int getParametersCount()

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Returns
Type Description
int

getParametersMap()

public Map<String,String> getParametersMap()

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Returns
Type Description
Map<String,String>

getParametersOrDefault(String key, String defaultValue)

public String getParametersOrDefault(String key, String defaultValue)

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getParametersOrThrow(String key)

public String getParametersOrThrow(String key)

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getTransformNameMapping() (deprecated)

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

getTransformNameMappingCount()

public int getTransformNameMappingCount()

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 5;

Returns
Type Description
int

getTransformNameMappingMap()

public Map<String,String> getTransformNameMappingMap()

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 5;

Returns
Type Description
Map<String,String>

getTransformNameMappingOrDefault(String key, String defaultValue)

public String getTransformNameMappingOrDefault(String key, String defaultValue)

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 5;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getTransformNameMappingOrThrow(String key)

public String getTransformNameMappingOrThrow(String key)

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 5;

Parameter
Name Description
key String
Returns
Type Description
String

getUpdate()

public boolean getUpdate()

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

bool update = 4;

Returns
Type Description
boolean

The update.

hasEnvironment()

public boolean hasEnvironment()

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Returns
Type Description
boolean

Whether the environment 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

mergeEnvironment(RuntimeEnvironment value)

public LaunchTemplateParameters.Builder mergeEnvironment(RuntimeEnvironment value)

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Parameter
Name Description
value RuntimeEnvironment
Returns
Type Description
LaunchTemplateParameters.Builder

mergeFrom(LaunchTemplateParameters other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllParameters(Map<String,String> values)

public LaunchTemplateParameters.Builder putAllParameters(Map<String,String> values)

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

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

putAllTransformNameMapping(Map<String,String> values)

public LaunchTemplateParameters.Builder putAllTransformNameMapping(Map<String,String> values)

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 5;

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

putParameters(String key, String value)

public LaunchTemplateParameters.Builder putParameters(String key, String value)

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

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

putTransformNameMapping(String key, String value)

public LaunchTemplateParameters.Builder putTransformNameMapping(String key, String value)

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 5;

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

removeParameters(String key)

public LaunchTemplateParameters.Builder removeParameters(String key)

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
LaunchTemplateParameters.Builder

removeTransformNameMapping(String key)

public LaunchTemplateParameters.Builder removeTransformNameMapping(String key)

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

map<string, string> transform_name_mapping = 5;

Parameter
Name Description
key String
Returns
Type Description
LaunchTemplateParameters.Builder

setEnvironment(RuntimeEnvironment value)

public LaunchTemplateParameters.Builder setEnvironment(RuntimeEnvironment value)

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Parameter
Name Description
value RuntimeEnvironment
Returns
Type Description
LaunchTemplateParameters.Builder

setEnvironment(RuntimeEnvironment.Builder builderForValue)

public LaunchTemplateParameters.Builder setEnvironment(RuntimeEnvironment.Builder builderForValue)

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Parameter
Name Description
builderForValue RuntimeEnvironment.Builder
Returns
Type Description
LaunchTemplateParameters.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setJobName(String value)

public LaunchTemplateParameters.Builder setJobName(String value)

Required. The job name to use for the created job.

string job_name = 1;

Parameter
Name Description
value String

The jobName to set.

Returns
Type Description
LaunchTemplateParameters.Builder

This builder for chaining.

setJobNameBytes(ByteString value)

public LaunchTemplateParameters.Builder setJobNameBytes(ByteString value)

Required. The job name to use for the created job.

string job_name = 1;

Parameter
Name Description
value ByteString

The bytes for jobName to set.

Returns
Type Description
LaunchTemplateParameters.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdate(boolean value)

public LaunchTemplateParameters.Builder setUpdate(boolean value)

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

bool update = 4;

Parameter
Name Description
value boolean

The update to set.

Returns
Type Description
LaunchTemplateParameters.Builder

This builder for chaining.