Class LaunchTemplateRequest

public final class LaunchTemplateRequest extends GeneratedMessageV3 implements LaunchTemplateRequestOrBuilder

A request to launch a template.

Protobuf type google.dataflow.v1beta3.LaunchTemplateRequest

Static Fields

DYNAMIC_TEMPLATE_FIELD_NUMBER

public static final int DYNAMIC_TEMPLATE_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_PATH_FIELD_NUMBER

public static final int GCS_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

LAUNCH_PARAMETERS_FIELD_NUMBER

public static final int LAUNCH_PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static LaunchTemplateRequest getDefaultInstance()
Returns
TypeDescription
LaunchTemplateRequest

getDescriptor()

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

newBuilder()

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

newBuilder(LaunchTemplateRequest prototype)

public static LaunchTemplateRequest.Builder newBuilder(LaunchTemplateRequest prototype)
Parameter
NameDescription
prototypeLaunchTemplateRequest
Returns
TypeDescription
LaunchTemplateRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<LaunchTemplateRequest> parser()
Returns
TypeDescription
Parser<LaunchTemplateRequest>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public LaunchTemplateRequest getDefaultInstanceForType()
Returns
TypeDescription
LaunchTemplateRequest

getDynamicTemplate()

public DynamicTemplateLaunchParams getDynamicTemplate()

Params for launching a dynamic template.

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

Returns
TypeDescription
DynamicTemplateLaunchParams

The dynamicTemplate.

getDynamicTemplateOrBuilder()

public DynamicTemplateLaunchParamsOrBuilder getDynamicTemplateOrBuilder()

Params for launching a dynamic template.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
LaunchTemplateParameters

The launchParameters.

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

getLocation()

public String getLocation()

The regional endpoint to which to direct the request.

string location = 5;

Returns
TypeDescription
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

The regional endpoint to which to direct the request.

string location = 5;

Returns
TypeDescription
ByteString

The bytes for location.

getParserForType()

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

getProjectId()

public String getProjectId()

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

string project_id = 1;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTemplateCase()

public LaunchTemplateRequest.TemplateCase getTemplateCase()
Returns
TypeDescription
LaunchTemplateRequest.TemplateCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getValidateOnly()

public boolean getValidateOnly()

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

bool validate_only = 2;

Returns
TypeDescription
boolean

The validateOnly.

hasDynamicTemplate()

public boolean hasDynamicTemplate()

Params for launching a dynamic template.

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

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

Whether the launchParameters field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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