target.apidocs.com.google.api.services.dataflow.model.LaunchFlexTemplateParameter.html Maven / Gradle / Ivy
LaunchFlexTemplateParameter (Dataflow API v1b3-rev20231112-2.0.0)
com.google.api.services.dataflow.model
Class LaunchFlexTemplateParameter
- 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.LaunchFlexTemplateParameter
-
public final class LaunchFlexTemplateParameter
extends com.google.api.client.json.GenericJson
Launch FlexTemplate Parameter.
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
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
LaunchFlexTemplateParameter()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
LaunchFlexTemplateParameter
clone()
ContainerSpec
getContainerSpec()
Spec about the container image to launch.
String
getContainerSpecGcsPath()
Cloud Storage path to a file with json serialized ContainerSpec as content.
FlexTemplateRuntimeEnvironment
getEnvironment()
The runtime environment for the FlexTemplate job
String
getJobName()
Required.
Map<String,String>
getLaunchOptions()
Launch options for this flex template job.
Map<String,String>
getParameters()
The parameters for FlexTemplate.
Map<String,String>
getTransformNameMappings()
Use this to pass transform_name_mappings for streaming update jobs.
Boolean
getUpdate()
Set this to true if you are sending a request to update a running streaming job.
LaunchFlexTemplateParameter
set(String fieldName,
Object value)
LaunchFlexTemplateParameter
setContainerSpec(ContainerSpec containerSpec)
Spec about the container image to launch.
LaunchFlexTemplateParameter
setContainerSpecGcsPath(String containerSpecGcsPath)
Cloud Storage path to a file with json serialized ContainerSpec as content.
LaunchFlexTemplateParameter
setEnvironment(FlexTemplateRuntimeEnvironment environment)
The runtime environment for the FlexTemplate job
LaunchFlexTemplateParameter
setJobName(String jobName)
Required.
LaunchFlexTemplateParameter
setLaunchOptions(Map<String,String> launchOptions)
Launch options for this flex template job.
LaunchFlexTemplateParameter
setParameters(Map<String,String> parameters)
The parameters for FlexTemplate.
LaunchFlexTemplateParameter
setTransformNameMappings(Map<String,String> transformNameMappings)
Use this to pass transform_name_mappings for streaming update jobs.
LaunchFlexTemplateParameter
setUpdate(Boolean update)
Set this to true if you are sending a request to update a running streaming job.
-
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
-
-
Method Detail
-
getContainerSpec
public ContainerSpec getContainerSpec()
Spec about the container image to launch.
- Returns:
- value or
null
for none
-
setContainerSpec
public LaunchFlexTemplateParameter setContainerSpec(ContainerSpec containerSpec)
Spec about the container image to launch.
- Parameters:
containerSpec
- containerSpec or null
for none
-
getContainerSpecGcsPath
public String getContainerSpecGcsPath()
Cloud Storage path to a file with json serialized ContainerSpec as content.
- Returns:
- value or
null
for none
-
setContainerSpecGcsPath
public LaunchFlexTemplateParameter setContainerSpecGcsPath(String containerSpecGcsPath)
Cloud Storage path to a file with json serialized ContainerSpec as content.
- Parameters:
containerSpecGcsPath
- containerSpecGcsPath or null
for none
-
getEnvironment
public FlexTemplateRuntimeEnvironment getEnvironment()
The runtime environment for the FlexTemplate job
- Returns:
- value or
null
for none
-
setEnvironment
public LaunchFlexTemplateParameter setEnvironment(FlexTemplateRuntimeEnvironment environment)
The runtime environment for the FlexTemplate job
- Parameters:
environment
- environment or null
for none
-
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.
- Returns:
- value or
null
for none
-
setJobName
public LaunchFlexTemplateParameter setJobName(String jobName)
Required. The job name to use for the created job. For update job request, job name should be
same as the existing running job.
- Parameters:
jobName
- jobName or null
for none
-
getLaunchOptions
public Map<String,String> getLaunchOptions()
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.
- Returns:
- value or
null
for none
-
setLaunchOptions
public LaunchFlexTemplateParameter setLaunchOptions(Map<String,String> launchOptions)
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.
- Parameters:
launchOptions
- launchOptions or null
for none
-
getParameters
public Map<String,String> getParameters()
The parameters for FlexTemplate. Ex. {"num_workers":"5"}
- Returns:
- value or
null
for none
-
setParameters
public LaunchFlexTemplateParameter setParameters(Map<String,String> parameters)
The parameters for FlexTemplate. Ex. {"num_workers":"5"}
- Parameters:
parameters
- parameters or null
for none
-
getTransformNameMappings
public Map<String,String> getTransformNameMappings()
Use this to pass transform_name_mappings for streaming update jobs.
Ex:{"oldTransformName":"newTransformName",...}'
- Returns:
- value or
null
for none
-
setTransformNameMappings
public LaunchFlexTemplateParameter setTransformNameMappings(Map<String,String> transformNameMappings)
Use this to pass transform_name_mappings for streaming update jobs.
Ex:{"oldTransformName":"newTransformName",...}'
- Parameters:
transformNameMappings
- transformNameMappings or null
for none
-
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.
- Returns:
- value or
null
for none
-
setUpdate
public LaunchFlexTemplateParameter setUpdate(Boolean update)
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.
- Parameters:
update
- update or null
for none
-
set
public LaunchFlexTemplateParameter set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public LaunchFlexTemplateParameter clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy