org.apache.beam.sdk.common.runner.v1

Class JobApi.PrepareJobRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.beam.sdk.common.runner.v1.JobApi.PrepareJobRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, JobApi.PrepareJobRequestOrBuilder

Enclosing class:

JobApi

public static final class JobApi.PrepareJobRequest
extends com.google.protobuf.GeneratedMessageV3
implements JobApi.PrepareJobRequestOrBuilder

 Prepare is a synchronous request that returns a preparationId back
 Throws error GRPC_STATUS_UNAVAILABLE if server is down
 Throws error ALREADY_EXISTS if the jobName is reused. Runners are permitted to deduplicate based on the name of the job.
 Throws error UNKNOWN for all other issues
 

Protobuf type org.apache.beam.runner_api.v1.PrepareJobRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobApi.PrepareJobRequest.Builder Prepare is a synchronous request that returns a preparationId back Throws error GRPC_STATUS_UNAVAILABLE if server is down Throws error ALREADY_EXISTS if the jobName is reused.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	JOB_NAME_FIELD_NUMBER
static int	PIPELINE_FIELD_NUMBER
static int	PIPELINE_OPTIONS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static JobApi.PrepareJobRequest	getDefaultInstance()
JobApi.PrepareJobRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getJobName() (required)
com.google.protobuf.ByteString	getJobNameBytes() (required)
com.google.protobuf.Parser<JobApi.PrepareJobRequest>	getParserForType()
RunnerApi.Pipeline	getPipeline() (required)
com.google.protobuf.Struct	getPipelineOptions() (required)
com.google.protobuf.StructOrBuilder	getPipelineOptionsOrBuilder() (required)
RunnerApi.PipelineOrBuilder	getPipelineOrBuilder() (required)
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasPipeline() (required)
boolean	hasPipelineOptions() (required)
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static JobApi.PrepareJobRequest.Builder	newBuilder()
static JobApi.PrepareJobRequest.Builder	newBuilder(JobApi.PrepareJobRequest prototype)
JobApi.PrepareJobRequest.Builder	newBuilderForType()
protected JobApi.PrepareJobRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static JobApi.PrepareJobRequest	parseDelimitedFrom(InputStream input)
static JobApi.PrepareJobRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JobApi.PrepareJobRequest	parseFrom(byte[] data)
static JobApi.PrepareJobRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JobApi.PrepareJobRequest	parseFrom(com.google.protobuf.ByteString data)
static JobApi.PrepareJobRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JobApi.PrepareJobRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static JobApi.PrepareJobRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JobApi.PrepareJobRequest	parseFrom(InputStream input)
static JobApi.PrepareJobRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<JobApi.PrepareJobRequest>	parser()
JobApi.PrepareJobRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PIPELINE_FIELD_NUMBER

public static final int PIPELINE_FIELD_NUMBER

See Also:

Constant Field Values

PIPELINE_OPTIONS_FIELD_NUMBER

public static final int PIPELINE_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

JOB_NAME_FIELD_NUMBER

public static final int JOB_NAME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasPipeline

public boolean hasPipeline()

 (required)
 

.org.apache.beam.runner_api.v1.Pipeline pipeline = 1;

Specified by:

hasPipeline in interface JobApi.PrepareJobRequestOrBuilder

getPipeline

public RunnerApi.Pipeline getPipeline()

 (required)
 

.org.apache.beam.runner_api.v1.Pipeline pipeline = 1;

Specified by:

getPipeline in interface JobApi.PrepareJobRequestOrBuilder

getPipelineOrBuilder

public RunnerApi.PipelineOrBuilder getPipelineOrBuilder()

 (required)
 

.org.apache.beam.runner_api.v1.Pipeline pipeline = 1;

Specified by:

getPipelineOrBuilder in interface JobApi.PrepareJobRequestOrBuilder

hasPipelineOptions

public boolean hasPipelineOptions()

 (required)
 

.google.protobuf.Struct pipeline_options = 2;

Specified by:

hasPipelineOptions in interface JobApi.PrepareJobRequestOrBuilder

getPipelineOptions

public com.google.protobuf.Struct getPipelineOptions()

 (required)
 

.google.protobuf.Struct pipeline_options = 2;

Specified by:

getPipelineOptions in interface JobApi.PrepareJobRequestOrBuilder

getPipelineOptionsOrBuilder

public com.google.protobuf.StructOrBuilder getPipelineOptionsOrBuilder()

 (required)
 

.google.protobuf.Struct pipeline_options = 2;

Specified by:

getPipelineOptionsOrBuilder in interface JobApi.PrepareJobRequestOrBuilder

getJobName

public String getJobName()

 (required)
 

string job_name = 3;

Specified by:

getJobName in interface JobApi.PrepareJobRequestOrBuilder

getJobNameBytes

public com.google.protobuf.ByteString getJobNameBytes()

 (required)
 

string job_name = 3;

Specified by:

getJobNameBytes in interface JobApi.PrepareJobRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static JobApi.PrepareJobRequest parseFrom(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JobApi.PrepareJobRequest parseFrom(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JobApi.PrepareJobRequest parseFrom(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JobApi.PrepareJobRequest parseFrom(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JobApi.PrepareJobRequest parseFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static JobApi.PrepareJobRequest parseFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static JobApi.PrepareJobRequest parseDelimitedFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static JobApi.PrepareJobRequest parseDelimitedFrom(InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseFrom

public static JobApi.PrepareJobRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static JobApi.PrepareJobRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

newBuilderForType

public JobApi.PrepareJobRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static JobApi.PrepareJobRequest.Builder newBuilder()

newBuilder

public static JobApi.PrepareJobRequest.Builder newBuilder(JobApi.PrepareJobRequest prototype)

toBuilder

public JobApi.PrepareJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected JobApi.PrepareJobRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static JobApi.PrepareJobRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<JobApi.PrepareJobRequest> parser()

getParserForType

public com.google.protobuf.Parser<JobApi.PrepareJobRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public JobApi.PrepareJobRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder