org.apache.beam.fn.v1

Interface BeamFnApi.StateRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

BeamFnApi.StateRequest, BeamFnApi.StateRequest.Builder

Enclosing class:

BeamFnApi

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

Method Summary

Modifier and Type	Method and Description
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.
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.
BeamFnApi.StateRequest.RequestCase	getRequestCase()
BeamFnApi.StateKey	getStateKey() (Required) The state key this request is for.
BeamFnApi.StateKeyOrBuilder	getStateKeyOrBuilder() (Required) The state key this request is for.
boolean	hasStateKey() (Required) The state key this request is for.

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) 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;

getIdBytes

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;

getInstructionReference

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;

getInstructionReferenceBytes

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;

hasStateKey

boolean hasStateKey()

 (Required) The state key this request is for.
 

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

getStateKey

BeamFnApi.StateKey getStateKey()

 (Required) The state key this request is for.
 

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

getStateKeyOrBuilder

BeamFnApi.StateKeyOrBuilder getStateKeyOrBuilder()

 (Required) The state key this request is for.
 

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

getGet

BeamFnApi.StateGetRequest getGet()

 A request to get state.
 

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

getGetOrBuilder

BeamFnApi.StateGetRequestOrBuilder getGetOrBuilder()

 A request to get state.
 

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

getAppend

BeamFnApi.StateAppendRequest getAppend()

 A request to append to state.
 

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

getAppendOrBuilder

BeamFnApi.StateAppendRequestOrBuilder getAppendOrBuilder()

 A request to append to state.
 

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

getClear

BeamFnApi.StateClearRequest getClear()

 A request to clear state.
 

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

getClearOrBuilder

BeamFnApi.StateClearRequestOrBuilder getClearOrBuilder()

 A request to clear state.
 

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

getRequestCase

BeamFnApi.StateRequest.RequestCase getRequestCase()