Skip to end of metadata
Go to start of metadata

Region MessageType API IDs

Message Type DescriptionAPI Operation ID
Put1
Get2
PutAll3
GetAll4

Message Definitions

Put

Request

PutRequest => RegionName Key Value CallbackArg
Description
RegionNametype = StringThe Region Name
Keytype = EncodedValueThe Key that is to be added to the region
Valuetype = EncodedValueThe Value that is to be added to the region
CallbackArgtype = EncodedValueThe Callback arguments to be sent with the operation

Response

PutResponse => Success
Description
Successtype = booleanA flag indicating the success of the operation

Get

Request

GetRequest => RegionName Key CallbackArg
Description
RegionNametype = StringThe Region Name
Keytype = EncodedValueThe Key that data is going to be retrieved for
CallbackArgtype = EncodedValueThe Callback arguments to be sent with the operation

Response

GetResponse => Result
Description
Resulttype = EncodedValueThe Value that is to be returned for the Key

PutAll

Request

PutAllRequest => RegionName NumberOfKeys {Key Value} CallbackArg
Description
RegionNametype = StringThe Region name
NumberOfKeystype = int32The number of Key:Value combinations to be inserted
Keytype = EncodedValueThe Key that is to be added to the region
Valuetype = EncodedValueThe Value that is to be added to the region
CallbackArgtype = EncodedValueThe Callback arguments to be sent with the operation

Response

PutAllResponse => NumberOfKeysFailed {Key}
Description
NumberOfKeysFailedtype = int32In general this will be 0. But if Geode unable to put some keys in Region then client can retry those keys.
Keytype = EncodedValueThe Key which could not be added to the Region

GetAll

Request

GetAllRequest => RegionName NumberOfKeys {Key} CallbackArg
Description
RegionNametype = StringThe Region Name
NumberOfKeystype = int32The number of Keys for which Values are to be retrieved
Keytype = EncodedValueThe Key to be used to retrieve a Value
CallbackArgtype = EncodedValueThe Callback arguments to be sent with the operation

Response

GetAllResponse => NumberOfKeyValuePairs {Key Value}
Description
NumberOfKeyValuePairstype = int32The number of Key:Value combinations returned
Keytype = EncodedValueThe Key for the Value
Valuetype = EncodedValueThe retrieved Value for the corresponding Key

Error Code Definitions

Error DescriptionError Code
PUTALL_PARTIAL_RESULT_EXCEPTION1
REGION_EXIST_EXCEPTION2
REGION_NOT_EXIST_EXCEPTION3
REGION_DESTROYED_EXCEPTION4
ENTRY_DESTROYED_EXCEPTION5
ENTRY_NOT_FOUND_EXCEPTION6
ENTRY_EXIST_EXCEPTION7
CACHE_WRITER_EXCEPTION8
CACHE_LISTENER_EXCEPTION9
CACHE_LOADER_EXCEPTION10
BUCKET_MOVED_EXCEPTION11
CONCURRENT_MODIFICATION_EXCEPTION12

 


  • No labels