org.apache.beam.fn.v1

Class BeamFnApi.StateRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.beam.fn.v1.BeamFnApi.StateRequest

All Implemented Interfaces:

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

Enclosing class:

BeamFnApi

public static final class BeamFnApi.StateRequest
extends com.google.protobuf.GeneratedMessageV3
implements BeamFnApi.StateRequestOrBuilder

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeamFnApi.StateRequest.Builder Protobuf type org.apache.beam.fn.v1.StateRequest
static class	BeamFnApi.StateRequest.RequestCase

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	APPEND_FIELD_NUMBER
static int	CLEAR_FIELD_NUMBER
static int	GET_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	INSTRUCTION_REFERENCE_FIELD_NUMBER
static int	STATE_KEY_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)
BeamFnApi.StateAppendRequest	getAppend() A request to append to state.
BeamFnApi.StateAppendRequestOrBuilder	getAppendOrBuilder() A request to append to state.
BeamFnApi.StateClearRequest	getClear() A request to clear state.
BeamFnApi.StateClearRequestOrBuilder	getClearOrBuilder() A request to clear state.
static BeamFnApi.StateRequest	getDefaultInstance()
BeamFnApi.StateRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
BeamFnApi.StateGetRequest	getGet() A request to get state.
BeamFnApi.StateGetRequestOrBuilder	getGetOrBuilder() A request to get state.
String	getId() (Required) An unique identifier provided by the SDK which represents this requests execution.
com.google.protobuf.ByteString	getIdBytes() (Required) An unique identifier provided by the SDK which represents this requests execution.
String	getInstructionReference() (Required) The associated instruction id of the work that is currently being processed.
com.google.protobuf.ByteString	getInstructionReferenceBytes() (Required) The associated instruction id of the work that is currently being processed.
com.google.protobuf.Parser<BeamFnApi.StateRequest>	getParserForType()
BeamFnApi.StateRequest.RequestCase	getRequestCase()
int	getSerializedSize()
BeamFnApi.StateKey	getStateKey() (Required) The state key this request is for.
BeamFnApi.StateKeyOrBuilder	getStateKeyOrBuilder() (Required) The state key this request is for.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasStateKey() (Required) The state key this request is for.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BeamFnApi.StateRequest.Builder	newBuilder()
static BeamFnApi.StateRequest.Builder	newBuilder(BeamFnApi.StateRequest prototype)
BeamFnApi.StateRequest.Builder	newBuilderForType()
protected BeamFnApi.StateRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static BeamFnApi.StateRequest	parseDelimitedFrom(InputStream input)
static BeamFnApi.StateRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.StateRequest	parseFrom(byte[] data)
static BeamFnApi.StateRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.StateRequest	parseFrom(com.google.protobuf.ByteString data)
static BeamFnApi.StateRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.StateRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static BeamFnApi.StateRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.StateRequest	parseFrom(InputStream input)
static BeamFnApi.StateRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BeamFnApi.StateRequest>	parser()
BeamFnApi.StateRequest.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

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

INSTRUCTION_REFERENCE_FIELD_NUMBER

public static final int INSTRUCTION_REFERENCE_FIELD_NUMBER

See Also:

Constant Field Values

STATE_KEY_FIELD_NUMBER

public static final int STATE_KEY_FIELD_NUMBER

See Also:

Constant Field Values

GET_FIELD_NUMBER

public static final int GET_FIELD_NUMBER

See Also:

Constant Field Values

APPEND_FIELD_NUMBER

public static final int APPEND_FIELD_NUMBER

See Also:

Constant Field Values

CLEAR_FIELD_NUMBER

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

getRequestCase

public BeamFnApi.StateRequest.RequestCase getRequestCase()

Specified by:

getRequestCase in interface BeamFnApi.StateRequestOrBuilder

getId

public String getId()

 (Required) An unique identifier provided by the SDK which represents this
 requests execution. The StateResponse corresponding with this request
 will have the matching id.
 

string id = 1;

Specified by:

getId in interface BeamFnApi.StateRequestOrBuilder

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 (Required) An unique identifier provided by the SDK which represents this
 requests execution. The StateResponse corresponding with this request
 will have the matching id.
 

string id = 1;

Specified by:

getIdBytes in interface BeamFnApi.StateRequestOrBuilder

getInstructionReference

public String getInstructionReference()

 (Required) The associated instruction id of the work that is currently
 being processed. This allows for the runner to associate any modifications
 to state to be committed with the appropriate work execution.
 

string instruction_reference = 2;

Specified by:

getInstructionReference in interface BeamFnApi.StateRequestOrBuilder

getInstructionReferenceBytes

public com.google.protobuf.ByteString getInstructionReferenceBytes()

 (Required) The associated instruction id of the work that is currently
 being processed. This allows for the runner to associate any modifications
 to state to be committed with the appropriate work execution.
 

string instruction_reference = 2;

Specified by:

getInstructionReferenceBytes in interface BeamFnApi.StateRequestOrBuilder

hasStateKey

public boolean hasStateKey()

 (Required) The state key this request is for.
 

.org.apache.beam.fn.v1.StateKey state_key = 3;

Specified by:

hasStateKey in interface BeamFnApi.StateRequestOrBuilder

getStateKey

public BeamFnApi.StateKey getStateKey()

 (Required) The state key this request is for.
 

.org.apache.beam.fn.v1.StateKey state_key = 3;

Specified by:

getStateKey in interface BeamFnApi.StateRequestOrBuilder

getStateKeyOrBuilder

public BeamFnApi.StateKeyOrBuilder getStateKeyOrBuilder()

 (Required) The state key this request is for.
 

.org.apache.beam.fn.v1.StateKey state_key = 3;

Specified by:

getStateKeyOrBuilder in interface BeamFnApi.StateRequestOrBuilder

getGet

public BeamFnApi.StateGetRequest getGet()

 A request to get state.
 

.org.apache.beam.fn.v1.StateGetRequest get = 1000;

Specified by:

getGet in interface BeamFnApi.StateRequestOrBuilder

getGetOrBuilder

public BeamFnApi.StateGetRequestOrBuilder getGetOrBuilder()

 A request to get state.
 

.org.apache.beam.fn.v1.StateGetRequest get = 1000;

Specified by:

getGetOrBuilder in interface BeamFnApi.StateRequestOrBuilder

getAppend

public BeamFnApi.StateAppendRequest getAppend()

 A request to append to state.
 

.org.apache.beam.fn.v1.StateAppendRequest append = 1001;

Specified by:

getAppend in interface BeamFnApi.StateRequestOrBuilder

getAppendOrBuilder

public BeamFnApi.StateAppendRequestOrBuilder getAppendOrBuilder()

 A request to append to state.
 

.org.apache.beam.fn.v1.StateAppendRequest append = 1001;

Specified by:

getAppendOrBuilder in interface BeamFnApi.StateRequestOrBuilder

getClear

public BeamFnApi.StateClearRequest getClear()

 A request to clear state.
 

.org.apache.beam.fn.v1.StateClearRequest clear = 1002;

Specified by:

getClear in interface BeamFnApi.StateRequestOrBuilder

getClearOrBuilder

public BeamFnApi.StateClearRequestOrBuilder getClearOrBuilder()

 A request to clear state.
 

.org.apache.beam.fn.v1.StateClearRequest clear = 1002;

Specified by:

getClearOrBuilder in interface BeamFnApi.StateRequestOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public BeamFnApi.StateRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BeamFnApi.StateRequest.Builder newBuilder()

newBuilder

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

toBuilder

public BeamFnApi.StateRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BeamFnApi.StateRequest getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder