org.apache.beam.fn.v1

Class BeamFnApi.InstructionResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.beam.fn.v1.BeamFnApi.InstructionResponse

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, BeamFnApi.InstructionResponseOrBuilder

Enclosing class:

BeamFnApi

public static final class BeamFnApi.InstructionResponse
extends com.google.protobuf.GeneratedMessageV3
implements BeamFnApi.InstructionResponseOrBuilder

 The response for an associated request the SDK had been asked to fulfill.
 Stable
 

Protobuf type org.apache.beam.fn.v1.InstructionResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeamFnApi.InstructionResponse.Builder The response for an associated request the SDK had been asked to fulfill.
static class	BeamFnApi.InstructionResponse.ResponseCase

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	ERROR_FIELD_NUMBER
static int	INSTRUCTION_ID_FIELD_NUMBER
static int	PROCESS_BUNDLE_FIELD_NUMBER
static int	PROCESS_BUNDLE_PROGRESS_FIELD_NUMBER
static int	PROCESS_BUNDLE_SPLIT_FIELD_NUMBER
static int	REGISTER_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 BeamFnApi.InstructionResponse	getDefaultInstance()
BeamFnApi.InstructionResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getError() If this is specified, then this instruction has failed.
com.google.protobuf.ByteString	getErrorBytes() If this is specified, then this instruction has failed.
String	getInstructionId() (Required) A reference provided by the runner which represents a requests execution.
com.google.protobuf.ByteString	getInstructionIdBytes() (Required) A reference provided by the runner which represents a requests execution.
com.google.protobuf.Parser<BeamFnApi.InstructionResponse>	getParserForType()
BeamFnApi.ProcessBundleResponse	getProcessBundle() .org.apache.beam.fn.v1.ProcessBundleResponse process_bundle = 1001;
BeamFnApi.ProcessBundleResponseOrBuilder	getProcessBundleOrBuilder() .org.apache.beam.fn.v1.ProcessBundleResponse process_bundle = 1001;
BeamFnApi.ProcessBundleProgressResponse	getProcessBundleProgress() .org.apache.beam.fn.v1.ProcessBundleProgressResponse process_bundle_progress = 1002;
BeamFnApi.ProcessBundleProgressResponseOrBuilder	getProcessBundleProgressOrBuilder() .org.apache.beam.fn.v1.ProcessBundleProgressResponse process_bundle_progress = 1002;
BeamFnApi.ProcessBundleSplitResponse	getProcessBundleSplit() .org.apache.beam.fn.v1.ProcessBundleSplitResponse process_bundle_split = 1003;
BeamFnApi.ProcessBundleSplitResponseOrBuilder	getProcessBundleSplitOrBuilder() .org.apache.beam.fn.v1.ProcessBundleSplitResponse process_bundle_split = 1003;
BeamFnApi.RegisterResponse	getRegister() .org.apache.beam.fn.v1.RegisterResponse register = 1000;
BeamFnApi.RegisterResponseOrBuilder	getRegisterOrBuilder() .org.apache.beam.fn.v1.RegisterResponse register = 1000;
BeamFnApi.InstructionResponse.ResponseCase	getResponseCase()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BeamFnApi.InstructionResponse.Builder	newBuilder()
static BeamFnApi.InstructionResponse.Builder	newBuilder(BeamFnApi.InstructionResponse prototype)
BeamFnApi.InstructionResponse.Builder	newBuilderForType()
protected BeamFnApi.InstructionResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static BeamFnApi.InstructionResponse	parseDelimitedFrom(InputStream input)
static BeamFnApi.InstructionResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.InstructionResponse	parseFrom(byte[] data)
static BeamFnApi.InstructionResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.InstructionResponse	parseFrom(com.google.protobuf.ByteString data)
static BeamFnApi.InstructionResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.InstructionResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static BeamFnApi.InstructionResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.InstructionResponse	parseFrom(InputStream input)
static BeamFnApi.InstructionResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BeamFnApi.InstructionResponse>	parser()
BeamFnApi.InstructionResponse.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

INSTRUCTION_ID_FIELD_NUMBER

public static final int INSTRUCTION_ID_FIELD_NUMBER

See Also:

Constant Field Values

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER

See Also:

Constant Field Values

REGISTER_FIELD_NUMBER

public static final int REGISTER_FIELD_NUMBER

See Also:

Constant Field Values

PROCESS_BUNDLE_FIELD_NUMBER

public static final int PROCESS_BUNDLE_FIELD_NUMBER

See Also:

Constant Field Values

PROCESS_BUNDLE_PROGRESS_FIELD_NUMBER

public static final int PROCESS_BUNDLE_PROGRESS_FIELD_NUMBER

See Also:

Constant Field Values

PROCESS_BUNDLE_SPLIT_FIELD_NUMBER

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

getResponseCase

public BeamFnApi.InstructionResponse.ResponseCase getResponseCase()

Specified by:

getResponseCase in interface BeamFnApi.InstructionResponseOrBuilder

getInstructionId

public String getInstructionId()

 (Required) A reference provided by the runner which represents a requests
 execution. The InstructionResponse MUST have the matching id when
 responding to the runner.
 

string instruction_id = 1;

Specified by:

getInstructionId in interface BeamFnApi.InstructionResponseOrBuilder

getInstructionIdBytes

public com.google.protobuf.ByteString getInstructionIdBytes()

 (Required) A reference provided by the runner which represents a requests
 execution. The InstructionResponse MUST have the matching id when
 responding to the runner.
 

string instruction_id = 1;

Specified by:

getInstructionIdBytes in interface BeamFnApi.InstructionResponseOrBuilder

getError

public String getError()

 If this is specified, then this instruction has failed.
 A human readable string representing the reason as to why processing has
 failed.
 

string error = 2;

Specified by:

getError in interface BeamFnApi.InstructionResponseOrBuilder

getErrorBytes

public com.google.protobuf.ByteString getErrorBytes()

 If this is specified, then this instruction has failed.
 A human readable string representing the reason as to why processing has
 failed.
 

string error = 2;

Specified by:

getErrorBytes in interface BeamFnApi.InstructionResponseOrBuilder

getRegister

public BeamFnApi.RegisterResponse getRegister()

.org.apache.beam.fn.v1.RegisterResponse register = 1000;

Specified by:

getRegister in interface BeamFnApi.InstructionResponseOrBuilder

getRegisterOrBuilder

public BeamFnApi.RegisterResponseOrBuilder getRegisterOrBuilder()

.org.apache.beam.fn.v1.RegisterResponse register = 1000;

Specified by:

getRegisterOrBuilder in interface BeamFnApi.InstructionResponseOrBuilder

getProcessBundle

public BeamFnApi.ProcessBundleResponse getProcessBundle()

.org.apache.beam.fn.v1.ProcessBundleResponse process_bundle = 1001;

Specified by:

getProcessBundle in interface BeamFnApi.InstructionResponseOrBuilder

getProcessBundleOrBuilder

public BeamFnApi.ProcessBundleResponseOrBuilder getProcessBundleOrBuilder()

.org.apache.beam.fn.v1.ProcessBundleResponse process_bundle = 1001;

Specified by:

getProcessBundleOrBuilder in interface BeamFnApi.InstructionResponseOrBuilder

getProcessBundleProgress

public BeamFnApi.ProcessBundleProgressResponse getProcessBundleProgress()

.org.apache.beam.fn.v1.ProcessBundleProgressResponse process_bundle_progress = 1002;

Specified by:

getProcessBundleProgress in interface BeamFnApi.InstructionResponseOrBuilder

getProcessBundleProgressOrBuilder

public BeamFnApi.ProcessBundleProgressResponseOrBuilder getProcessBundleProgressOrBuilder()

.org.apache.beam.fn.v1.ProcessBundleProgressResponse process_bundle_progress = 1002;

Specified by:

getProcessBundleProgressOrBuilder in interface BeamFnApi.InstructionResponseOrBuilder

getProcessBundleSplit

public BeamFnApi.ProcessBundleSplitResponse getProcessBundleSplit()

.org.apache.beam.fn.v1.ProcessBundleSplitResponse process_bundle_split = 1003;

Specified by:

getProcessBundleSplit in interface BeamFnApi.InstructionResponseOrBuilder

getProcessBundleSplitOrBuilder

public BeamFnApi.ProcessBundleSplitResponseOrBuilder getProcessBundleSplitOrBuilder()

.org.apache.beam.fn.v1.ProcessBundleSplitResponse process_bundle_split = 1003;

Specified by:

getProcessBundleSplitOrBuilder in interface BeamFnApi.InstructionResponseOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BeamFnApi.InstructionResponse parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BeamFnApi.InstructionResponse parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static BeamFnApi.InstructionResponse parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static BeamFnApi.InstructionResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public BeamFnApi.InstructionResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BeamFnApi.InstructionResponse.Builder newBuilder()

newBuilder

public static BeamFnApi.InstructionResponse.Builder newBuilder(BeamFnApi.InstructionResponse prototype)

toBuilder

public BeamFnApi.InstructionResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BeamFnApi.InstructionResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BeamFnApi.InstructionResponse getDefaultInstance()

parser

public static com.google.protobuf.Parser<BeamFnApi.InstructionResponse> parser()

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder