com.google.api.services.dataflow.model

Class LaunchTemplateParameters

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dataflow.model.LaunchTemplateParameters

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class LaunchTemplateParameters
extends GenericJson

Parameters to provide to the template being launched. Note that the [metadata in the pipeline code] (https://cloud.google.com/dataflow/docs/guides/templates/creating-templates#metadata) determines which runtime parameters are valid.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Dataflow API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
LaunchTemplateParameters()

Method Summary

Modifier and Type	Method and Description
LaunchTemplateParameters	clone()
RuntimeEnvironment	getEnvironment() The runtime environment for the job.
String	getJobName() Required.
Map<String,String>	getParameters() The runtime parameters to pass to the job.
Map<String,String>	getTransformNameMapping() Only applicable when updating a pipeline.
Boolean	getUpdate() If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
LaunchTemplateParameters	set(String fieldName, Object value)
LaunchTemplateParameters	setEnvironment(RuntimeEnvironment environment) The runtime environment for the job.
LaunchTemplateParameters	setJobName(String jobName) Required.
LaunchTemplateParameters	setParameters(Map<String,String> parameters) The runtime parameters to pass to the job.
LaunchTemplateParameters	setTransformNameMapping(Map<String,String> transformNameMapping) Only applicable when updating a pipeline.
LaunchTemplateParameters	setUpdate(Boolean update) If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

LaunchTemplateParameters

public LaunchTemplateParameters()

Method Detail

getEnvironment

public RuntimeEnvironment getEnvironment()

The runtime environment for the job.

Returns:

value or null for none

setEnvironment

public LaunchTemplateParameters setEnvironment(RuntimeEnvironment environment)

The runtime environment for the job.

Parameters:

environment - environment or null for none

getJobName

public String getJobName()

Required. The job name to use for the created job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`

Returns:

value or null for none

setJobName

public LaunchTemplateParameters setJobName(String jobName)

Required. The job name to use for the created job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`

Parameters:

jobName - jobName or null for none

getParameters

public Map<String,String> getParameters()

The runtime parameters to pass to the job.

Returns:

value or null for none

setParameters

public LaunchTemplateParameters setParameters(Map<String,String> parameters)

The runtime parameters to pass to the job.

Parameters:

parameters - parameters or null for none

getTransformNameMapping

public Map<String,String> getTransformNameMapping()

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.

Returns:

value or null for none

setTransformNameMapping

public LaunchTemplateParameters setTransformNameMapping(Map<String,String> transformNameMapping)

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.

Parameters:

transformNameMapping - transformNameMapping or null for none

getUpdate

public Boolean getUpdate()

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

Returns:

value or null for none

setUpdate

public LaunchTemplateParameters setUpdate(Boolean update)

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

Parameters:

update - update or null for none

set

public LaunchTemplateParameters set(String fieldName,
                                    Object value)

Overrides:

set in class GenericJson

clone

public LaunchTemplateParameters clone()

Overrides:

clone in class GenericJson