com.geotab.api

Interface Api.MultiCallBuilder

Enclosing interface:

Api

public static interface Api.MultiCallBuilder

Method Summary

Modifier and Type	Method and Description
<O extends BaseResponse<T>,T> Supplier<T>	call(AuthenticatedRequest<?> in, Class<O> outT) Deprecated. use callResult(com.geotab.http.request.AuthenticatedRequest<?>, java.lang.Class<T>) instead and specify the result type instead of the response type.
default <E extends Entity> Supplier<Id>	callAdd(Api.EntityDescriptor<E,?> type, E entity) Makes a type-safe Add call.
default Supplier<Id>	callAdd(AuthenticatedParameters in) Makes an Add call.
Supplier<Id>	callAdd(AuthenticatedRequest<?> in) Makes an Add call.
default <E extends Entity,S extends Search> Supplier<List<E>>	callGet(Api.EntityDescriptor<E,S> type, S search) Makes a type-safe Get call.
default <E extends Entity,S extends Search> Supplier<List<E>>	callGet(Api.EntityDescriptor<E,S> type, S search, @Nullable Integer resultLimit) Makes a type-safe Get call.
<T extends Entity> Supplier<List<T>>	callGet(AuthenticatedRequest<?> in, Class<T> outT) Makes a Get call.
default <T extends Entity> Supplier<List<T>>	callGet(SearchParameters<?> in, Class<T> outT) Makes a Get call.
default <E extends Entity> Supplier<List<E>>	callGetAll(Api.EntityDescriptor<E,?> type) Makes a type-safe Get call to query all entities.
default <E extends Entity> Supplier<E>	callGetById(Api.EntityDescriptor<E,?> type, String id) Makes a type-safe Get call to query by ID.
default <E extends Entity,S extends Search> Supplier<Integer>	callGetCountOf(Api.EntityDescriptor<E,S> type, S search) Makes a type-safe GetCountOf API call.
Supplier<Integer>	callGetCountOf(AuthenticatedRequest<?> in) Makes a GetCountOf call.
default Supplier<Integer>	callGetCountOf(SearchParameters<?> in) Makes a GetCountOf call.
default <E extends Entity,S extends Search> Supplier<List<E>>	callGetFeed(Api.EntityDescriptor<E,S> type, S search, @Nullable String fromVersion, @Nullable Integer resultLimit) Makes a GetFeed call.
<T extends Entity> Supplier<FeedResult<T>>	callGetFeed(AuthenticatedRequest<?> in, Class<T> outT) Makes a GetFeed call.
default <T extends Entity> Supplier<FeedResult<T>>	callGetFeed(GetFeedParameters<?> in, Class<T> outT) Makes a GetFeed call.
<P extends AuthenticatedParameters,R> Supplier<R>	callMethod(Api.MethodDescriptor<P,R> method, P in) Makes a web method call.
default <E extends Entity,S extends Search> void	callRemove(Api.EntityDescriptor<E,S> type, E entity) Makes a type-safe Remove call.
default void	callRemove(AuthenticatedParameters in) Makes a Remove call.
void	callRemove(AuthenticatedRequest<?> in) Makes a Remove call.
<T> Supplier<T>	callResult(AuthenticatedRequest<?> in, Class<T> outT) Makes a custom method API call specifying the result type.
<T> Supplier<List<T>>	callResultList(AuthenticatedRequest<?> in, Class<T> outT) Makes a custom method API call specifying the element type of list result type.
default <E extends Entity> void	callSet(Api.EntityDescriptor<E,?> type, E entity) Makes a type-safe Set call.
default void	callSet(AuthenticatedParameters in) Makes a Set call.
void	callSet(AuthenticatedRequest<?> in) Makes a Set call.
void	execute() Execute the multi-call request.
Api.MultiCallBuilder	httpHeaders(Map<String,Object> httpHeaders) Custom Http Headers to be set on the multi-call request.

Method Detail

httpHeaders

Api.MultiCallBuilder httpHeaders(Map<String,Object> httpHeaders)

Custom Http Headers to be set on the multi-call request.

call

<O extends BaseResponse<T>,T> Supplier<T> call(AuthenticatedRequest<?> in,
                                               Class<O> outT)

Deprecated. use callResult(com.geotab.http.request.AuthenticatedRequest<?>, java.lang.Class<T>) instead and specify the result type instead of the response type.

Makes a custom method API call specifying the response type. Always try to use one of the specific method variants (callGet(com.geotab.http.request.AuthenticatedRequest<?>, java.lang.Class<T>), callGetFeed(com.geotab.http.request.AuthenticatedRequest<?>, java.lang.Class<T>), callAdd(com.geotab.http.request.AuthenticatedRequest<?>), call{Method}, etc.) instead. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callResult

