io.apimatic.core

Class ApiCall<ResponseType,ExceptionType extends CoreApiException>

java.lang.Object

io.apimatic.core.ApiCall<ResponseType,ExceptionType>

Type Parameters:

ResponseType - resource from server.

ExceptionType - in case of a problem or the connection was aborted.

public final class ApiCall<ResponseType,ExceptionType extends CoreApiException>
extends Object

An API call, or API request, is a message sent to a server asking an API to provide a service or information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiCall.Builder<ResponseType,ExceptionType extends CoreApiException> Builder class for the ApiCall class.

Method Summary

Modifier and Type	Method and Description
ResponseType	execute() Execute the ApiCall and returns the expected response.
CompletableFuture<ResponseType>	executeAsync() Execute the Api call asynchronously and returns the expected response in CompletableFuture.

Methods inherited from class java.lang.Object

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

Method Detail

execute

public ResponseType execute()
                     throws IOException,
                            ExceptionType extends CoreApiException

Execute the ApiCall and returns the expected response.

Returns:

instance of ResponseType.

Throws:

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

ExceptionType - Represents error response from the server.

ExceptionType extends CoreApiException

executeAsync

public CompletableFuture<ResponseType> executeAsync()

Execute the Api call asynchronously and returns the expected response in CompletableFuture.

Returns:

the instance of CompletableFuture.