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

Class JobApi.RunJobRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

JobApi

public static final class JobApi.RunJobRequest
extends com.google.protobuf.GeneratedMessageV3
implements JobApi.RunJobRequestOrBuilder

 Run is a synchronous request that returns a jobId back.
 Throws error GRPC_STATUS_UNAVAILABLE if server is down
 Throws error NOT_FOUND if the preparation ID does not exist
 Throws error UNKNOWN for all other issues
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobApi.RunJobRequest.Builder Run is a synchronous request that returns a jobId back.

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	PREPARATION_ID_FIELD_NUMBER
static int	STAGING_TOKEN_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.RunJobRequest	getDefaultInstance()
JobApi.RunJobRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<JobApi.RunJobRequest>	getParserForType()
String	getPreparationId() (required) The ID provided by an earlier call to prepare.
com.google.protobuf.ByteString	getPreparationIdBytes() (required) The ID provided by an earlier call to prepare.
int	getSerializedSize()
String	getStagingToken() (optional) If any artifacts have been staged for this job, contains the staging_token returned from the CommitManifestResponse.
com.google.protobuf.ByteString	getStagingTokenBytes() (optional) If any artifacts have been staged for this job, contains the staging_token returned from the CommitManifestResponse.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static JobApi.RunJobRequest.Builder	newBuilder()
static JobApi.RunJobRequest.Builder	newBuilder(JobApi.RunJobRequest prototype)
JobApi.RunJobRequest.Builder	newBuilderForType()
protected JobApi.RunJobRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static JobApi.RunJobRequest	parseDelimitedFrom(InputStream input)
static JobApi.RunJobRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JobApi.RunJobRequest	parseFrom(byte[] data)
static JobApi.RunJobRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JobApi.RunJobRequest	parseFrom(com.google.protobuf.ByteString data)
static JobApi.RunJobRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JobApi.RunJobRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static JobApi.RunJobRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JobApi.RunJobRequest	parseFrom(InputStream input)
static JobApi.RunJobRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<JobApi.RunJobRequest>	parser()
JobApi.RunJobRequest.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

PREPARATION_ID_FIELD_NUMBER

public static final int PREPARATION_ID_FIELD_NUMBER

See Also:

Constant Field Values

STAGING_TOKEN_FIELD_NUMBER

public static final int STAGING_TOKEN_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

getPreparationId

public String getPreparationId()

 (required) The ID provided by an earlier call to prepare. Runs the job. All prerequisite tasks
 must have been completed.
 

string preparation_id = 1;

Specified by:

getPreparationId in interface JobApi.RunJobRequestOrBuilder

getPreparationIdBytes

public com.google.protobuf.ByteString getPreparationIdBytes()

 (required) The ID provided by an earlier call to prepare. Runs the job. All prerequisite tasks
 must have been completed.
 

string preparation_id = 1;

Specified by:

getPreparationIdBytes in interface JobApi.RunJobRequestOrBuilder

getStagingToken

public String getStagingToken()

 (optional) If any artifacts have been staged for this job, contains the staging_token returned
 from the CommitManifestResponse.
 

string staging_token = 2;

Specified by:

getStagingToken in interface JobApi.RunJobRequestOrBuilder

getStagingTokenBytes

public com.google.protobuf.ByteString getStagingTokenBytes()

 (optional) If any artifacts have been staged for this job, contains the staging_token returned
 from the CommitManifestResponse.
 

string staging_token = 2;

Specified by:

getStagingTokenBytes in interface JobApi.RunJobRequestOrBuilder

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.RunJobRequest parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JobApi.RunJobRequest 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.RunJobRequest parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public JobApi.RunJobRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static JobApi.RunJobRequest.Builder newBuilder()

newBuilder

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

toBuilder

public JobApi.RunJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static JobApi.RunJobRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<JobApi.RunJobRequest> 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.RunJobRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder