...
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
RemoveAllRequest | ||||
Field Name | Data type | Description | Mandatory? | Repeated? |
---|---|---|---|---|
regionName | String | The name of the region to remove entries from. | Y | N |
key | EncodedValue | A list of keys who's entries should be removed. | YY | 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. |
...