Class LaunchFlexTemplateParameter.Builder (0.47.0)

public static final class LaunchFlexTemplateParameter.Builder extends GeneratedMessageV3.Builder<LaunchFlexTemplateParameter.Builder> implements LaunchFlexTemplateParameterOrBuilder

Launch FlexTemplate Parameter.

Protobuf type google.dataflow.v1beta3.LaunchFlexTemplateParameter

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public LaunchFlexTemplateParameter build()
Returns
Type Description
LaunchFlexTemplateParameter

buildPartial()

public LaunchFlexTemplateParameter buildPartial()
Returns
Type Description
LaunchFlexTemplateParameter

clear()

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

clearContainerSpec()

public LaunchFlexTemplateParameter.Builder clearContainerSpec()

Spec about the container image to launch.

.google.dataflow.v1beta3.ContainerSpec container_spec = 4;

Returns
Type Description
LaunchFlexTemplateParameter.Builder

clearContainerSpecGcsPath()

public LaunchFlexTemplateParameter.Builder clearContainerSpecGcsPath()

Cloud Storage path to a file with json serialized ContainerSpec as content.

string container_spec_gcs_path = 5;

Returns
Type Description
LaunchFlexTemplateParameter.Builder

This builder for chaining.

clearEnvironment()

public LaunchFlexTemplateParameter.Builder clearEnvironment()

The runtime environment for the FlexTemplate job

.google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment environment = 7;

Returns
Type Description
LaunchFlexTemplateParameter.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearJobName()

public LaunchFlexTemplateParameter.Builder clearJobName()

Required. The job name to use for the created job. For update job request, job name should be same as the existing running job.

string job_name = 1;

Returns
Type Description
LaunchFlexTemplateParameter.Builder

This builder for chaining.

clearLaunchOptions()

public LaunchFlexTemplateParameter.Builder clearLaunchOptions()
Returns
Type Description
LaunchFlexTemplateParameter.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParameters()

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

clearTemplate()

public LaunchFlexTemplateParameter.Builder clearTemplate()
Returns
Type Description
LaunchFlexTemplateParameter.Builder

clearTransformNameMappings()

public LaunchFlexTemplateParameter.Builder clearTransformNameMappings()
Returns
Type Description
LaunchFlexTemplateParameter.Builder

clearUpdate()

public LaunchFlexTemplateParameter.Builder clearUpdate()

Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.

bool update = 8;

Returns
Type Description
LaunchFlexTemplateParameter.Builder

This builder for chaining.

clone()

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

containsLaunchOptions(String key)

public boolean containsLaunchOptions(String key)

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

map<string, string> launch_options = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsParameters(String key)

public boolean containsParameters(String key)

The parameters for FlexTemplate. Ex. {"num_workers":"5"}

map<string, string> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsTransformNameMappings(String key)

public boolean containsTransformNameMappings(String key)

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

map<string, string> transform_name_mappings = 9;

Parameter
Name Description
key String
Returns
Type Description
boolean

getContainerSpec()

public ContainerSpec getContainerSpec()

Spec about the container image to launch.

.google.dataflow.v1beta3.ContainerSpec container_spec = 4;

Returns
Type Description
ContainerSpec

The containerSpec.

getContainerSpecBuilder()

public ContainerSpec.Builder getContainerSpecBuilder()

Spec about the container image to launch.

.google.dataflow.v1beta3.ContainerSpec container_spec = 4;

Returns
Type Description
ContainerSpec.Builder

getContainerSpecGcsPath()

public String getContainerSpecGcsPath()

Cloud Storage path to a file with json serialized ContainerSpec as content.

string container_spec_gcs_path = 5;

Returns
Type Description
String

The containerSpecGcsPath.

getContainerSpecGcsPathBytes()

public ByteString getContainerSpecGcsPathBytes()

Cloud Storage path to a file with json serialized ContainerSpec as content.

string container_spec_gcs_path = 5;

Returns
Type Description
ByteString

The bytes for containerSpecGcsPath.

getContainerSpecOrBuilder()

public ContainerSpecOrBuilder getContainerSpecOrBuilder()

Spec about the container image to launch.

.google.dataflow.v1beta3.ContainerSpec container_spec = 4;

Returns
Type Description
ContainerSpecOrBuilder

getDefaultInstanceForType()

public LaunchFlexTemplateParameter getDefaultInstanceForType()
Returns
Type Description
LaunchFlexTemplateParameter

getDescriptorForType()

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

getEnvironment()

public FlexTemplateRuntimeEnvironment getEnvironment()

The runtime environment for the FlexTemplate job

.google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment environment = 7;

Returns
Type Description
FlexTemplateRuntimeEnvironment

The environment.

getEnvironmentBuilder()

public FlexTemplateRuntimeEnvironment.Builder getEnvironmentBuilder()

The runtime environment for the FlexTemplate job

.google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment environment = 7;

Returns
Type Description
FlexTemplateRuntimeEnvironment.Builder

getEnvironmentOrBuilder()

public FlexTemplateRuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()

The runtime environment for the FlexTemplate job

.google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment environment = 7;

Returns
Type Description
FlexTemplateRuntimeEnvironmentOrBuilder

getJobName()

public String getJobName()

Required. The job name to use for the created job. For update job request, job name should be same as the existing running 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. For update job request, job name should be same as the existing running job.

string job_name = 1;

Returns
Type Description
ByteString

The bytes for jobName.

getLaunchOptions() (deprecated)

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

getLaunchOptionsCount()

public int getLaunchOptionsCount()

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

map<string, string> launch_options = 6;

Returns
Type Description
int

getLaunchOptionsMap()

public Map<String,String> getLaunchOptionsMap()

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

map<string, string> launch_options = 6;

Returns
Type Description
Map<String,String>

getLaunchOptionsOrDefault(String key, String defaultValue)

public String getLaunchOptionsOrDefault(String key, String defaultValue)

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

map<string, string> launch_options = 6;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLaunchOptionsOrThrow(String key)

public String getLaunchOptionsOrThrow(String key)

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

map<string, string> launch_options = 6;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLaunchOptions() (deprecated)

public Map<String,String> getMutableLaunchOptions()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableParameters() (deprecated)

public Map<String,String> getMutableParameters()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableTransformNameMappings() (deprecated)

public Map<String,String> getMutableTransformNameMappings()

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 parameters for FlexTemplate. Ex. {"num_workers":"5"}

map<string, string> parameters = 2;

Returns
Type Description
int

getParametersMap()

public Map<String,String> getParametersMap()

The parameters for FlexTemplate. Ex. {"num_workers":"5"}

map<string, string> parameters = 2;

Returns
Type Description
Map<String,String>

getParametersOrDefault(String key, String defaultValue)

public String getParametersOrDefault(String key, String defaultValue)

The parameters for FlexTemplate. Ex. {"num_workers":"5"}

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 parameters for FlexTemplate. Ex. {"num_workers":"5"}

map<string, string> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getTemplateCase()

public LaunchFlexTemplateParameter.TemplateCase getTemplateCase()
Returns
Type Description
LaunchFlexTemplateParameter.TemplateCase

getTransformNameMappings() (deprecated)

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

getTransformNameMappingsCount()

public int getTransformNameMappingsCount()

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

map<string, string> transform_name_mappings = 9;

Returns
Type Description
int

getTransformNameMappingsMap()

public Map<String,String> getTransformNameMappingsMap()

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

map<string, string> transform_name_mappings = 9;

Returns
Type Description
Map<String,String>

getTransformNameMappingsOrDefault(String key, String defaultValue)

public String getTransformNameMappingsOrDefault(String key, String defaultValue)

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

map<string, string> transform_name_mappings = 9;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getTransformNameMappingsOrThrow(String key)

public String getTransformNameMappingsOrThrow(String key)

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

map<string, string> transform_name_mappings = 9;

Parameter
Name Description
key String
Returns
Type Description
String

getUpdate()

public boolean getUpdate()

Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.

bool update = 8;

Returns
Type Description
boolean

The update.

hasContainerSpec()

public boolean hasContainerSpec()

Spec about the container image to launch.

.google.dataflow.v1beta3.ContainerSpec container_spec = 4;

Returns
Type Description
boolean

Whether the containerSpec field is set.

hasContainerSpecGcsPath()

public boolean hasContainerSpecGcsPath()

Cloud Storage path to a file with json serialized ContainerSpec as content.

string container_spec_gcs_path = 5;

Returns
Type Description
boolean

Whether the containerSpecGcsPath field is set.

hasEnvironment()

public boolean hasEnvironment()

The runtime environment for the FlexTemplate job

.google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment environment = 7;

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

mergeContainerSpec(ContainerSpec value)

public LaunchFlexTemplateParameter.Builder mergeContainerSpec(ContainerSpec value)

Spec about the container image to launch.

.google.dataflow.v1beta3.ContainerSpec container_spec = 4;

Parameter
Name Description
value ContainerSpec
Returns
Type Description
LaunchFlexTemplateParameter.Builder

mergeEnvironment(FlexTemplateRuntimeEnvironment value)

public LaunchFlexTemplateParameter.Builder mergeEnvironment(FlexTemplateRuntimeEnvironment value)

The runtime environment for the FlexTemplate job

.google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment environment = 7;

Parameter
Name Description
value FlexTemplateRuntimeEnvironment
Returns
Type Description
LaunchFlexTemplateParameter.Builder

