Class CreateJobFromTemplateRequest (0.24.0)

public final class CreateJobFromTemplateRequest extends GeneratedMessageV3 implements CreateJobFromTemplateRequestOrBuilder

A request to create a Cloud Dataflow job from a template.

Protobuf type google.dataflow.v1beta3.CreateJobFromTemplateRequest

Static Fields

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_PATH_FIELD_NUMBER

public static final int GCS_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

JOB_NAME_FIELD_NUMBER

public static final int JOB_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateJobFromTemplateRequest getDefaultInstance()
Returns
TypeDescription
CreateJobFromTemplateRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateJobFromTemplateRequest prototype)

public static CreateJobFromTemplateRequest.Builder newBuilder(CreateJobFromTemplateRequest prototype)
Parameter
NameDescription
prototypeCreateJobFromTemplateRequest
Returns
TypeDescription
CreateJobFromTemplateRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsParameters(String key)

public boolean containsParameters(String key)

The runtime parameters to pass to the job.

map<string, string> parameters = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public CreateJobFromTemplateRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateJobFromTemplateRequest

getEnvironment()

public RuntimeEnvironment getEnvironment()

The runtime environment for the job.

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

Returns
TypeDescription
RuntimeEnvironment

The environment.

getEnvironmentOrBuilder()

public RuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()

The runtime environment for the job.

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

Returns
TypeDescription
RuntimeEnvironmentOrBuilder

getGcsPath()

public String getGcsPath()

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

string gcs_path = 2;

Returns
TypeDescription
String

The gcsPath.

getGcsPathBytes()

public ByteString getGcsPathBytes()

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

string gcs_path = 2;

Returns
TypeDescription
ByteString

The bytes for gcsPath.

getJobName()

public String getJobName()

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

string job_name = 4;

Returns
TypeDescription
String

The jobName.

getJobNameBytes()

public ByteString getJobNameBytes()

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

string job_name = 4;

Returns
TypeDescription
ByteString

The bytes for jobName.

getLocation()

public String getLocation()

The regional endpoint to which to direct the request.

string location = 6;

Returns
TypeDescription
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

The regional endpoint to which to direct the request.

string location = 6;

Returns
TypeDescription
ByteString

The bytes for location.

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 = 3;

Returns
TypeDescription
int

getParametersMap()

public Map<String,String> getParametersMap()

The runtime parameters to pass to the job.

map<string, string> parameters = 3;

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 = 3;

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 = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<CreateJobFromTemplateRequest> getParserForType()
Returns
TypeDescription
Parser<CreateJobFromTemplateRequest>
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 CreateJobFromTemplateRequest.TemplateCase getTemplateCase()
Returns
TypeDescription
CreateJobFromTemplateRequest.TemplateCase

hasEnvironment()

public boolean hasEnvironment()

The runtime environment for the job.

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

Returns
TypeDescription
boolean

Whether the environment field is set.

hasGcsPath()

public boolean hasGcsPath()

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

string gcs_path = 2;

Returns
TypeDescription
boolean

Whether the gcsPath 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 CreateJobFromTemplateRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateJobFromTemplateRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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