Interface LaunchFlexTemplateParameterOrBuilder (0.46.0)

Version 0.46.0

• 0.57.0 (latest)
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.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
Name	Description
key	String

Returns
Type	Description
boolean

containsParameters(String key)

public abstract 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 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
Name	Description
key	String

Returns
Type	Description
boolean

getContainerSpec()

public abstract ContainerSpec getContainerSpec()

Spec about the container image to launch.

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

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
ContainerSpecOrBuilder

getEnvironment()

public abstract FlexTemplateRuntimeEnvironment getEnvironment()

The runtime environment for the FlexTemplate job

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

Returns
Type	Description
FlexTemplateRuntimeEnvironment	The environment.

getEnvironmentOrBuilder()

public abstract FlexTemplateRuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()

The runtime environment for the FlexTemplate job

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

Returns
Type	Description
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
Type	Description
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
Type	Description
ByteString	The bytes for jobName.

getLaunchOptions() (deprecated)

public abstract Map<String,String> getLaunchOptions()

Use #getLaunchOptionsMap() instead.

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Name	Description
key	String
defaultValue	String

Returns
Type	Description
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
Name	Description
key	String

Returns
Type	Description
String

getParameters() (deprecated)

public abstract Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
Type	Description
Map<String,String>

getParametersCount()

public abstract int getParametersCount()

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

map<string, string> parameters = 2;

Returns
Type	Description
int

getParametersMap()

public abstract 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 abstract 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 abstract 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 abstract LaunchFlexTemplateParameter.TemplateCase getTemplateCase()

Returns
Type	Description
LaunchFlexTemplateParameter.TemplateCase

getTransformNameMappings() (deprecated)

public abstract Map<String,String> getTransformNameMappings()

Use #getTransformNameMappingsMap() instead.

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Name	Description
key	String
defaultValue	String

Returns
Type	Description
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
Name	Description
key	String

Returns
Type	Description
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
Type	Description
boolean	The update.

hasContainerSpec()

public abstract 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 abstract 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 abstract 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.