Class LaunchTemplateParameters.Builder (0.35.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LaunchTemplateParameters.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
LaunchTemplateParameters.Builder
Overrides

build()

public LaunchTemplateParameters build()
Returns
TypeDescription
LaunchTemplateParameters

buildPartial()

public LaunchTemplateParameters buildPartial()
Returns
TypeDescription
LaunchTemplateParameters

clear()

public LaunchTemplateParameters.Builder clear()
Returns
TypeDescription
LaunchTemplateParameters.Builder
Overrides

clearEnvironment()

public LaunchTemplateParameters.Builder clearEnvironment()

The runtime environment for the job.

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

Returns
TypeDescription
LaunchTemplateParameters.Builder

clearField(Descriptors.FieldDescriptor field)

public LaunchTemplateParameters.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
LaunchTemplateParameters.Builder
Overrides

clearJobName()

public LaunchTemplateParameters.Builder clearJobName()

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

string job_name = 1;

Returns
TypeDescription
LaunchTemplateParameters.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LaunchTemplateParameters.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
LaunchTemplateParameters.Builder
Overrides

clearParameters()

public LaunchTemplateParameters.Builder clearParameters()
Returns
TypeDescription
LaunchTemplateParameters.Builder

clearTransformNameMapping()

public LaunchTemplateParameters.Builder clearTransformNameMapping()
Returns
TypeDescription
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
TypeDescription
LaunchTemplateParameters.Builder

This builder for chaining.

clone()

public LaunchTemplateParameters.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public LaunchTemplateParameters getDefaultInstanceForType()
Returns
TypeDescription
LaunchTemplateParameters

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnvironment()

public RuntimeEnvironment getEnvironment()

The runtime environment for the job.

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

Returns
TypeDescription
RuntimeEnvironment

The environment.

getEnvironmentBuilder()

public RuntimeEnvironment.Builder getEnvironmentBuilder()

The runtime environment for the job.

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

Returns
TypeDescription
RuntimeEnvironment.Builder

getEnvironmentOrBuilder()

public RuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()

The runtime environment for the job.

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

Returns
TypeDescription
RuntimeEnvironmentOrBuilder

getJobName()

public String getJobName()

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

string job_name = 1;

Returns
TypeDescription
String

The jobName.

getJobNameBytes()

public ByteString getJobNameBytes()

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

string job_name = 1;

Returns
TypeDescription
ByteString

The bytes for jobName.

getMutableParameters() (deprecated)

public Map<String,String> getMutableParameters()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getMutableTransformNameMapping() (deprecated)

public Map<String,String> getMutableTransformNameMapping()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getParameters() (deprecated)

public Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
TypeDescription
Map<String,String>

getParametersCount()

public int getParametersCount()

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Returns
TypeDescription
int

getParametersMap()

public Map<String,String> getParametersMap()

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getParametersOrThrow(String key)

public String getParametersOrThrow(String key)

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getTransformNameMapping() (deprecated)

public Map<String,String> getTransformNameMapping()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
boolean

The update.

hasEnvironment()

public boolean hasEnvironment()

The runtime environment for the job.

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

Returns
TypeDescription
boolean

Whether the environment field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEnvironment(RuntimeEnvironment value)

public LaunchTemplateParameters.Builder mergeEnvironment(RuntimeEnvironment value)

The runtime environment for the job.

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

Parameter
NameDescription
valueRuntimeEnvironment
Returns
TypeDescription
LaunchTemplateParameters.Builder

mergeFrom(LaunchTemplateParameters other)

public LaunchTemplateParameters.Builder mergeFrom(LaunchTemplateParameters other)
Parameter
NameDescription
otherLaunchTemplateParameters
Returns
TypeDescription
LaunchTemplateParameters.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LaunchTemplateParameters.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LaunchTemplateParameters.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public LaunchTemplateParameters.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
LaunchTemplateParameters.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LaunchTemplateParameters.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
LaunchTemplateParameters.Builder

setEnvironment(RuntimeEnvironment value)

public LaunchTemplateParameters.Builder setEnvironment(RuntimeEnvironment value)

The runtime environment for the job.

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

Parameter
NameDescription
valueRuntimeEnvironment
Returns
TypeDescription
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
NameDescription
builderForValueRuntimeEnvironment.Builder
Returns
TypeDescription
LaunchTemplateParameters.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public LaunchTemplateParameters.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The jobName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for jobName to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
LaunchTemplateParameters.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final LaunchTemplateParameters.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueboolean

The update to set.

Returns
TypeDescription
LaunchTemplateParameters.Builder

This builder for chaining.