io.apimatic.core

Class HttpRequest.Builder

java.lang.Object

io.apimatic.core.HttpRequest.Builder

Enclosing class:

HttpRequest

public static class HttpRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HttpRequest.Builder	arraySerializationFormat(io.apimatic.coreinterfaces.http.request.ArraySerializationFormat arraySerializationFormat)
HttpRequest.Builder	bodyParam(java.util.function.Consumer<Parameter.Builder> action) To configure the body parameter.
HttpRequest.Builder	bodySerializer(io.apimatic.coreinterfaces.type.functional.Serializer bodySerializer)
io.apimatic.coreinterfaces.http.request.Request	build(GlobalConfiguration coreConfig) Initialise the CoreHttpRequest.
HttpRequest.Builder	copy()
HttpRequest.Builder	formParam(java.util.function.Consumer<Parameter.Builder> action) To configure the form parameter.
HttpRequest.Builder	formParam(Map<String,Object> formParameters) To configure the optional form parameters.
HttpRequest.Builder	headerParam(java.util.function.Consumer<Parameter.Builder> action) To configure the header parameter.
HttpRequest.Builder	httpMethod(io.apimatic.coreinterfaces.http.Method httpMethod) Http Request Method.
HttpRequest.Builder	path(String path) Endpoint route path.
HttpRequest.Builder	queryParam(java.util.function.Consumer<Parameter.Builder> action) To configure the query paramater.
HttpRequest.Builder	queryParam(Map<String,Object> queryParameters) Optional query parameters.
HttpRequest.Builder	server(String server) Base uri server address.
HttpRequest.Builder	templateParam(java.util.function.Consumer<Parameter.Builder> action) To configure the template parameter.
HttpRequest.Builder	updateParameterByJsonPointer(String pointer, java.util.function.UnaryOperator<Object> setter) Update the request parameters using a setter thats called via a JSON pointer.
HttpRequest.Builder	withAuth(java.util.function.Consumer<AuthBuilder> consumer) Setter for Authentication Builder, used for authenticating the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

updateParameterByJsonPointer

public HttpRequest.Builder updateParameterByJsonPointer(String pointer,
                                                        java.util.function.UnaryOperator<Object> setter)

Update the request parameters using a setter thats called via a JSON pointer.

Parameters:

pointer - A JSON pointer pointing to any request field.

setter - A function that takes in an old value and returns a new value.

Returns:

The updated instance of current request builder.

server

public HttpRequest.Builder server(String server)

Base uri server address.

Parameters:

server - the base uri address.

Returns:

Builder.

path

public HttpRequest.Builder path(String path)

Endpoint route path.

Parameters:

path - the endpoint path.

Returns:

Builder.

httpMethod

public HttpRequest.Builder httpMethod(io.apimatic.coreinterfaces.http.Method httpMethod)

Http Request Method.

Parameters:

httpMethod - HttpMethod value for httpMethod.

Returns:

Builder.

withAuth

public HttpRequest.Builder withAuth(java.util.function.Consumer<AuthBuilder> consumer)

Setter for Authentication Builder, used for authenticating the request.

Parameters:

consumer - the builder consumer for authentication.

Returns:

Builder.

queryParam

public HttpRequest.Builder queryParam(Map<String,Object> queryParameters)

Optional query parameters.

Parameters:

queryParameters - the optional query parameter.

Returns:

Builder.

queryParam

public HttpRequest.Builder queryParam(java.util.function.Consumer<Parameter.Builder> action)

To configure the query paramater.

Parameters:

action - the query parameter Consumer.

Returns:

Builder.

templateParam

public HttpRequest.Builder templateParam(java.util.function.Consumer<Parameter.Builder> action)

To configure the template parameter.

Parameters:

action - the template parameter Consumer.

Returns:

Builder.

headerParam

public HttpRequest.Builder headerParam(java.util.function.Consumer<Parameter.Builder> action)

To configure the header parameter.

Parameters:

action - the header parameter Consumer.

Returns:

Builder.

formParam

public HttpRequest.Builder formParam(java.util.function.Consumer<Parameter.Builder> action)

To configure the form parameter.

Parameters:

action - the form parameter Consumer.

Returns:

Builder.

formParam

public HttpRequest.Builder formParam(Map<String,Object> formParameters)

To configure the optional form parameters.

Parameters:

formParameters - the optional form parameter map.

Returns:

Builder.

bodyParam

public HttpRequest.Builder bodyParam(java.util.function.Consumer<Parameter.Builder> action)

To configure the body parameter.

Parameters:

action - the body parameter Consumer.

Returns:

Builder.

bodySerializer

public HttpRequest.Builder bodySerializer(io.apimatic.coreinterfaces.type.functional.Serializer bodySerializer)

Parameters:

bodySerializer - Function value for bodySerializer.

Returns:

Builder.

arraySerializationFormat

public HttpRequest.Builder arraySerializationFormat(io.apimatic.coreinterfaces.http.request.ArraySerializationFormat arraySerializationFormat)

Parameters:

arraySerializationFormat - the serialization format for the array.

Returns:

Builder.

copy

public HttpRequest.Builder copy()

Returns:

A copy of this request builder instance.

build

public io.apimatic.coreinterfaces.http.request.Request build(GlobalConfiguration coreConfig)
                                                      throws IOException

Initialise the CoreHttpRequest.

Parameters:

coreConfig - the configuration for the Http request.

Returns:

Request.

Throws:

IOException - Signals that an I/O exception of some sort has occurred.