THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Table of Contents
Error Response
Description
This response type is returned when an error occurs with any command type.
...
CONSTRAINT_VIOLATION - Bind parameter is not of the expected type
BAD_QUERY - Name in the query cannot be resolved!
BAD_QUERY - Query cannot be parsed.
PARAMETER_MISMATCH - The number of bound parameters does not match the number of placeholders!
OPERATION_NOT_PERMITTED - Query is not permitted on this type of region!
OPERATION_TIMEOUT - Query execution time has exceeded max query execution time (gemfire.Cache.MAX_QUERY_EXECUTION_TIME) configured!
OPERATION_TIMEOUT - Query execution time has exceeded provided timeout
GetRegion
Description
Get a structure containing information about a region.
Request
...
| GetRegionRequest | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
| regionName | String | The name of the region to get information on | YY |
Response
| GetRegionResponse | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
| region | Region | A structure containing information on the region | YY |
Expected behavior
...
If there is no region matching the regionName, a REGION_NOT_FOUND ErrorResponse will be returned
Errors
| Error Code | Error Definition | Error Description |
|---|---|---|
| REGION_NOT_FOUND | No Region exists for the name provided |
...
| Error Code | Error Definition | Error Description |
|---|---|---|
GetRegionNames
Description
Returns a list of regions available through this server.
Request
A GetRegionNamesRequest contains no extra data fields.
| GetRegionNamesRequest | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
Response
| GetRegionNamesResponse | ||||
| Field Name | Data type | Description | Mandatory? | Repeated |
|---|---|---|---|---|
| regions | String | A list of the names of the regions that are available on the server. | Y | Y |
Expected behavior
...
This only gets the regions present on the target server. This may not be the set of all regions in the cluster, depending on how the servers are configured.
Errors
There are no errors particular to this operation.
| Error Code | Error Definition | Error Description |
|---|---|---|
...
Remove an entry from a region.
...
Request
...
| RemoveRequest | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
| regionName | String | The name of the region to remove an entry from. | Y |
| key | EncodedValue | The key of the the entry to be removed. | Y |
...
The presence of a remove response indicates the entry is not longer present in the region. The response contains no additional data fields.
| RemoveResponse | ||||
| Field Name | Data type | Description | Mandatory? | Repeated |
|---|---|---|---|---|
Expected behavior
...
If the key is not present in the region, this operation will make no changes to the region. It will still return a RemoveResponse in this case.
Errors
There are no errors particular to this operation.
| Error Code | Error Definition | Error Description |
|---|---|---|
| REGION_NOT_FOUND | No region with the provided regionName exists. | |
| CONSTRAINT_VIOLATION | The type of value provided for the key doesn’t match the region’s constraints. |
RemoveAll
Description
Removes all of a list of entries from a region.Request fields
Request
| RemoveAllRequest | ||||
| Field Name | Data type | Description | Mandatory? | Repeated? |
|---|---|---|---|---|
| regionName | ||||
...
Type: string
| String | The |
...
| name of the region to remove |
...
| entries from. | Y | N |
...
| key |
...
| EncodedValue |
...
| A list of keys |
...
| who's entries should be removed. |
Response fields
None.
...
| Y | Y |
Response
| RemoveAllResponse | ||||
| Field Name | Data type | Description | Mandatory? | Repeated |
|---|---|---|---|---|
| failedKeys | KeyedErrorResponse | A list of keys that were not removed. | N | Y |
Expected behavior
If a key is not present in the region, this operation will ignore it and continue with the others.
If
...
a RemoveAllResponse is returned
...
with a list of failedKeys, any keys from the request not present in the response have been removed. If an empty list is returned, all keys were removed.
Any keys present in failedKeys will have their entry remain in the same state they were in prior to this operation.
If an error response is returned by this operation (instead of a RemoveAllResponse), all entries remain in the same state as prior to this operation.
Errors
| Error Code | Error Definition | Error Description |
|---|---|---|
| REGION_NOT_FOUND |
...
| No region with the provided regionName exists |
...
| . |
PutAll
Description
Put a collection of Entries into a region.
...