|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.google.appengine.api.search.ListDocumentsRequest.Builder
public static final class ListDocumentsRequest.Builder
The builder of ListDocumentsRequests.
| Method Summary | |
|---|---|
ListDocumentsRequest |
build()
|
ListDocumentsRequest.Builder |
setIncludeStartDoc(boolean includeStartDoc)
Sets whether or not to include the document whose ID is specified via the setStartDocId(String) method. |
ListDocumentsRequest.Builder |
setKeysOnly(boolean keysOnly)
Sets whether just documents containing just their key are returned, or whether the complete documents are returned. |
ListDocumentsRequest.Builder |
setLimit(java.lang.Integer limit)
Sets the maximum number of documents to return. |
ListDocumentsRequest.Builder |
setStartDocId(java.lang.String startDocId)
Sets the Id of the first document to return. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public ListDocumentsRequest.Builder setStartDocId(java.lang.String startDocId)
setIncludeStartDoc(boolean) method.
startDocId - the Id of the first document to return
java.lang.IllegalArgumentException - if invalid document Id is givenpublic ListDocumentsRequest.Builder setIncludeStartDoc(boolean includeStartDoc)
setStartDocId(String) method.
includeStartDoc - whether or not to return the start index
public ListDocumentsRequest.Builder setLimit(java.lang.Integer limit)
limit - the maximum number of documents to return
java.lang.IllegalArgumentException - if negative or too large limit is givenpublic ListDocumentsRequest.Builder setKeysOnly(boolean keysOnly)
keysOnly - whether to only return document keys
public ListDocumentsRequest build()
ListDocumentsRequest using values set on this builder
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||