Constructor Detail

Method Detail

• body

   final RequestForwardingForwardParams.Builder body(RequestForwardingForwardParams.ForwardRequest body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • method

  • route

  • data

  • params

  • requestHeaders

  • etc.

• method

   final RequestForwardingForwardParams.Builder method(String method)

  The HTTP method for the forwarded request. Valid values include: GET , POST , PUT , DELETE , and PATCH.

• method

   final RequestForwardingForwardParams.Builder method(JsonField<String> method)

  Sets Builder.method to an arbitrary JSON value.

  You should usually call Builder.method with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• route

   final RequestForwardingForwardParams.Builder route(String route)

  The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.

• route

   final RequestForwardingForwardParams.Builder route(JsonField<String> route)

  Sets Builder.route to an arbitrary JSON value.

  You should usually call Builder.route with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• data

   final RequestForwardingForwardParams.Builder data(String data)

  The body for the forwarded request. This value must be specified as either a string or a valid JSON object.

• data

   final RequestForwardingForwardParams.Builder data(Optional<String> data)

  Alias for calling Builder.data with data.orElse(null).

• data

   final RequestForwardingForwardParams.Builder data(JsonField<String> data)

  Sets Builder.data to an arbitrary JSON value.

  You should usually call Builder.data with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• params

   final RequestForwardingForwardParams.Builder params(RequestForwardingForwardParams.Params params)

  The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.

• params

   final RequestForwardingForwardParams.Builder params(Optional<RequestForwardingForwardParams.Params> params)

  Alias for calling Builder.params with params.orElse(null).

• params

   final RequestForwardingForwardParams.Builder params(JsonField<RequestForwardingForwardParams.Params> params)

  Sets Builder.params to an arbitrary JSON value.

  You should usually call Builder.params with a well-typed Params value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• requestHeaders

   final RequestForwardingForwardParams.Builder requestHeaders(RequestForwardingForwardParams.RequestHeaders requestHeaders)

  The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: {"Content-Type": "application/xml", "X-API-Version": "v1" }

• requestHeaders

   final RequestForwardingForwardParams.Builder requestHeaders(Optional<RequestForwardingForwardParams.RequestHeaders> requestHeaders)

  Alias for calling Builder.requestHeaders with requestHeaders.orElse(null).

• requestHeaders

   final RequestForwardingForwardParams.Builder requestHeaders(JsonField<RequestForwardingForwardParams.RequestHeaders> requestHeaders)

  Sets Builder.requestHeaders to an arbitrary JSON value.

  You should usually call Builder.requestHeaders with a well-typed RequestHeaders value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final RequestForwardingForwardParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final RequestForwardingForwardParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final RequestForwardingForwardParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final RequestForwardingForwardParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final RequestForwardingForwardParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final RequestForwardingForwardParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final RequestForwardingForwardParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final RequestForwardingForwardParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final RequestForwardingForwardParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final RequestForwardingForwardParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final RequestForwardingForwardParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final RequestForwardingForwardParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final RequestForwardingForwardParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final RequestForwardingForwardParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final RequestForwardingForwardParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final RequestForwardingForwardParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final RequestForwardingForwardParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final RequestForwardingForwardParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final RequestForwardingForwardParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final RequestForwardingForwardParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final RequestForwardingForwardParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final RequestForwardingForwardParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final RequestForwardingForwardParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final RequestForwardingForwardParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final RequestForwardingForwardParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final RequestForwardingForwardParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final RequestForwardingForwardParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final RequestForwardingForwardParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final RequestForwardingForwardParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final RequestForwardingForwardParams build()

  Returns an immutable instance of RequestForwardingForwardParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .method()
  .route()