Class LaunchFlexTemplateParameter (0.47.0)

public final class LaunchFlexTemplateParameter extends GeneratedMessageV3 implements LaunchFlexTemplateParameterOrBuilder

Launch FlexTemplate Parameter.

Protobuf type google.dataflow.v1beta3.LaunchFlexTemplateParameter

Static Fields

CONTAINER_SPEC_FIELD_NUMBER

public static final int CONTAINER_SPEC_FIELD_NUMBER
Field Value
Type Description
int

CONTAINER_SPEC_GCS_PATH_FIELD_NUMBER

public static final int CONTAINER_SPEC_GCS_PATH_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

JOB_NAME_FIELD_NUMBER

public static final int JOB_NAME_FIELD_NUMBER
Field Value
Type Description
int

LAUNCH_OPTIONS_FIELD_NUMBER

public static final int LAUNCH_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

TRANSFORM_NAME_MAPPINGS_FIELD_NUMBER

public static final int TRANSFORM_NAME_MAPPINGS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_FIELD_NUMBER

public static final int UPDATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LaunchFlexTemplateParameter getDefaultInstance()
Returns
Type Description
LaunchFlexTemplateParameter

getDescriptor()

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

newBuilder()

public static LaunchFlexTemplateParameter.Builder newBuilder()
Returns
Type Description
LaunchFlexTemplateParameter.Builder

newBuilder(LaunchFlexTemplateParameter prototype)

public static LaunchFlexTemplateParameter.Builder newBuilder(LaunchFlexTemplateParameter prototype)
Parameter
Name Description
prototype LaunchFlexTemplateParameter
Returns
Type Description
LaunchFlexTemplateParameter.Builder

parseDelimitedFrom(InputStream input)

public static LaunchFlexTemplateParameter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LaunchFlexTemplateParameter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LaunchFlexTemplateParameter parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LaunchFlexTemplateParameter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LaunchFlexTemplateParameter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LaunchFlexTemplateParameter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LaunchFlexTemplateParameter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LaunchFlexTemplateParameter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LaunchFlexTemplateParameter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LaunchFlexTemplateParameter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LaunchFlexTemplateParameter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LaunchFlexTemplateParameter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LaunchFlexTemplateParameter
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LaunchFlexTemplateParameter> parser()
Returns
Type Description
Parser<LaunchFlexTemplateParameter>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContainerSpec()

public ContainerSpec getContainerSpec()

Spec about the container image to launch.

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

Returns
Type Description
ContainerSpec

The containerSpec.

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

getEnvironment()

public FlexTemplateRuntimeEnvironment getEnvironment()

The runtime environment for the FlexTemplate job

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

Returns
Type Description
FlexTemplateRuntimeEnvironment

The environment.

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

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

getParserForType()

public Parser<LaunchFlexTemplateParameter> getParserForType()
Returns
Type Description
Parser<LaunchFlexTemplateParameter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LaunchFlexTemplateParameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LaunchFlexTemplateParameter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException