org.apache.beam.fn.v1

Class BeamFnApi.StateResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.beam.fn.v1.BeamFnApi.StateResponse

All Implemented Interfaces:

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

Enclosing class:

BeamFnApi

public static final class BeamFnApi.StateResponse
extends com.google.protobuf.GeneratedMessageV3
implements BeamFnApi.StateResponseOrBuilder

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeamFnApi.StateResponse.Builder Protobuf type org.apache.beam.fn.v1.StateResponse
static class	BeamFnApi.StateResponse.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	APPEND_FIELD_NUMBER
static int	CACHE_TOKEN_FIELD_NUMBER
static int	CLEAR_FIELD_NUMBER
static int	ERROR_FIELD_NUMBER
static int	GET_FIELD_NUMBER
static int	ID_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.StateAppendResponse	getAppend() A response to appending to state.
BeamFnApi.StateAppendResponseOrBuilder	getAppendOrBuilder() A response to appending to state.
com.google.protobuf.ByteString	getCacheToken() (Optional) If this is specified, then the result of this state request can be cached using the supplied token.
BeamFnApi.StateClearResponse	getClear() A response to clearing state.
BeamFnApi.StateClearResponseOrBuilder	getClearOrBuilder() A response to clearing state.
static BeamFnApi.StateResponse	getDefaultInstance()
BeamFnApi.StateResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getError() (Optional) If this is specified, then the state request has failed.
com.google.protobuf.ByteString	getErrorBytes() (Optional) If this is specified, then the state request has failed.
BeamFnApi.StateGetResponse	getGet() A response to getting state.
BeamFnApi.StateGetResponseOrBuilder	getGetOrBuilder() A response to getting state.
String	getId() (Required) A reference provided by the SDK which represents a requests execution.
com.google.protobuf.ByteString	getIdBytes() (Required) A reference provided by the SDK which represents a requests execution.
com.google.protobuf.Parser<BeamFnApi.StateResponse>	getParserForType()
BeamFnApi.StateResponse.ResponseCase	getResponseCase()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BeamFnApi.StateResponse.Builder	newBuilder()
static BeamFnApi.StateResponse.Builder	newBuilder(BeamFnApi.StateResponse prototype)
BeamFnApi.StateResponse.Builder	newBuilderForType()
protected BeamFnApi.StateResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static BeamFnApi.StateResponse	parseDelimitedFrom(InputStream input)
static BeamFnApi.StateResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.StateResponse	parseFrom(byte[] data)
static BeamFnApi.StateResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.StateResponse	parseFrom(com.google.protobuf.ByteString data)
static BeamFnApi.StateResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.StateResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static BeamFnApi.StateResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.StateResponse	parseFrom(InputStream input)
static BeamFnApi.StateResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BeamFnApi.StateResponse>	parser()
BeamFnApi.StateResponse.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

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER

See Also:

Constant Field Values

CACHE_TOKEN_FIELD_NUMBER

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

getResponseCase

public BeamFnApi.StateResponse.ResponseCase getResponseCase()

Specified by:

getResponseCase in interface BeamFnApi.StateResponseOrBuilder

getId

public String getId()

 (Required) A reference provided by the SDK which represents a requests
 execution. The StateResponse must have the matching id when responding
 to the SDK.
 

string id = 1;

Specified by:

getId in interface BeamFnApi.StateResponseOrBuilder

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 (Required) A reference provided by the SDK which represents a requests
 execution. The StateResponse must have the matching id when responding
 to the SDK.
 

string id = 1;

Specified by:

getIdBytes in interface BeamFnApi.StateResponseOrBuilder

getError

public String getError()

 (Optional) If this is specified, then the state request has failed.
 A human readable string representing the reason as to why the request
 failed.
 

string error = 2;

Specified by:

getError in interface BeamFnApi.StateResponseOrBuilder

getErrorBytes

public com.google.protobuf.ByteString getErrorBytes()

 (Optional) If this is specified, then the state request has failed.
 A human readable string representing the reason as to why the request
 failed.
 

string error = 2;

Specified by:

getErrorBytes in interface BeamFnApi.StateResponseOrBuilder

getCacheToken

public com.google.protobuf.ByteString getCacheToken()

 (Optional) If this is specified, then the result of this state request
 can be cached using the supplied token.
 

bytes cache_token = 3;

Specified by:

getCacheToken in interface BeamFnApi.StateResponseOrBuilder

getGet

public BeamFnApi.StateGetResponse getGet()

 A response to getting state.
 

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

Specified by:

getGet in interface BeamFnApi.StateResponseOrBuilder

getGetOrBuilder

public BeamFnApi.StateGetResponseOrBuilder getGetOrBuilder()

 A response to getting state.
 

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

Specified by:

getGetOrBuilder in interface BeamFnApi.StateResponseOrBuilder

getAppend

public BeamFnApi.StateAppendResponse getAppend()

 A response to appending to state.
 

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

Specified by:

getAppend in interface BeamFnApi.StateResponseOrBuilder

getAppendOrBuilder

public BeamFnApi.StateAppendResponseOrBuilder getAppendOrBuilder()

 A response to appending to state.
 

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

Specified by:

getAppendOrBuilder in interface BeamFnApi.StateResponseOrBuilder

getClear

public BeamFnApi.StateClearResponse getClear()

 A response to clearing state.
 

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

Specified by:

getClear in interface BeamFnApi.StateResponseOrBuilder

getClearOrBuilder

public BeamFnApi.StateClearResponseOrBuilder getClearOrBuilder()

 A response to clearing state.
 

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

Specified by:

getClearOrBuilder in interface BeamFnApi.StateResponseOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public BeamFnApi.StateResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BeamFnApi.StateResponse.Builder newBuilder()

newBuilder

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

toBuilder

public BeamFnApi.StateResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BeamFnApi.StateResponse getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder