Package com.targomo.client.api.request

Class TimeRequest

java.lang.Object

com.targomo.client.api.request.TimeRequest

public class TimeRequest
extends Object

Calculates travel times from each source point to each target. Only accepts HttpMethod POST.

Constructor Summary

Constructors

Constructor	Description
TimeRequest(TravelOptions travelOptions)	Use default client implementation with specified options and method Default client uses ClientBuilder.
TimeRequest(javax.ws.rs.client.Client client, TravelOptions travelOptions)	Use a custom client implementation with specified options and method
TimeRequest(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
TimeResponse	get()	Execute request
String	toCurl()	For debugging.

Methods inherited from class java.lang.Object

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

Constructor Details

TimeRequest

public TimeRequest(TravelOptions travelOptions)

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

Parameters:

travelOptions - Options to be used

TimeRequest

public TimeRequest(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

TimeRequest

public TimeRequest(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 - if required, headers can be attached to this request

Method Details

get

public TimeResponse get()
                 throws TargomoClientException,
javax.ws.rs.ProcessingException,
ResponseErrorException

Execute request

Returns:

Time response

Throws:

TargomoClientException - In case of error other than Gateway Timeout

javax.ws.rs.ProcessingException

ResponseErrorException

toCurl

public String toCurl()
              throws TargomoClientException

For debugging.

Returns:

the request as curl String

Throws:

TargomoClientException - when error occurred during parsing of the travel options