com.google.appengine.api.urlfetch

## Class FetchOptions.Builder

- java.lang.Object
- - com.google.appengine.api.urlfetch.FetchOptions.Builder

- Enclosing class:
    FetchOptions

      public static final class FetchOptions.Builder
      extends java.lang.Object

  Contains static creation methods for `FetchOptions`.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static FetchOptions` | `allowTruncate()` Create a `FetchOptions` that allows truncation of the response.
    `static FetchOptions` | `disallowTruncate()` Create a `FetchOptions` that disallows truncation of the response.
    `static FetchOptions` | `doNotFollowRedirects()` Create a `FetchOptions` that does not follow redirects.
    `static FetchOptions` | `doNotValidateCertificate()` Create a `FetchOptions` that does not perform SSL certificate validation.
    `static FetchOptions` | `followRedirects()` Create a `FetchOptions` that follows redirects.
    `static FetchOptions` | `validateCertificate()` Create a `FetchOptions` that performs SSL certificate validation.
    `static FetchOptions` | `withDeadline(double deadline)` Create a `FetchOptions` with the specified deadline.
    `static FetchOptions` | `withDefaults()` Helper method for creating a `FetchOptions` instance with default values.

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### allowTruncate

          public static FetchOptions allowTruncate()

      Create a `FetchOptions` that allows truncation of the response. Shorthand for `FetchOptions.withDefaults().allowTruncate();`. Please read the `FetchOptions` class javadoc for an explanation of how response truncating works.
      Returns:
        The newly created FetchOptions instance.

    - #### disallowTruncate

          public static FetchOptions disallowTruncate()

      Create a `FetchOptions` that disallows truncation of the response. Shorthand for `FetchOptions.withDefaults().disallowTruncate();`. Please read the `FetchOptions` class javadoc for an explanation of how esponse truncating works.
      Returns:
        The newly created FetchOptions instance.

    - #### followRedirects

          public static FetchOptions followRedirects()

      Create a `FetchOptions` that follows redirects. Shorthand for `FetchOptions.withDefaults().followRedirects();`. Please read the `FetchOptions` class javadoc for an explanation of how redirection following works.
      Returns:
        The newly created FetchOptions instance.

    - #### doNotFollowRedirects

          public static FetchOptions doNotFollowRedirects()

      Create a `FetchOptions` that does not follow redirects. Shorthand for `FetchOptions.withDefaults().doNotFollowRedirects();`. Please read the `FetchOptions` class javadoc for an explanation of how redirection following works.
      Returns:
        The newly created FetchOptions instance.

    - #### validateCertificate

          public static FetchOptions validateCertificate()

      Create a `FetchOptions` that performs SSL certificate validation. Shorthand for `FetchOptions.withDefaults().validateCertificate();`. Please read the `FetchOptions` class javadoc for an explanation of how certificate validation works.
      Returns:
        The newly created FetchOptions instance.

    - #### doNotValidateCertificate

          public static FetchOptions doNotValidateCertificate()

      Create a `FetchOptions` that does not perform SSL certificate validation. Shorthand for `FetchOptions.withDefaults().doNotValidateCertificate();`. Please read the `FetchOptions` class javadoc for an explanation of how certificate validation works.
      Returns:
        The newly created FetchOptions instance.

    - #### withDeadline

          public static FetchOptions withDeadline(double deadline)

      Create a `FetchOptions` with the specified deadline. Shorthand for `FetchOptions.withDefaults().setDeadline(deadline);`.
      Returns:
        The newly created FetchOptions instance.

    - #### withDefaults

          public static FetchOptions withDefaults()

      Helper method for creating a `FetchOptions` instance with default values.
      See Also:
        `FetchOptions.DEFAULT_ALLOW_TRUNCATE`, `FetchOptions.DEFAULT_FOLLOW_REDIRECTS`, `FetchOptions.DEFAULT_DEADLINE`