mergeFrom(LaunchFlexTemplateParameter other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLaunchOptions(Map<String,String> values)

public LaunchFlexTemplateParameter.Builder putAllLaunchOptions(Map<String,String> values)

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

map<string, string> launch_options = 6;

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

putAllParameters(Map<String,String> values)

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

The parameters for FlexTemplate. Ex. {"num_workers":"5"}

map<string, string> parameters = 2;

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

putAllTransformNameMappings(Map<String,String> values)

public LaunchFlexTemplateParameter.Builder putAllTransformNameMappings(Map<String,String> values)

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

map<string, string> transform_name_mappings = 9;

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

putLaunchOptions(String key, String value)

public LaunchFlexTemplateParameter.Builder putLaunchOptions(String key, String value)

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

map<string, string> launch_options = 6;

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

putParameters(String key, String value)

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

The parameters for FlexTemplate. Ex. {"num_workers":"5"}

map<string, string> parameters = 2;

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

putTransformNameMappings(String key, String value)

public LaunchFlexTemplateParameter.Builder putTransformNameMappings(String key, String value)

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

map<string, string> transform_name_mappings = 9;

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

removeLaunchOptions(String key)

public LaunchFlexTemplateParameter.Builder removeLaunchOptions(String key)

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

map<string, string> launch_options = 6;

Parameter
Name Description
key String
Returns
Type Description
LaunchFlexTemplateParameter.Builder

removeParameters(String key)

public LaunchFlexTemplateParameter.Builder removeParameters(String key)

The parameters for FlexTemplate. Ex. {"num_workers":"5"}

map<string, string> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
LaunchFlexTemplateParameter.Builder

removeTransformNameMappings(String key)

public LaunchFlexTemplateParameter.Builder removeTransformNameMappings(String key)

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

map<string, string> transform_name_mappings = 9;

Parameter
Name Description
key String
Returns
Type Description
LaunchFlexTemplateParameter.Builder

setContainerSpec(ContainerSpec value)

public LaunchFlexTemplateParameter.Builder setContainerSpec(ContainerSpec value)

Spec about the container image to launch.

.google.dataflow.v1beta3.ContainerSpec container_spec = 4;

Parameter
Name Description
value ContainerSpec
Returns
Type Description
LaunchFlexTemplateParameter.Builder

setContainerSpec(ContainerSpec.Builder builderForValue)

public LaunchFlexTemplateParameter.Builder setContainerSpec(ContainerSpec.Builder builderForValue)

Spec about the container image to launch.

.google.dataflow.v1beta3.ContainerSpec container_spec = 4;

Parameter
Name Description
builderForValue ContainerSpec.Builder
Returns
Type Description
LaunchFlexTemplateParameter.Builder

setContainerSpecGcsPath(String value)

public LaunchFlexTemplateParameter.Builder setContainerSpecGcsPath(String value)

Cloud Storage path to a file with json serialized ContainerSpec as content.

string container_spec_gcs_path = 5;

Parameter
Name Description
value String

The containerSpecGcsPath to set.

Returns
Type Description
LaunchFlexTemplateParameter.Builder

This builder for chaining.

setContainerSpecGcsPathBytes(ByteString value)

public LaunchFlexTemplateParameter.Builder setContainerSpecGcsPathBytes(ByteString value)

Cloud Storage path to a file with json serialized ContainerSpec as content.

string container_spec_gcs_path = 5;

Parameter
Name Description
value ByteString

The bytes for containerSpecGcsPath to set.

Returns
Type Description
LaunchFlexTemplateParameter.Builder

This builder for chaining.

setEnvironment(FlexTemplateRuntimeEnvironment value)

public LaunchFlexTemplateParameter.Builder setEnvironment(FlexTemplateRuntimeEnvironment value)

The runtime environment for the FlexTemplate job

.google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment environment = 7;

Parameter
Name Description
value FlexTemplateRuntimeEnvironment
Returns
Type Description
LaunchFlexTemplateParameter.Builder

setEnvironment(FlexTemplateRuntimeEnvironment.Builder builderForValue)

public LaunchFlexTemplateParameter.Builder setEnvironment(FlexTemplateRuntimeEnvironment.Builder builderForValue)

The runtime environment for the FlexTemplate job

.google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment environment = 7;

Parameter
Name Description
builderForValue FlexTemplateRuntimeEnvironment.Builder
Returns
Type Description
LaunchFlexTemplateParameter.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setJobName(String value)

public LaunchFlexTemplateParameter.Builder setJobName(String value)

Required. The job name to use for the created job. For update job request, job name should be same as the existing running job.

string job_name = 1;

Parameter
Name Description
value String

The jobName to set.

Returns
Type Description
LaunchFlexTemplateParameter.Builder

This builder for chaining.

setJobNameBytes(ByteString value)

public LaunchFlexTemplateParameter.Builder setJobNameBytes(ByteString value)

Required. The job name to use for the created job. For update job request, job name should be same as the existing running job.

string job_name = 1;

Parameter
Name Description
value ByteString

The bytes for jobName to set.

Returns
Type Description
LaunchFlexTemplateParameter.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdate(boolean value)

public LaunchFlexTemplateParameter.Builder setUpdate(boolean value)

Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.

bool update = 8;

Parameter
Name Description
value boolean

The update to set.

Returns
Type Description
LaunchFlexTemplateParameter.Builder

This builder for chaining.