Note: Java 8 has reached end of support on January 31, 2024. Your existing Java 8 applications will continue to run and receive traffic. However, App Engine might block re-deployment of applications that use runtimes after their end of support date. We recommend that you migrate to the latest supported version of Java.

SearchApiLimits (Google App Engine API for Java)

java.lang.Object
- com.google.appengine.api.search.checkers.SearchApiLimits

```
public class SearchApiLimits
extends java.lang.Object
```
Contains limits on field values, document sizes, and other properties of objects in the Search API.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FACET_DEFAULT_DISCOVERY_LIMIT` The default value for number of discovered facets.
`static int`	`FACET_MAXIMUM_CONSTRAINTS` The maximum number of facet value constraint can be requested.
`static int`	`FACET_MAXIMUM_DEPTH` The maximum number for facet depth option.
`static int`	`FACET_MAXIMUM_DISCOVERY_LIMIT` The maximum number of facet discoveries that can be requested.
`static int`	`FACET_MAXIMUM_RANGES` The maximum number of facet ranges can be requested.
`static int`	`FACET_MAXIMUM_VALUE_LIMIT` The maximum value for facet value limit option.
`static java.lang.String`	`FIELD_NAME_PATTERN` The pattern each document field name should match.
`static int`	`GET_INDEXES_DEFAULT_LIMIT` The default number of indexes we will try to return.
`static int`	`GET_INDEXES_MAXIMUM_LIMIT` The maximum number of indexes that can be requested to be returned in list indexes results.
`static int`	`GET_INDEXES_MAXIMUM_OFFSET` The maximum offset of the first index returned in list indexes results.
`static int`	`GET_RANGE_DEFAULT_LIMIT` The default number of documents requested for get range requests.
`static int`	`GET_RANGE_MAXIMUM_LIMIT` The maximum number of documents which can be requested for get range requests.
`static int`	`MAXIMUM_ATOM_LENGTH` The maximum length of an atom in bytes (500).
`static int`	`MAXIMUM_CURSOR_LENGTH` The maximum length of a cursor.
`static java.util.Date`	`MAXIMUM_DATE_VALUE` The maximum date that can be stored in a date field.
`static int`	`MAXIMUM_DOCUMENT_ID_LENGTH` The maximum length of a document id.
`static int`	`MAXIMUM_DOCUMENT_LENGTH` The maximum length of a document.
`static int`	`MAXIMUM_INDEX_NAME_LENGTH` The maximum length for an index name.
`static int`	`MAXIMUM_NAME_LENGTH` The maximum length of a field or facet name in bytes (500).
`static double`	`MAXIMUM_NEGATIVE_LATITUDE` The maximum negative degrees for latitude.
`static double`	`MAXIMUM_NEGATIVE_LONGITUDE` The maximum negative degrees for longitude.
`static double`	`MAXIMUM_NUMBER_VALUE` The maximum value that can be stored in a number field (2147483647).
`static double`	`MAXIMUM_POSITIVE_LATITUDE` The maximum positive degrees for latitude.
`static double`	`MAXIMUM_POSITIVE_LONGITUDE` The maximum positive degrees for longitude.
`static int`	`MAXIMUM_PREFIX_LENGTH` The maximum length of a prefix field in bytes (500).
`static int`	`MAXIMUM_QUERY_LENGTH` The maximum length of a query string.
`static int`	`MAXIMUM_TEXT_LENGTH` The maximum length of a text or HTML in bytes (1048576).
`static java.util.Date`	`MINIMUM_DATE_VALUE` The minimum date that can be stored in a date field.
`static double`	`MINIMUM_NUMBER_VALUE` The minimum value that can be stored in a number field (-2147483647).
`static int`	`PUT_MAXIMUM_DOCS_PER_REQUEST` The maximum number of documents allowed per index and delete request.
`static int`	`SEARCH_DEFAULT_LIMIT` The default limit on the number of documents to return in results.
`static int`	`SEARCH_DEFAULT_NUMBER_FOUND_ACCURACY` The default found count accuracy is the limit.
`static int`	`SEARCH_DEFAULT_SORTED_LIMIT` The default number of documents to score.
`static int`	`SEARCH_MAXIMUM_LIMIT` The maximum number of documents that can be requested to be returned in search results.
`static int`	`SEARCH_MAXIMUM_NUMBER_FOUND_ACCURACY` The maximum number found accuracy that can be requested.
`static int`	`SEARCH_MAXIMUM_NUMBER_OF_FIELDS_TO_RETURN` The maximum number of names of fields to return in results.
`static int`	`SEARCH_MAXIMUM_OFFSET` The maximum offset into all search results to return results from.
`static int`	`SEARCH_MAXIMUM_SORTED_LIMIT` The maximum number of documents that can be requested to be scored.
`static int`	`VECTOR_FIELD_MAX_SIZE` The maximum size of a vector field.

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FIELD_NAME_PATTERN
```
public static final java.lang.String FIELD_NAME_PATTERN
```
    The pattern each document field name should match.
    
    See Also:
    
    Constant Field Values
  - GET_INDEXES_DEFAULT_LIMIT
```
public static final int GET_INDEXES_DEFAULT_LIMIT
```
    The default number of indexes we will try to return.
    
    See Also:
    
    Constant Field Values
  - GET_INDEXES_MAXIMUM_LIMIT
```
public static final int GET_INDEXES_MAXIMUM_LIMIT
```
    The maximum number of indexes that can be requested to be returned in list indexes results.
    
    See Also:
    
    Constant Field Values
  - GET_INDEXES_MAXIMUM_OFFSET
```
public static final int GET_INDEXES_MAXIMUM_OFFSET
```
    The maximum offset of the first index returned in list indexes results.
    
    See Also:
    
    Constant Field Values
  - GET_RANGE_DEFAULT_LIMIT
```
public static final int GET_RANGE_DEFAULT_LIMIT
```
    The default number of documents requested for get range requests.
    
    See Also:
    
    Constant Field Values
  - GET_RANGE_MAXIMUM_LIMIT
```
public static final int GET_RANGE_MAXIMUM_LIMIT
```
    The maximum number of documents which can be requested for get range requests.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_ATOM_LENGTH
```
public static final int MAXIMUM_ATOM_LENGTH
```
    The maximum length of an atom in bytes (500).
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_PREFIX_LENGTH
```
public static final int MAXIMUM_PREFIX_LENGTH
```
    The maximum length of a prefix field in bytes (500).
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_CURSOR_LENGTH
```
public static final int MAXIMUM_CURSOR_LENGTH
```
    The maximum length of a cursor.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_DATE_VALUE
```
public static final java.util.Date MAXIMUM_DATE_VALUE
```
    The maximum date that can be stored in a date field.
  - MAXIMUM_DOCUMENT_ID_LENGTH
```
public static final int MAXIMUM_DOCUMENT_ID_LENGTH
```
    The maximum length of a document id.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_DOCUMENT_LENGTH
```
public static final int MAXIMUM_DOCUMENT_LENGTH
```
    The maximum length of a document.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_INDEX_NAME_LENGTH
```
public static final int MAXIMUM_INDEX_NAME_LENGTH
```
    The maximum length for an index name.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_NAME_LENGTH
```
public static final int MAXIMUM_NAME_LENGTH
```
    The maximum length of a field or facet name in bytes (500).
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_NEGATIVE_LATITUDE
```
public static final double MAXIMUM_NEGATIVE_LATITUDE
```
    The maximum negative degrees for latitude.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_NEGATIVE_LONGITUDE
```
public static final double MAXIMUM_NEGATIVE_LONGITUDE
```
    The maximum negative degrees for longitude.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_NUMBER_VALUE
```
public static final double MAXIMUM_NUMBER_VALUE
```
    The maximum value that can be stored in a number field (2147483647).
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_POSITIVE_LATITUDE
```
public static final double MAXIMUM_POSITIVE_LATITUDE
```
    The maximum positive degrees for latitude.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_POSITIVE_LONGITUDE
```
public static final double MAXIMUM_POSITIVE_LONGITUDE
```
    The maximum positive degrees for longitude.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_QUERY_LENGTH
```
public static final int MAXIMUM_QUERY_LENGTH
```
    The maximum length of a query string.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_TEXT_LENGTH
```
public static final int MAXIMUM_TEXT_LENGTH
```
    The maximum length of a text or HTML in bytes (1048576).
    
    See Also:
    
    Constant Field Values
  - MINIMUM_DATE_VALUE
```
public static final java.util.Date MINIMUM_DATE_VALUE
```
    The minimum date that can be stored in a date field.
  - MINIMUM_NUMBER_VALUE
```
public static final double MINIMUM_NUMBER_VALUE
```
    The minimum value that can be stored in a number field (-2147483647).
    
    See Also:
    
    Constant Field Values
  - PUT_MAXIMUM_DOCS_PER_REQUEST
```
public static final int PUT_MAXIMUM_DOCS_PER_REQUEST
```
    The maximum number of documents allowed per index and delete request.
    
    See Also:
    
    Constant Field Values
  - SEARCH_DEFAULT_LIMIT
```
public static final int SEARCH_DEFAULT_LIMIT
```
    The default limit on the number of documents to return in results.
    
    See Also:
    
    Constant Field Values
  - SEARCH_DEFAULT_NUMBER_FOUND_ACCURACY
```
public static final int SEARCH_DEFAULT_NUMBER_FOUND_ACCURACY
```
    The default found count accuracy is the limit.
    
    See Also:
    
    Constant Field Values
  - SEARCH_DEFAULT_SORTED_LIMIT
```
public static final int SEARCH_DEFAULT_SORTED_LIMIT
```
    The default number of documents to score.
    
    See Also:
    
    Constant Field Values
  - SEARCH_MAXIMUM_LIMIT
```
public static final int SEARCH_MAXIMUM_LIMIT
```
    The maximum number of documents that can be requested to be returned in search results.
    
    See Also:
    
    Constant Field Values
  - SEARCH_MAXIMUM_NUMBER_FOUND_ACCURACY
```
public static final int SEARCH_MAXIMUM_NUMBER_FOUND_ACCURACY
```
    The maximum number found accuracy that can be requested.
    
    See Also:
    
    Constant Field Values
  - SEARCH_MAXIMUM_NUMBER_OF_FIELDS_TO_RETURN
```
public static final int SEARCH_MAXIMUM_NUMBER_OF_FIELDS_TO_RETURN
```
    The maximum number of names of fields to return in results.
    
    See Also:
    
    Constant Field Values
  - SEARCH_MAXIMUM_OFFSET
```
public static final int SEARCH_MAXIMUM_OFFSET
```
    The maximum offset into all search results to return results from.
    
    See Also:
    
    Constant Field Values
  - SEARCH_MAXIMUM_SORTED_LIMIT
```
public static final int SEARCH_MAXIMUM_SORTED_LIMIT
```
    The maximum number of documents that can be requested to be scored.
    
    See Also:
    
    Constant Field Values
  - FACET_MAXIMUM_DISCOVERY_LIMIT
```
public static final int FACET_MAXIMUM_DISCOVERY_LIMIT
```
    The maximum number of facet discoveries that can be requested.
    
    See Also:
    
    Constant Field Values
  - FACET_DEFAULT_DISCOVERY_LIMIT
```
public static final int FACET_DEFAULT_DISCOVERY_LIMIT
```
    The default value for number of discovered facets.
    
    See Also:
    
    Constant Field Values
  - FACET_MAXIMUM_DEPTH
```
public static final int FACET_MAXIMUM_DEPTH
```
    The maximum number for facet depth option.
    
    See Also:
    
    Constant Field Values
  - FACET_MAXIMUM_VALUE_LIMIT
```
public static final int FACET_MAXIMUM_VALUE_LIMIT
```
    The maximum value for facet value limit option.
    
    See Also:
    
    Constant Field Values
  - FACET_MAXIMUM_CONSTRAINTS
```
public static final int FACET_MAXIMUM_CONSTRAINTS
```
    The maximum number of facet value constraint can be requested.
    
    See Also:
    
    Constant Field Values
  - FACET_MAXIMUM_RANGES
```
public static final int FACET_MAXIMUM_RANGES
```
    The maximum number of facet ranges can be requested.
    
    See Also:
    
    Constant Field Values
  - VECTOR_FIELD_MAX_SIZE
```
public static final int VECTOR_FIELD_MAX_SIZE
```
    The maximum size of a vector field.
    
    See Also:
    
    Constant Field Values

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-02-15 UTC.

SearchApiLimits (Google App Engine API for Java)

Class SearchApiLimits

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIELD_NAME_PATTERN

GET_INDEXES_DEFAULT_LIMIT

GET_INDEXES_MAXIMUM_LIMIT

GET_INDEXES_MAXIMUM_OFFSET

GET_RANGE_DEFAULT_LIMIT

GET_RANGE_MAXIMUM_LIMIT

MAXIMUM_ATOM_LENGTH

MAXIMUM_PREFIX_LENGTH

MAXIMUM_CURSOR_LENGTH

MAXIMUM_DATE_VALUE

MAXIMUM_DOCUMENT_ID_LENGTH

MAXIMUM_DOCUMENT_LENGTH

MAXIMUM_INDEX_NAME_LENGTH

MAXIMUM_NAME_LENGTH

MAXIMUM_NEGATIVE_LATITUDE

MAXIMUM_NEGATIVE_LONGITUDE

MAXIMUM_NUMBER_VALUE

MAXIMUM_POSITIVE_LATITUDE

MAXIMUM_POSITIVE_LONGITUDE

MAXIMUM_QUERY_LENGTH

MAXIMUM_TEXT_LENGTH

MINIMUM_DATE_VALUE

MINIMUM_NUMBER_VALUE

PUT_MAXIMUM_DOCS_PER_REQUEST

SEARCH_DEFAULT_LIMIT

SEARCH_DEFAULT_NUMBER_FOUND_ACCURACY

SEARCH_DEFAULT_SORTED_LIMIT

SEARCH_MAXIMUM_LIMIT

SEARCH_MAXIMUM_NUMBER_FOUND_ACCURACY

SEARCH_MAXIMUM_NUMBER_OF_FIELDS_TO_RETURN

SEARCH_MAXIMUM_OFFSET

SEARCH_MAXIMUM_SORTED_LIMIT

FACET_MAXIMUM_DISCOVERY_LIMIT

FACET_DEFAULT_DISCOVERY_LIMIT

FACET_MAXIMUM_DEPTH

FACET_MAXIMUM_VALUE_LIMIT

FACET_MAXIMUM_CONSTRAINTS

FACET_MAXIMUM_RANGES

VECTOR_FIELD_MAX_SIZE