<T> Supplier<T> callResult(AuthenticatedRequest<?> in,
                           Class<T> outT)

Makes a custom method API call specifying the result type. Always try to use one of the specific method variants (callGet(com.geotab.http.request.AuthenticatedRequest<?>, java.lang.Class<T>), callGetFeed(com.geotab.http.request.AuthenticatedRequest<?>, java.lang.Class<T>), callAdd(com.geotab.http.request.AuthenticatedRequest<?>), call{Method}, etc.) instead. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callResultList

<T> Supplier<List<T>> callResultList(AuthenticatedRequest<?> in,
                                     Class<T> outT)

Makes a custom method API call specifying the element type of list result type. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callMethod

<P extends AuthenticatedParameters,R> Supplier<R> callMethod(Api.MethodDescriptor<P,R> method,
                                                             P in)

Makes a web method call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callAdd

Supplier<Id> callAdd(AuthenticatedRequest<?> in)

Makes an Add call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callAdd

default Supplier<Id> callAdd(AuthenticatedParameters in)

Makes an Add call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callAdd

default <E extends Entity> Supplier<Id> callAdd(Api.EntityDescriptor<E,?> type,
                                                E entity)

Makes a type-safe Add call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGet

<T extends Entity> Supplier<List<T>> callGet(AuthenticatedRequest<?> in,
                                             Class<T> outT)

Makes a Get call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGet

default <T extends Entity> Supplier<List<T>> callGet(SearchParameters<?> in,
                                                     Class<T> outT)

Makes a Get call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGet

default <E extends Entity,S extends Search> Supplier<List<E>> callGet(Api.EntityDescriptor<E,S> type,
                                                                      @Nullable
                                                                      S search)

Makes a type-safe Get call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGet

default <E extends Entity,S extends Search> Supplier<List<E>> callGet(Api.EntityDescriptor<E,S> type,
                                                                      @Nullable
                                                                      S search,
                                                                      @Nullable
                                                                      @Nullable Integer resultLimit)

Makes a type-safe Get call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGetAll

default <E extends Entity> Supplier<List<E>> callGetAll(Api.EntityDescriptor<E,?> type)

Makes a type-safe Get call to query all entities. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGetById

default <E extends Entity> Supplier<E> callGetById(Api.EntityDescriptor<E,?> type,
                                                   String id)

Makes a type-safe Get call to query by ID. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGetCountOf

Supplier<Integer> callGetCountOf(AuthenticatedRequest<?> in)

Makes a GetCountOf call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGetCountOf

default Supplier<Integer> callGetCountOf(SearchParameters<?> in)

Makes a GetCountOf call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGetCountOf

default <E extends Entity,S extends Search> Supplier<Integer> callGetCountOf(Api.EntityDescriptor<E,S> type,
                                                                             S search)

Makes a type-safe GetCountOf API call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGetFeed

<T extends Entity> Supplier<FeedResult<T>> callGetFeed(AuthenticatedRequest<?> in,
                                                       Class<T> outT)

Makes a GetFeed call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGetFeed

default <T extends Entity> Supplier<FeedResult<T>> callGetFeed(GetFeedParameters<?> in,
                                                               Class<T> outT)

Makes a GetFeed call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callGetFeed

default <E extends Entity,S extends Search> Supplier<List<E>> callGetFeed(Api.EntityDescriptor<E,S> type,
                                                                          S search,
                                                                          @Nullable
                                                                          @Nullable String fromVersion,
                                                                          @Nullable
                                                                          @Nullable Integer resultLimit)

Makes a GetFeed call. The supplier cannot be called before the builder is executed. Once the execution finalizes successfully, the supplier will return the response result.

callSet

void callSet(AuthenticatedRequest<?> in)

Makes a Set call.

callSet

default void callSet(AuthenticatedParameters in)

Makes a Set call.

callSet

default <E extends Entity> void callSet(Api.EntityDescriptor<E,?> type,
                                        E entity)

Makes a type-safe Set call.

callRemove

void callRemove(AuthenticatedRequest<?> in)

Makes a Remove call.

callRemove

default void callRemove(AuthenticatedParameters in)

Makes a Remove call.

callRemove

default <E extends Entity,S extends Search> void callRemove(Api.EntityDescriptor<E,S> type,
                                                            E entity)

Makes a type-safe Remove call.

execute

void execute()

Execute the multi-call request. Once called, suppliers will be ready and the builder won't be usable anymore.