public static final class LaunchTemplateParameters.Builder extends GeneratedMessage.Builder<LaunchTemplateParameters.Builder> implements LaunchTemplateParametersOrBuilderParameters to provide to the template being launched. Note that the metadata in the pipeline code determines which runtime parameters are valid.
Protobuf type google.dataflow.v1beta3.LaunchTemplateParameters
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > LaunchTemplateParameters.BuilderImplements
LaunchTemplateParametersOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
clearEnvironment()
public LaunchTemplateParameters.Builder clearEnvironment()The runtime environment for the job.
.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;
| Returns | |
|---|---|
| Type | Description |
LaunchTemplateParameters.Builder |
|
clearJobName()
public LaunchTemplateParameters.Builder clearJobName()Required. The job name to use for the created job.
The name must match the regular expression
a-z?
string job_name = 1;
| Returns | |
|---|---|
| Type | Description |
LaunchTemplateParameters.Builder |
This builder for chaining. |
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. |
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 |
|
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.
The name must match the regular expression
a-z?
string job_name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The jobName. |
getJobNameBytes()
public ByteString getJobNameBytes()Required. The job name to use for the created job.
The name must match the regular expression
a-z?
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()Use #getTransformNameMappingMap() instead.
| 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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public LaunchTemplateParameters.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
LaunchTemplateParameters.Builder |
|
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 |
|
setJobName(String value)
public LaunchTemplateParameters.Builder setJobName(String value)Required. The job name to use for the created job.
The name must match the regular expression
a-z?
string job_name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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.
The name must match the regular expression
a-z?
string job_name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for jobName to set. |
| Returns | |
|---|---|
| Type | Description |
LaunchTemplateParameters.Builder |
This builder for chaining. |
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 |
booleanThe update to set. |
| Returns | |
|---|---|
| Type | Description |
LaunchTemplateParameters.Builder |
This builder for chaining. |