# Class GetIndexesRequestChecker (5.0.3)

    public class GetIndexesRequestChecker

Checks values of [com.google.appengine.api.search.GetIndexesRequest](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.GetIndexesRequest).

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> GetIndexesRequestChecker

## Inherited Members

[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

## Static Methods

### checkIndexNamePrefix(String indexNamePrefix)

    public static String checkIndexNamePrefix(String indexNamePrefix)

Checks whether the given index name prefix is legal. This method uses the same
checks as [IndexChecker#checkName(String)](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.checkers.IndexChecker#com_google_appengine_api_search_checkers_IndexChecker_checkName_java_lang_String_).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `indexNamePrefix` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` the index name prefix to be checked |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | the checked index name prefix |

### checkLimit(int limit)

    public static int checkLimit(int limit)

Checks whether the number of indexes to return is between 1 and the
maximum.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `limit` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` the maximum number of indexes to return in list results |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | the checked number of indexes to return |

### checkListIndexesParams(SearchServicePb.ListIndexesParams params)

    public static SearchServicePb.ListIndexesParams checkListIndexesParams(SearchServicePb.ListIndexesParams params)

Ensures the given protocol buffer parameters are valid. If any of the parameters
fail to pass the checks, this method throws IllegalArgumentException. If
everything is valid the original parameters are returned.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `params` | `com.google.appengine.api.search.proto.SearchServicePb.ListIndexesParams` the parameters to be checked for validity |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.appengine.api.search.proto.SearchServicePb.ListIndexesParams` | the checked parameters for listing indexes |

### checkOffset(int offset)

    public static int checkOffset(int offset)

Checks whether the offset of the first indexes to return is between 0 and the
maximum.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `offset` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` the offset of the first index to return in list results |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | the checked offset of the first index to return |

### checkStartIndexName(String startIndexName)

    public static String checkStartIndexName(String startIndexName)

Checks whether the given start index name is legal. This method uses the same
checks as [IndexChecker#checkName(String)](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.checkers.IndexChecker#com_google_appengine_api_search_checkers_IndexChecker_checkName_java_lang_String_).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `startIndexName` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` the name of the first index to be returned |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | the checked start index name |

## Constructors

### GetIndexesRequestChecker()

    public GetIndexesRequestChecker()