THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
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 | |||
...
Type: string
| String | The |
...
| name of the region to get information on |
...
| Y |
Response
| GetRegionResponse | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
...
| region |
...
| Region |
...
| A structure containing information on the region |
...
| Y |
Expected behavior
If there is no region matching the regionName, a REGION_NOT_FOUND ErrorResponse will be returned
Errors
Errors
| Error Code | Error Definition | Error Description |
|---|---|---|
| REGION_NOT_FOUND |
...
| No Region exists for the name provided |
GetAvailableServers
Description
Returns a list of servers, in the cluster, visible to the client.
Request
| GetAvailableServersRequest | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
Response
| GetAvailableServersResponse | ||||
| Field Name | Data type | Description | Mandatory? | Repeated |
|---|---|---|---|---|
| servers | Server | A list of servers that are available in the cluster to connect to. | Y | Y |
...
- Return a list of all available servers in the cluster that are visible to the client
Errors
| 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? |
|---|---|---|---|
None.
Response
...
regions
...
Type: repeated string
| 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
Behavior notes
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
None specific There are no errors particular to this operation.
| Error Code | Error Definition | Error Description |
|---|---|---|
Remove
Description
Remove an entry from a region.Request fields
Request
| RemoveRequest | |||
| Field Name | Data type | Description | Mandatory? |
|---|---|---|---|
| regionName | |||
...
Type: string
| String | The |
...
| name of the region to remove an entry from. | Y |
| key |
...
| EncodedValue |
...
| The key of the the entry to be removed. | Y |
Response
The presence of a remove response indicates the entry is not longer present in the region. The response contains no additional data fields
None.
...
.
| 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.
...
Errors
| 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.
...