|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.google.appengine.api.urlfetch.FetchOptions
public final class FetchOptions
Allows users to customize the behavior of URLFetchService
operations.
If allowTruncate
is called, URLFetchService
will truncate large responses and return them without error.
If (@link #disallowTruncate} is called,
ResponseTooLargeException
will be thrown if the response is too
large.
If followRedirects
is called the URLFetchService
operation will follow redirects.
If doNotFollowRedirects()
is called the URLFetchService
operation will not follow redirects.
Notes on usage:
The recommended way to instantiate a FetchOptions
object is to
statically import FetchOptions.Builder
.* and invoke a static
creation method followed by an instance mutator (if needed):
import static com.google.appengine.api.urlfetch.FetchOptions.Builder.*; ... URL url = getURLToFetch(); urlFetchService.fetch(new HTTPRequest(url, HTTPMethod.GET, allowTruncate())); urlFetchService.fetch(new HTTPRequest(url, HTTPMethod.GET, allowTruncate().doNotFollowRedirects()));
Nested Class Summary | |
---|---|
static class |
FetchOptions.Builder
Contains static creation methods for FetchOptions . |
Field Summary | |
---|---|
static boolean |
DEFAULT_ALLOW_TRUNCATE
|
static boolean |
DEFAULT_FOLLOW_REDIRECTS
|
Method Summary | |
---|---|
FetchOptions |
allowTruncate()
Enables response truncation. |
FetchOptions |
disallowTruncate()
Disables response truncation. |
FetchOptions |
doNotFollowRedirects()
Disables following of redirects. |
FetchOptions |
followRedirects()
Enables following of redirects. |
FetchOptions |
setDeadline(java.lang.Double deadline)
Sets the deadline, in seconds, for the fetch request. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final boolean DEFAULT_ALLOW_TRUNCATE
public static final boolean DEFAULT_FOLLOW_REDIRECTS
Method Detail |
---|
public FetchOptions allowTruncate()
this
(for chaining)public FetchOptions disallowTruncate()
this
(for chaining)public FetchOptions followRedirects()
this
(for chaining)public FetchOptions setDeadline(java.lang.Double deadline)
this
(for chaining)
java.lang.IllegalArgumentException
- if deadline is not positivepublic FetchOptions doNotFollowRedirects()
this
(for chaining)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |