Class LaunchTemplateParameters (0.46.0)

public final class LaunchTemplateParameters extends GeneratedMessageV3 implements LaunchTemplateParametersOrBuilder

Parameters to provide to the template being launched.

Protobuf type google.dataflow.v1beta3.LaunchTemplateParameters

Static Fields

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

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

TRANSFORM_NAME_MAPPING_FIELD_NUMBER

public static final int TRANSFORM_NAME_MAPPING_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 LaunchTemplateParameters getDefaultInstance()
Returns
Type Description
LaunchTemplateParameters

getDescriptor()

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

newBuilder()

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

newBuilder(LaunchTemplateParameters prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsParameters(String key)

public boolean containsParameters(String key)

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsTransformNameMapping(String key)

public boolean containsTransformNameMapping(String key)

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.

map<string, string> transform_name_mapping = 5;

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

getDefaultInstanceForType()

public LaunchTemplateParameters getDefaultInstanceForType()
Returns
Type Description
LaunchTemplateParameters

getEnvironment()

public RuntimeEnvironment getEnvironment()

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Returns
Type Description
RuntimeEnvironment

The environment.

getEnvironmentOrBuilder()

public RuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

Returns
Type Description
RuntimeEnvironmentOrBuilder

getJobName()

public String getJobName()

Required. The job name to use for the created 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.

string job_name = 1;

Returns
Type Description
ByteString

The bytes for jobName.

getParameters() (deprecated)

public Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
Type Description
Map<String,String>

getParametersCount()

public int getParametersCount()

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Returns
Type Description
int

getParametersMap()

public Map<String,String> getParametersMap()

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Returns
Type Description
Map<String,String>

getParametersOrDefault(String key, String defaultValue)

public String getParametersOrDefault(String key, String defaultValue)

The runtime parameters to pass to the job.

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 runtime parameters to pass to the job.

map<string, string> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTransformNameMapping() (deprecated)

public Map<String,String> getTransformNameMapping()
Returns
Type Description
Map<String,String>

getTransformNameMappingCount()

public int getTransformNameMappingCount()

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.

map<string, string> transform_name_mapping = 5;

Returns
Type Description
int

getTransformNameMappingMap()

public Map<String,String> getTransformNameMappingMap()

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.

map<string, string> transform_name_mapping = 5;

Returns
Type Description
Map<String,String>

getTransformNameMappingOrDefault(String key, String defaultValue)

public String getTransformNameMappingOrDefault(String key, String defaultValue)

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.

map<string, string> transform_name_mapping = 5;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getTransformNameMappingOrThrow(String key)

public String getTransformNameMappingOrThrow(String key)

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.

map<string, string> transform_name_mapping = 5;

Parameter
Name Description
key String
Returns
Type Description
String

getUpdate()

public boolean getUpdate()

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

bool update = 4;

Returns
Type Description
boolean

The update.

hasEnvironment()

public boolean hasEnvironment()

The runtime environment for the job.

.google.dataflow.v1beta3.RuntimeEnvironment environment = 3;

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 LaunchTemplateParameters.Builder newBuilderForType()
Returns
Type Description
LaunchTemplateParameters.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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