...
If key is not found in the region, the result will not be populated.
For valid key, return value as EncodedValue
- If there is no region matching the regionName, a REGION_NOT_FOUND ErrorResponse will be returned
- If the provided key does not match the configured key-constraint on the region, a CONSTRAINT_VIOLATION ErrorResponse will be returned
Errors
| Error Code | Error Definition | Error Description |
|---|---|---|
| REGION_NOT_FOUND | No Region exists for the name provided | |
| CONSTRAINT_VIOLATION | The key-constraint on the region has been violated and incompatible |
...
Adds a (key, value) pair to a region, replacing any existing entry for the key.
Request
...
| PutRequest | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
| regionName | String | The name of the region which is to be targeted | Y |
| entry | Entry | A type containing (key, value) pair to be inserted into the region. | Y |
Response
None - returns an empty put response message indicating success.
...
A successful Put operaration will result in an empty PutResponse message. This is because there is no data that needs to be sent back, but a message is needed to indicate a complete operation.
| PutResponse | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
Expected Behavior
- If an error is returned, any existing entry is left unmodified.
- If there is no region matching the regionName, a REGION_NOT_FOUND ErrorResponse will be returned
- If the provided key does not match the configured key-constraint on the region, a CONSTRAINT_VIOLATION ErrorResponse will be returned
Errors
| Error Code | Error Definition | Error Description |
|---|---|---|
| REGION_NOT_FOUND |
...
| No Region exists for the name provided | ||
| CONSTRAINT_VIOLATION | The key- |
...
| constraint on the region has been violated and incompatible |
Query
Description
Pass an OQL query to the server, which will execute it and return the result.
...