THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| Error Code | Error Definition | Error Description |
|---|---|---|
| REGION_NOT_FOUND | No region with the provided regionName exists. |
GetAll
Description
Get a series of values from a region.
Request
...
| GetAllRequest | ||||
| Field Name | Data type | Description | Mandatory? | Repeated? |
|---|---|---|---|---|
| regionName | ||||
...
| String |
...
| The name of the region to get entries from. | Y | N |
| keys |
...
| EncodedValue |
...
Description: the keys to look up in the region.
| A list of keys to fetch values for. | Y | Y |
Response
| GetAllResponse | ||||
| Field Name | Data type | Description | Mandatory? | Repeated |
|---|---|---|---|---|
| entries | Entry | A list of looked up entries. | Y | Y |
| failedKeys | KeyedErrorResponse | A list of keys which generated errors on lookup. | N | Y |
Expected behavior
If a GetAllResponse is returned and no entry is returned for a particular key, and that key is not present in the failedKeys, then no entry exists for that key in the region.
Errors
| Error Code | Error Definition | Error Description |
|---|---|---|
Response fields
entries
Type: repeated Entry
Description: the entries corresponding to keys that were present.
errors
Type: repeated ErrorEntry
Description: any keys that encountered an error will be returned here instead of in entries.
Behavior notes
An error for any key will return an error.
Any key not found in the region will return an Entry with that key and a null value.
...
| REGION_NOT_FOUND |
...
| No region with the provided regionName exists. |
...
CONSTRAINT_VIOLATION - the type of value provided for a key doesn’t match the region’s constraints.
...