Package com.targomo.client.api.request

Class ReachabilityRequest

java.lang.Object

com.targomo.client.api.request.ReachabilityRequest

public class ReachabilityRequest
extends Object

Calculates travel time for each source point to all targets. Only accepts HttpMethod POST.

Constructor Summary

Constructors

Constructor	Description
ReachabilityRequest(TravelOptions travelOptions)	Use default client implementation with specified options and method Default client uses ClientBuilder.
ReachabilityRequest(javax.ws.rs.client.Client client, TravelOptions travelOptions)	Use a custom client implementation with specified options and method
ReachabilityRequest(javax.ws.rs.client.Client client, TravelOptions travelOptions, javax.ws.rs.core.MultivaluedMap<String,Object> headers)	Use a custom client implementation with specified options and method

Method Summary

Modifier and Type	Method	Description
ReachabilityResponse	get()	Execute request
ReachabilityResponse	get(java.util.function.Function<String,String> targetIdMapperFilter)	Execute request If cached targets are used that are shared among multiple statistics it may be necessary to filter the targets and map their ids.

Methods inherited from class java.lang.Object

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

Constructor Details

ReachabilityRequest

public ReachabilityRequest(TravelOptions travelOptions)

Use default client implementation with specified options and method Default client uses ClientBuilder.

Parameters:

travelOptions - Options to be used

ReachabilityRequest

public ReachabilityRequest(javax.ws.rs.client.Client client,
 TravelOptions travelOptions)

Use a custom client implementation with specified options and method

Parameters:

client - Client implementation to be used

travelOptions - Options to be used

ReachabilityRequest

public ReachabilityRequest(javax.ws.rs.client.Client client,
 TravelOptions travelOptions,
 javax.ws.rs.core.MultivaluedMap<String,Object> headers)

Use a custom client implementation with specified options and method

Parameters:

client - Client implementation to be used

travelOptions - Options to be used

headers - List of custom http headers to be used

Method Details

get

public ReachabilityResponse get()
                         throws TargomoClientException,
ResponseErrorException

Execute request

Returns:

Reachability response

Throws:

TargomoClientException - In case of error other than Gateway Timeout

ResponseErrorException

get

public ReachabilityResponse get(java.util.function.Function<String,String> targetIdMapperFilter)
                         throws TargomoClientException,
ResponseErrorException

Execute request If cached targets are used that are shared among multiple statistics it may be necessary to filter the targets and map their ids. To improve performance this can be done while parsing the response by passing a mapper/filter function.

Parameters:

targetIdMapperFilter - a function that maps the target id to a different value or filters targets by returning null.

Returns:

Reachability response

Throws:

TargomoClientException - In case of error other than Gateway Timeout

ResponseErrorException