Class LaunchTemplateParameters

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
TypeDescription
int

JOB_NAME_FIELD_NUMBER

public static final int JOB_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSFORM_NAME_MAPPING_FIELD_NUMBER

public static final int TRANSFORM_NAME_MAPPING_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_FIELD_NUMBER

public static final int UPDATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static LaunchTemplateParameters getDefaultInstance()
Returns
TypeDescription
LaunchTemplateParameters

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static LaunchTemplateParameters.Builder newBuilder()
Returns
TypeDescription
LaunchTemplateParameters.Builder

newBuilder(LaunchTemplateParameters prototype)

public static LaunchTemplateParameters.Builder newBuilder(LaunchTemplateParameters prototype)
Parameter
NameDescription
prototypeLaunchTemplateParameters
Returns
TypeDescription
LaunchTemplateParameters.Builder

parseDelimitedFrom(InputStream input)

public static LaunchTemplateParameters parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LaunchTemplateParameters parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static LaunchTemplateParameters parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LaunchTemplateParameters parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LaunchTemplateParameters parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LaunchTemplateParameters parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LaunchTemplateParameters parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LaunchTemplateParameters parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static LaunchTemplateParameters parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LaunchTemplateParameters parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static LaunchTemplateParameters parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LaunchTemplateParameters parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LaunchTemplateParameters
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<LaunchTemplateParameters> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public LaunchTemplateParameters getDefaultInstanceForType()
Returns
TypeDescription
LaunchTemplateParameters

getEnvironment()

public RuntimeEnvironment getEnvironment()

The runtime environment for the job.

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

Returns
TypeDescription
RuntimeEnvironment

The environment.

getEnvironmentOrBuilder()

public RuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()

The runtime environment for the job.

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

Returns
TypeDescription
RuntimeEnvironmentOrBuilder

getJobName()

public String getJobName()

Required. The job name to use for the created job.

string job_name = 1;

Returns
TypeDescription
String

The jobName.

getJobNameBytes()

public ByteString getJobNameBytes()

Required. The job name to use for the created job.

string job_name = 1;

Returns
TypeDescription
ByteString

The bytes for jobName.

getParameters()

public Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
TypeDescription
Map<String,String>

getParametersCount()

public int getParametersCount()

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Returns
TypeDescription
int

getParametersMap()

public Map<String,String> getParametersMap()

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getParametersOrThrow(String key)

public String getParametersOrThrow(String key)

The runtime parameters to pass to the job.

map<string, string> parameters = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<LaunchTemplateParameters> getParserForType()
Returns
TypeDescription
Parser<LaunchTemplateParameters>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTransformNameMapping()

public Map<String,String> getTransformNameMapping()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
boolean

The update.

hasEnvironment()

public boolean hasEnvironment()

The runtime environment for the job.

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

Returns
TypeDescription
boolean

Whether the environment field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public LaunchTemplateParameters.Builder newBuilderForType()
Returns
TypeDescription
LaunchTemplateParameters.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LaunchTemplateParameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
LaunchTemplateParameters.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public LaunchTemplateParameters.Builder toBuilder()
Returns
TypeDescription
LaunchTemplateParameters.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException