org.apache.beam.fn.v1

Interface BeamFnApi.StateResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

BeamFnApi.StateResponse, BeamFnApi.StateResponse.Builder

Enclosing class:

BeamFnApi

public static interface BeamFnApi.StateResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
BeamFnApi.StateResponse.ResponseCase	getResponseCase()

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getId

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;

getIdBytes

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;

getError

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;

getErrorBytes

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;

getCacheToken

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;

getGet

BeamFnApi.StateGetResponse getGet()

 A response to getting state.
 

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

getGetOrBuilder

BeamFnApi.StateGetResponseOrBuilder getGetOrBuilder()

 A response to getting state.
 

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

getAppend

BeamFnApi.StateAppendResponse getAppend()

 A response to appending to state.
 

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

getAppendOrBuilder

BeamFnApi.StateAppendResponseOrBuilder getAppendOrBuilder()

 A response to appending to state.
 

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

getClear

BeamFnApi.StateClearResponse getClear()

 A response to clearing state.
 

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

getClearOrBuilder

BeamFnApi.StateClearResponseOrBuilder getClearOrBuilder()

 A response to clearing state.
 

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

getResponseCase

BeamFnApi.StateResponse.ResponseCase getResponseCase()