Class LaunchTemplateRequest.Builder (0.55.0)

public static final class LaunchTemplateRequest.Builder extends GeneratedMessageV3.Builder<LaunchTemplateRequest.Builder> implements LaunchTemplateRequestOrBuilder

A request to launch a template.

Protobuf type google.dataflow.v1beta3.LaunchTemplateRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LaunchTemplateRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

build()

public LaunchTemplateRequest build()
Returns
Type Description
LaunchTemplateRequest

buildPartial()

public LaunchTemplateRequest buildPartial()
Returns
Type Description
LaunchTemplateRequest

clear()

public LaunchTemplateRequest.Builder clear()
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

clearDynamicTemplate()

public LaunchTemplateRequest.Builder clearDynamicTemplate()

Params for launching a dynamic template.

.google.dataflow.v1beta3.DynamicTemplateLaunchParams dynamic_template = 6;

Returns
Type Description
LaunchTemplateRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public LaunchTemplateRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

clearGcsPath()

public LaunchTemplateRequest.Builder clearGcsPath()

A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

string gcs_path = 3;

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

clearLaunchParameters()

public LaunchTemplateRequest.Builder clearLaunchParameters()

The parameters of the template to launch. This should be part of the body of the POST request.

.google.dataflow.v1beta3.LaunchTemplateParameters launch_parameters = 4;

Returns
Type Description
LaunchTemplateRequest.Builder

clearLocation()

public LaunchTemplateRequest.Builder clearLocation()

The regional endpoint to which to direct the request.

string location = 5;

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LaunchTemplateRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

clearProjectId()

public LaunchTemplateRequest.Builder clearProjectId()

Required. The ID of the Cloud Platform project that the job belongs to.

string project_id = 1;

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

clearTemplate()

public LaunchTemplateRequest.Builder clearTemplate()
Returns
Type Description
LaunchTemplateRequest.Builder

clearValidateOnly()

public LaunchTemplateRequest.Builder clearValidateOnly()

If true, the request is validated but not actually executed. Defaults to false.

bool validate_only = 2;

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

clone()

public LaunchTemplateRequest.Builder clone()
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

getDefaultInstanceForType()

public LaunchTemplateRequest getDefaultInstanceForType()
Returns
Type Description
LaunchTemplateRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDynamicTemplate()

public DynamicTemplateLaunchParams getDynamicTemplate()

Params for launching a dynamic template.

.google.dataflow.v1beta3.DynamicTemplateLaunchParams dynamic_template = 6;

Returns
Type Description
DynamicTemplateLaunchParams

The dynamicTemplate.

getDynamicTemplateBuilder()

public DynamicTemplateLaunchParams.Builder getDynamicTemplateBuilder()

Params for launching a dynamic template.

.google.dataflow.v1beta3.DynamicTemplateLaunchParams dynamic_template = 6;

Returns
Type Description
DynamicTemplateLaunchParams.Builder

getDynamicTemplateOrBuilder()

public DynamicTemplateLaunchParamsOrBuilder getDynamicTemplateOrBuilder()

Params for launching a dynamic template.

.google.dataflow.v1beta3.DynamicTemplateLaunchParams dynamic_template = 6;

Returns
Type Description
DynamicTemplateLaunchParamsOrBuilder

getGcsPath()

public String getGcsPath()

A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

string gcs_path = 3;

Returns
Type Description
String

The gcsPath.

getGcsPathBytes()

public ByteString getGcsPathBytes()

A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

string gcs_path = 3;

Returns
Type Description
ByteString

The bytes for gcsPath.

getLaunchParameters()

public LaunchTemplateParameters getLaunchParameters()

The parameters of the template to launch. This should be part of the body of the POST request.

.google.dataflow.v1beta3.LaunchTemplateParameters launch_parameters = 4;

Returns
Type Description
LaunchTemplateParameters

The launchParameters.

getLaunchParametersBuilder()

public LaunchTemplateParameters.Builder getLaunchParametersBuilder()

The parameters of the template to launch. This should be part of the body of the POST request.

.google.dataflow.v1beta3.LaunchTemplateParameters launch_parameters = 4;

Returns
Type Description
LaunchTemplateParameters.Builder

getLaunchParametersOrBuilder()

public LaunchTemplateParametersOrBuilder getLaunchParametersOrBuilder()

The parameters of the template to launch. This should be part of the body of the POST request.

.google.dataflow.v1beta3.LaunchTemplateParameters launch_parameters = 4;

Returns
Type Description
LaunchTemplateParametersOrBuilder

getLocation()

public String getLocation()

The regional endpoint to which to direct the request.

string location = 5;

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

The regional endpoint to which to direct the request.

string location = 5;

Returns
Type Description
ByteString

The bytes for location.

getProjectId()

public String getProjectId()

Required. The ID of the Cloud Platform project that the job belongs to.

string project_id = 1;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Required. The ID of the Cloud Platform project that the job belongs to.

string project_id = 1;

Returns
Type Description
ByteString

The bytes for projectId.

getTemplateCase()

public LaunchTemplateRequest.TemplateCase getTemplateCase()
Returns
Type Description
LaunchTemplateRequest.TemplateCase

getValidateOnly()

public boolean getValidateOnly()

If true, the request is validated but not actually executed. Defaults to false.

bool validate_only = 2;

Returns
Type Description
boolean

The validateOnly.

hasDynamicTemplate()

public boolean hasDynamicTemplate()

Params for launching a dynamic template.

.google.dataflow.v1beta3.DynamicTemplateLaunchParams dynamic_template = 6;

Returns
Type Description
boolean

Whether the dynamicTemplate field is set.

hasGcsPath()

public boolean hasGcsPath()

A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

string gcs_path = 3;

Returns
Type Description
boolean

Whether the gcsPath field is set.

hasLaunchParameters()

public boolean hasLaunchParameters()

The parameters of the template to launch. This should be part of the body of the POST request.

.google.dataflow.v1beta3.LaunchTemplateParameters launch_parameters = 4;

Returns
Type Description
boolean

Whether the launchParameters field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDynamicTemplate(DynamicTemplateLaunchParams value)

public LaunchTemplateRequest.Builder mergeDynamicTemplate(DynamicTemplateLaunchParams value)

Params for launching a dynamic template.

.google.dataflow.v1beta3.DynamicTemplateLaunchParams dynamic_template = 6;

Parameter
Name Description
value DynamicTemplateLaunchParams
Returns
Type Description
LaunchTemplateRequest.Builder

mergeFrom(LaunchTemplateRequest other)

public LaunchTemplateRequest.Builder mergeFrom(LaunchTemplateRequest other)
Parameter
Name Description
other LaunchTemplateRequest
Returns
Type Description
LaunchTemplateRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LaunchTemplateRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LaunchTemplateRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

mergeLaunchParameters(LaunchTemplateParameters value)

public LaunchTemplateRequest.Builder mergeLaunchParameters(LaunchTemplateParameters value)

The parameters of the template to launch. This should be part of the body of the POST request.

.google.dataflow.v1beta3.LaunchTemplateParameters launch_parameters = 4;

Parameter
Name Description
value LaunchTemplateParameters
Returns
Type Description
LaunchTemplateRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LaunchTemplateRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

setDynamicTemplate(DynamicTemplateLaunchParams value)

public LaunchTemplateRequest.Builder setDynamicTemplate(DynamicTemplateLaunchParams value)

Params for launching a dynamic template.

.google.dataflow.v1beta3.DynamicTemplateLaunchParams dynamic_template = 6;

Parameter
Name Description
value DynamicTemplateLaunchParams
Returns
Type Description
LaunchTemplateRequest.Builder

setDynamicTemplate(DynamicTemplateLaunchParams.Builder builderForValue)

public LaunchTemplateRequest.Builder setDynamicTemplate(DynamicTemplateLaunchParams.Builder builderForValue)

Params for launching a dynamic template.

.google.dataflow.v1beta3.DynamicTemplateLaunchParams dynamic_template = 6;

Parameter
Name Description
builderForValue DynamicTemplateLaunchParams.Builder
Returns
Type Description
LaunchTemplateRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public LaunchTemplateRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

setGcsPath(String value)

public LaunchTemplateRequest.Builder setGcsPath(String value)

A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

string gcs_path = 3;

Parameter
Name Description
value String

The gcsPath to set.

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

setGcsPathBytes(ByteString value)

public LaunchTemplateRequest.Builder setGcsPathBytes(ByteString value)

A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

string gcs_path = 3;

Parameter
Name Description
value ByteString

The bytes for gcsPath to set.

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

setLaunchParameters(LaunchTemplateParameters value)

public LaunchTemplateRequest.Builder setLaunchParameters(LaunchTemplateParameters value)

The parameters of the template to launch. This should be part of the body of the POST request.

.google.dataflow.v1beta3.LaunchTemplateParameters launch_parameters = 4;

Parameter
Name Description
value LaunchTemplateParameters
Returns
Type Description
LaunchTemplateRequest.Builder

setLaunchParameters(LaunchTemplateParameters.Builder builderForValue)

public LaunchTemplateRequest.Builder setLaunchParameters(LaunchTemplateParameters.Builder builderForValue)

The parameters of the template to launch. This should be part of the body of the POST request.

.google.dataflow.v1beta3.LaunchTemplateParameters launch_parameters = 4;

Parameter
Name Description
builderForValue LaunchTemplateParameters.Builder
Returns
Type Description
LaunchTemplateRequest.Builder

setLocation(String value)

public LaunchTemplateRequest.Builder setLocation(String value)

The regional endpoint to which to direct the request.

string location = 5;

Parameter
Name Description
value String

The location to set.

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public LaunchTemplateRequest.Builder setLocationBytes(ByteString value)

The regional endpoint to which to direct the request.

string location = 5;

Parameter
Name Description
value ByteString

The bytes for location to set.

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

setProjectId(String value)

public LaunchTemplateRequest.Builder setProjectId(String value)

Required. The ID of the Cloud Platform project that the job belongs to.

string project_id = 1;

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public LaunchTemplateRequest.Builder setProjectIdBytes(ByteString value)

Required. The ID of the Cloud Platform project that the job belongs to.

string project_id = 1;

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LaunchTemplateRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final LaunchTemplateRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LaunchTemplateRequest.Builder
Overrides

setValidateOnly(boolean value)

public LaunchTemplateRequest.Builder setValidateOnly(boolean value)

If true, the request is validated but not actually executed. Defaults to false.

bool validate_only = 2;

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
LaunchTemplateRequest.Builder

This builder for chaining.