Page History

Table of Contents

Error Response

Description

This response type is returned when an error occurs with any command type.

...

...

Get

Description

Gets the value associated with a particular key in a particular region.

...

...

Put

Description

 Adds a (key, value) pair to a region, replacing any existing entry for the key.

...

...

GetRegion

Description

 Pass an OQL query to the server, which will execute it and return the resultGet a structure containing information about a region.

Request

...

GetRegionRequest

1. query

• Type: string

• Description: OQL describing the query to run

2. timeoutInMillis

• Type: int

• Optional (defaults to 0).

• Description: a timeout in milliseconds after which the query will terminate. If less than or equal to 0, no user-defined timeout is imposed.

3. parameters

• Type: repeated EncodedValue

• Must match the number of parameters expected for the query. Can be absent if no parameters are needed.

• Description: must match any parameters specified in OQL

Response fields

1. queryResults

• Type: repeated string

• Description: One JSON formatted string per response (see AbstractBaseController.processQueryResponse)

Behavior notes

The query will timeout on the shorter of the provided timeout or the cache’s timeout (configured in gemfire.Cache.MAX_QUERY_EXECUTION_TIME).

Errors

• 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 fields

1. regionName

• Type: string

• Description: the name of the region to get information on.

Response fields

1. region

• Type: Region

• Description: A structure containing information on the region.

Errors

• REGION_NOT_FOUND - if the region doesn’t exist.

GetAvailableServers

Description

Returns a list of servers, in the cluster, visible to the client.

Request

Response

Expected behavior

• If there is no region matching the regionName, a REGION_NOT_FOUND ErrorResponse will be returned

Errors

...

GetRegionNames

Description

 Returns a list of regions available through this server.

Request

A GetRegionNamesRequest contains no extra data fields.

Response

...

Expected Behavior

• Return a list of all available servers in the cluster that are visible to the client

Errors

GetRegionNames

Description

 Returns a list of regions available through this server.

Request fields

 None.

Response fields

...

regions

...

Type: repeated string

...

...

 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

None specific There are no errors particular to this operation.

...

Remove

Description

 Remove an entry from a region.

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 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.

...

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

...

...

...

RemoveAll

Description

 Removes all of a list of entries from a region.

Request

...

RemoveAllRequest
Field Name	Data type	Description	Mandatory?	Repeated?
regionName

...

Type: string

...

String

The name of the region to remove

...

entries from.

...

keys

...

Type: repeated EncodedValue

...

Y	N
key	EncodedValue	A list of keys

...

who's entries should be removed.

Response fields

 None.

...

Y

Y

Response

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

...

Errors

...

...

...

PutAll

Description

 Put a collection of Entries into a region.

Request

...

PutAllRequest
Field Name	Data type	Description	Mandatory?	Repeated?
regionName

...

String

...

The name of the region to put entries into.	Y	N
entries

...

Entry

...

A list of entries to add to the region.

...

Y

Y

Response

...

...

...

Expected behavior 

...

Behavior notes

...

• If a PutAllResponse is returned with a list of failedKeys, any keys from the request not present in the

...

• response were successfully

...

• added/updated.

...

If two Entries share equal keys, a successful operation will result in one of the Entries being present in the region. Which one is undefined.

• 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

Errors

...

...

CONSTRAINT_VIOLATION - the type of value provided for a key or value doesn’t match the region’s constraints.

...

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

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

Response fields

1. entries

• Type: repeated Entry

• Description: the entries corresponding to keys that were present.

2. errors

• Type: repeated ErrorEntry

• Description: any keys that encountered an error will be returned here instead of in entries.

Behavior notes

1. An error for any key will return an error.

2. Any key not found in the region will return an Entry with that key and a null value.

Errors

...

...

CONSTRAINT_VIOLATION - the type of value provided for a key doesn’t match the region’s constraints.

...