...
| ErrorResponse = Error | Description |
|---|
| error | type = Error | The error message |
...
...
ErrorThe server will raise the error when it failed to execute API request from the client. The error code and message should help the client to diagnose the issue.
...
Some data being sent between the client and server, for the most part these rely on protobuf for proper serialization, except for CustomEncodedValues
| EncodedValue = (one of the below) | Description |
|---|
| intResult | 32-bit signed integer |
| longResult | 64-bit signed integer |
| shortResult | 16-bit signed integer |
| byteResult | 8-bit signed integer |
| booleanResult | True or False. |
| doubleResult | 64-bit floating point number. |
| floatResult | 32-bit floating point number. |
| binaryResult | A binary blob to be stored in the region. |
| stringResult | Character string |
| customEncodedValue | Data which doesn't use protobuf serialization |
...
EncodedValue represents a serialized value in a format that Geode can understand. It is used for both keys and values in database requests.
| Value = { ValueHeader value} | Description |
|---|
| encodingType | type = EncodingType | The encoding type of the following bytes. |
| value | type = bytes | Serialized Value Object which Geode can understand |
...
| Name | Description |
|---|
| JSON | UTF-8 encoded string, containing a JSON document that will be deserialized in the same way as the REST API. |
This structure represents a pair of data corresponding to a key and associated value.
| Entry = EncodedValue Error | Description |
|---|
| key | type = EncodedValue | Data referencing the corresponding value |
| value | type = EncodedValue | Data associated to the corresponding key |
Some responses may contain multiple errors keyed to different inputs. This object enables this behavior.
| KeyedError = EncodedValue Error | Description |
|---|
| key | type = EncodedValue | Key corresponding to this error |
| error | type = Error | Details about the failure |