Class CreateJobFromTemplateRequest (0.56.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
Type Description
int

GCS_PATH_FIELD_NUMBER

public static final int GCS_PATH_FIELD_NUMBER
Field Value
Type Description
int

JOB_NAME_FIELD_NUMBER

public static final int JOB_NAME_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateJobFromTemplateRequest getDefaultInstance()
Returns
Type Description
CreateJobFromTemplateRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateJobFromTemplateRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<CreateJobFromTemplateRequest> parser()
Returns
Type Description
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
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 CreateJobFromTemplateRequest getDefaultInstanceForType()
Returns
Type Description
CreateJobFromTemplateRequest

getEnvironment()

public RuntimeEnvironment getEnvironment()

The runtime environment for the job.

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

Returns
Type Description
RuntimeEnvironment

The environment.

getEnvironmentOrBuilder()

public RuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()

The runtime environment for the job.

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

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for gcsPath.

getJobName()

public String getJobName()

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

string job_name = 4;

Returns
Type Description
String

The jobName.

getJobNameBytes()

public ByteString getJobNameBytes()

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

string job_name = 4;

Returns
Type Description
ByteString

The bytes for jobName.

getLocation()

public String getLocation()

The regional endpoint to which to direct the request.

string location = 6;

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

The regional endpoint to which to direct the request.

string location = 6;

Returns
Type Description
ByteString

The bytes for location.

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

Returns
Type Description
int

getParametersMap()

public Map<String,String> getParametersMap()

The runtime parameters to pass to the job.

map<string, string> parameters = 3;

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

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

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<CreateJobFromTemplateRequest> getParserForType()
Returns
Type Description
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
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTemplateCase()

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

hasEnvironment()

public boolean hasEnvironment()

The runtime environment for the job.

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

Returns
Type Description
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
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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