com.arangodb.async

Interface ArangoRouteAsync

All Superinterfaces:

ArangoSerializationAccessor

All Known Implementing Classes:

ArangoRouteAsyncImpl

public interface ArangoRouteAsync
extends ArangoSerializationAccessor

Interface for a specific path to be used to perform arbitrary requests.

Author:

Mark Vollmary

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Response>	delete() Performs a DELETE request to the given URL and returns the server response.
CompletableFuture<Response>	get() Performs a GET request to the given URL and returns the server response.
CompletableFuture<Response>	head() Performs a HEAD request to the given URL and returns the server response.
CompletableFuture<Response>	patch() Performs a PATCH request to the given URL and returns the server response.
CompletableFuture<Response>	post() Performs a POST request to the given URL and returns the server response.
CompletableFuture<Response>	put() Performs a PUT request to the given URL and returns the server response.
ArangoRouteAsync	route(String... path) Returns a new ArangoRouteAsync instance for the given path (relative to the current route) that can be used to perform arbitrary requests.
ArangoRouteAsync	withBody(Object body) The response body.
ArangoRouteAsync	withHeader(String key, Object value) Header that should be sent with each request to the route.
ArangoRouteAsync	withQueryParam(String key, Object value) Query parameter that should be sent with each request to the route.

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

route

ArangoRouteAsync route(String... path)

Returns a new ArangoRouteAsync instance for the given path (relative to the current route) that can be used to perform arbitrary requests.

Parameters:

path - The relative URL of the route

Returns:

ArangoRouteAsync

withHeader

ArangoRouteAsync withHeader(String key,
                            Object value)

Header that should be sent with each request to the route.

Parameters:

key - Header key

value - Header value (the toString() method will be called for the value}

Returns:

ArangoRouteAsync

withQueryParam

ArangoRouteAsync withQueryParam(String key,
                                Object value)

Query parameter that should be sent with each request to the route.

Parameters:

key - Query parameter key

value - Query parameter value (the toString() method will be called for the value}

Returns:

ArangoRouteAsync

withBody

ArangoRouteAsync withBody(Object body)

The response body. The body will be serialized to VPackSlice.

Parameters:

body - The response body

Returns:

ArangoRouteAsync

delete

CompletableFuture<Response> delete()

Performs a DELETE request to the given URL and returns the server response.

Returns:

server response

get

CompletableFuture<Response> get()

Performs a GET request to the given URL and returns the server response.

Returns:

server response

head

CompletableFuture<Response> head()

Performs a HEAD request to the given URL and returns the server response.

Returns:

server response

patch

CompletableFuture<Response> patch()

Performs a PATCH request to the given URL and returns the server response.

Returns:

server response

post

CompletableFuture<Response> post()

Performs a POST request to the given URL and returns the server response.

Returns:

server response

put

CompletableFuture<Response> put()

Performs a PUT request to the given URL and returns the server response.

Returns:

server response