Interface LaunchFlexTemplateParameterOrBuilder (0.25.0)

public interface LaunchFlexTemplateParameterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLaunchOptions(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
boolean

containsParameters(String key)

public abstract boolean containsParameters(String key)

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

map<string, string> parameters = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsTransformNameMappings(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
boolean

getContainerSpec()

public abstract ContainerSpec getContainerSpec()

Spec about the container image to launch.

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

Returns
TypeDescription
ContainerSpec

The containerSpec.

getContainerSpecGcsPath()

public abstract String getContainerSpecGcsPath()

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

string container_spec_gcs_path = 5;

Returns
TypeDescription
String

The containerSpecGcsPath.

getContainerSpecGcsPathBytes()

public abstract ByteString getContainerSpecGcsPathBytes()

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

string container_spec_gcs_path = 5;

Returns
TypeDescription
ByteString

The bytes for containerSpecGcsPath.

getContainerSpecOrBuilder()

public abstract ContainerSpecOrBuilder getContainerSpecOrBuilder()

Spec about the container image to launch.

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

Returns
TypeDescription
ContainerSpecOrBuilder

getEnvironment()

public abstract FlexTemplateRuntimeEnvironment getEnvironment()

The runtime environment for the FlexTemplate job

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

Returns
TypeDescription
FlexTemplateRuntimeEnvironment

The environment.

getEnvironmentOrBuilder()

public abstract FlexTemplateRuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()

The runtime environment for the FlexTemplate job

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

Returns
TypeDescription
FlexTemplateRuntimeEnvironmentOrBuilder

getJobName()

public abstract 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
TypeDescription
String

The jobName.

getJobNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for jobName.

getLaunchOptions()

public abstract Map<String,String> getLaunchOptions()
Returns
TypeDescription
Map<String,String>

getLaunchOptionsCount()

public abstract 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
TypeDescription
int

getLaunchOptionsMap()

public abstract 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
TypeDescription
Map<String,String>

getLaunchOptionsOrDefault(String key, String defaultValue)

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

getLaunchOptionsOrThrow(String key)

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

getParameters()

public abstract Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
TypeDescription
Map<String,String>

getParametersCount()

public abstract int getParametersCount()

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

map<string, string> parameters = 2;

Returns
TypeDescription
int

getParametersMap()

public abstract Map<String,String> getParametersMap()

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

map<string, string> parameters = 2;

Returns
TypeDescription
Map<String,String>

getParametersOrDefault(String key, String defaultValue)

public abstract String getParametersOrDefault(String key, String defaultValue)

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

map<string, string> parameters = 2;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getParametersOrThrow(String key)

public abstract String getParametersOrThrow(String key)

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

map<string, string> parameters = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getTemplateCase()

public abstract LaunchFlexTemplateParameter.TemplateCase getTemplateCase()
Returns
TypeDescription
LaunchFlexTemplateParameter.TemplateCase

getTransformNameMappings()

public abstract Map<String,String> getTransformNameMappings()
Returns
TypeDescription
Map<String,String>

getTransformNameMappingsCount()

public abstract int getTransformNameMappingsCount()

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

map<string, string> transform_name_mappings = 9;

Returns
TypeDescription
int

getTransformNameMappingsMap()

public abstract 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
TypeDescription
Map<String,String>

getTransformNameMappingsOrDefault(String key, String defaultValue)

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

getTransformNameMappingsOrThrow(String key)

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

getUpdate()

public abstract 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
TypeDescription
boolean

The update.

hasContainerSpec()

public abstract boolean hasContainerSpec()

Spec about the container image to launch.

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

Returns
TypeDescription
boolean

Whether the containerSpec field is set.

hasContainerSpecGcsPath()

public abstract boolean hasContainerSpecGcsPath()

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

string container_spec_gcs_path = 5;

Returns
TypeDescription
boolean

Whether the containerSpecGcsPath field is set.

hasEnvironment()

public abstract boolean hasEnvironment()

The runtime environment for the FlexTemplate job

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

Returns
TypeDescription
boolean

Whether the environment field is set.