A B C D E F G H I K L M N O P Q R S T U V W X Z

A

add(String) - Method in class io.apimatic.core.authentication.AuthBuilder

Registers the authentication key to the builder.

additionalHeaders(HttpHeaders) - Method in class io.apimatic.core.GlobalConfiguration.Builder

Additional headers which you can configure other than endpoints headers.

AdditionalProperties<T> - Class in io.apimatic.core.types

A generic class for managing additional properties in a model.

AdditionalProperties() - Constructor for class io.apimatic.core.types.AdditionalProperties

Default constructor.

AdditionalProperties(Class<?>) - Constructor for class io.apimatic.core.types.AdditionalProperties

Parameterized constructor.

addMetaData(PageWrapper<?, ?>) - Method in class io.apimatic.core.types.pagination.CursorPagination

addMetaData(PageWrapper<?, ?>) - Method in class io.apimatic.core.types.pagination.LinkPagination

addMetaData(PageWrapper<?, ?>) - Method in class io.apimatic.core.types.pagination.OffsetPagination

addMetaData(PageWrapper<?, ?>) - Method in class io.apimatic.core.types.pagination.PagePagination

addMetaData(PageWrapper<?, ?>) - Method in interface io.apimatic.core.types.pagination.PaginationStrategy

and(Consumer<AuthBuilder>) - Method in class io.apimatic.core.authentication.AuthBuilder

Registers the and group for authentication.

And - Class in io.apimatic.core.authentication.multiple

Holds the AND group authentication.

And(List<Authentication>) - Constructor for class io.apimatic.core.authentication.multiple.And

AnyOfValidationException - Exception in io.apimatic.core.types

This is the base class for all exceptions that represent an error response from the server.

AnyOfValidationException(List<String>, JsonNode) - Constructor for exception io.apimatic.core.types.AnyOfValidationException

Initialization constructor.

ApiCall<ResponseType,ExceptionType extends CoreApiException> - Class in io.apimatic.core

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

ApiCall.Builder<ResponseType,ExceptionType extends CoreApiException> - Class in io.apimatic.core

Builder class for the ApiCall class.

apiResponseDeserializer(Deserializer<IntermediateResponseType>) - Method in class io.apimatic.core.ResponseHandler.Builder

Setter for the deserializer.

appendUrlWithQueryParameters(StringBuilder, Map<String, Object>, ArraySerializationFormat) - Static method in class io.apimatic.core.utilities.CoreHelper

Appends the given set of parameters to the given query string.

appendUrlWithTemplateParameters(StringBuilder, Map<String, AbstractMap.SimpleEntry<Object, Boolean>>) - Static method in class io.apimatic.core.utilities.CoreHelper

Replaces template parameters in the given URL.

apply(Request) - Method in class io.apimatic.core.authentication.HeaderAuth

Apply the Header authentication.

apply(Request) - Method in class io.apimatic.core.authentication.multiple.AuthGroup

Applies the authentication on the httpRequest.

apply(Request) - Method in class io.apimatic.core.authentication.multiple.Single

Applies the authentication on the httpRequest.

apply(Request) - Method in class io.apimatic.core.authentication.QueryAuth

Apply the Query authentication.

apply(PaginatedData<?, ?, ?, ?>) - Method in class io.apimatic.core.types.pagination.CursorPagination

apply(PaginatedData<?, ?, ?, ?>) - Method in class io.apimatic.core.types.pagination.LinkPagination

apply(PaginatedData<?, ?, ?, ?>) - Method in class io.apimatic.core.types.pagination.OffsetPagination

apply(PaginatedData<?, ?, ?, ?>) - Method in class io.apimatic.core.types.pagination.PagePagination

apply(PaginatedData<?, ?, ?, ?>) - Method in interface io.apimatic.core.types.pagination.PaginationStrategy

areHeadersProperSubsetOf(Map<String, String>, Map<String, String>, boolean) - Static method in class io.apimatic.core.utilities.TestHelper

Recursively check whether the left headers map is a proper subset of the right headers map.

arraySerializationFormat(ArraySerializationFormat) - Method in class io.apimatic.core.configurations.http.request.EndpointConfiguration.Builder

Setter for the arraySerializationFormat.

arraySerializationFormat(ArraySerializationFormat) - Method in class io.apimatic.core.HttpRequest.Builder

AsyncExecutor - Class in io.apimatic.core.request.async

Executor service for asynchronous HTTP end point call.

AsyncResponseHandler<T,ExceptionType extends CoreApiException> - Interface in io.apimatic.core.request.async

A Handler that handles the response asynchronously.

AuthBuilder - Class in io.apimatic.core.authentication

A builder for authentication.

AuthBuilder() - Constructor for class io.apimatic.core.authentication.AuthBuilder

Default constructor.

AuthCredential - Class in io.apimatic.core.authentication

Handles and validates the Authentication parameters.

AuthCredential(Map<String, String>) - Constructor for class io.apimatic.core.authentication.AuthCredential

authentication(Map<String, Authentication>) - Method in class io.apimatic.core.GlobalConfiguration.Builder

AuthGroup - Class in io.apimatic.core.authentication.multiple

Handles the authentication group i.e.

AuthGroup(List<Authentication>) - Constructor for class io.apimatic.core.authentication.multiple.AuthGroup

AuthValidationException - Exception in io.apimatic.core.exceptions

This is an exception that will be thrown when the auth validation fails.

AuthValidationException(String) - Constructor for exception io.apimatic.core.exceptions.AuthValidationException

Initialization constructor.

B

backOffFactor(int) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

To use in calculation of wait time for next request in case of failure.

base64() - Static method in class io.apimatic.core.security.DigestCodecFactory

Creates a Base64 codec.

base64Url() - Static method in class io.apimatic.core.security.DigestCodecFactory

Creates a Base64Url codec.

BaseModel - Class in io.apimatic.core.types

Base model for all the models.

BaseModel() - Constructor for class io.apimatic.core.types.BaseModel

baseUri(Function<String, String>) - Method in class io.apimatic.core.GlobalConfiguration.Builder

body(boolean) - Method in class io.apimatic.core.logger.configurations.SdkHttpLoggingConfiguration.Builder

Sets whether to log the body.

BODY - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the body of the HTTP request or response.

bodyParam(Consumer<Parameter.Builder>) - Method in class io.apimatic.core.HttpRequest.Builder

To configure the body parameter.

bodySerializer(Serializer) - Method in class io.apimatic.core.HttpRequest.Builder

build() - Method in class io.apimatic.core.ApiCall.Builder

build the ApiCall.

build(Map<String, Authentication>) - Method in class io.apimatic.core.authentication.AuthBuilder

Builds and validates the authentication using registered authentication keys.

build() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

Builds a new HttpClientConfiguration object using the set fields.

build() - Method in class io.apimatic.core.configurations.http.client.CoreProxyConfiguration.Builder

Builds a new CoreProxyConfiguration instance using the set fields.

build() - Method in class io.apimatic.core.configurations.http.request.EndpointConfiguration.Builder

Initialise the EndpointConfiguration.

build() - Method in class io.apimatic.core.GlobalConfiguration.Builder

Builds a new GlobalConfiguration object using the set fields.

build(GlobalConfiguration) - Method in class io.apimatic.core.HttpRequest.Builder

Initialise the CoreHttpRequest.

build() - Method in class io.apimatic.core.logger.configurations.SdkHttpLoggingConfiguration.Builder

Constructs a SdkHttpLoggingConfiguration object with the set values.

build() - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration.Builder

Builds a new LoggingConfiguration object using the set fields.

build() - Method in class io.apimatic.core.logger.configurations.SdkRequestLoggingConfiguration.Builder

Constructs a RequestLoggingConfiguration object with the set values.

build() - Method in class io.apimatic.core.logger.configurations.SdkResponseLoggingConfiguration.Builder

Constructs a ResponseLoggingConfiguration object with the set values.

build() - Method in class io.apimatic.core.Parameter.Builder

this method initiates the Parameter.

build() - Method in class io.apimatic.core.ResponseHandler.Builder

Build the ResponseHandler.

Builder() - Constructor for class io.apimatic.core.ApiCall.Builder

Builder() - Constructor for class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

Default Constructor to initiate builder with default properties.

Builder(String, int) - Constructor for class io.apimatic.core.configurations.http.client.CoreProxyConfiguration.Builder

Creates a new Builder instance with the specified proxy server details.

Builder() - Constructor for class io.apimatic.core.configurations.http.request.EndpointConfiguration.Builder

Builder() - Constructor for class io.apimatic.core.GlobalConfiguration.Builder

Builder() - Constructor for class io.apimatic.core.HttpRequest.Builder

Builder() - Constructor for class io.apimatic.core.logger.configurations.SdkHttpLoggingConfiguration.Builder

Builder() - Constructor for class io.apimatic.core.logger.configurations.SdkLoggingConfiguration.Builder

Builder() - Constructor for class io.apimatic.core.logger.configurations.SdkRequestLoggingConfiguration.Builder

Builder() - Constructor for class io.apimatic.core.logger.configurations.SdkResponseLoggingConfiguration.Builder

Builder() - Constructor for class io.apimatic.core.Parameter.Builder

Builder() - Constructor for class io.apimatic.core.ResponseHandler.Builder

C

callback(Callback) - Method in class io.apimatic.core.GlobalConfiguration.Builder

CheckedSupplier<T,E extends CoreApiException> - Interface in io.apimatic.core.types.pagination

cleanUrl(StringBuilder) - Static method in class io.apimatic.core.utilities.CoreHelper

Validates and processes the given URL.

compatibilityFactory(CompatibilityFactory) - Method in class io.apimatic.core.GlobalConfiguration.Builder

ConsoleLogger - Class in io.apimatic.core.logger

ConsoleLogger() - Constructor for class io.apimatic.core.logger.ConsoleLogger

containsBigDecimalList(List<BigDecimal>, List<BigDecimal>) - Static method in class io.apimatic.core.utilities.TestHelper

Checks actual list against expected list, without considering order of elements and actual.

CONTENT_LENGTH - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the content length of the HTTP response.

CONTENT_LENGTH_HEADER - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the content length header.

CONTENT_TYPE - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the content type of the HTTP response.

CONTENT_TYPE_HEADER - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the content type header.

contextInitializer(ContextInitializer<ResponseType>) - Method in class io.apimatic.core.ResponseHandler.Builder

Setter for the ContextInitializer.

ConversionHelper - Class in io.apimatic.core.utilities

A helper class for converting types of various structures supported in the SDK.

convertStreamToString(InputStream) - Static method in class io.apimatic.core.utilities.TestHelper

Convert an InputStream to a String (utility function).

convertToArray(Object, Function<Object, S>) - Static method in class io.apimatic.core.utilities.ConversionHelper

Converts a list of objects to a list of the specified type.

convertToArrayOfMap(Object, Function<Object, S>) - Static method in class io.apimatic.core.utilities.ConversionHelper

Converts a list of maps to a list of maps with values of the specified type.

convertToMap(Object, Function<Object, S>) - Static method in class io.apimatic.core.utilities.ConversionHelper

Converts a map of objects to a map of the specified type.

convertToMapOfArray(Object, Function<Object, S>) - Static method in class io.apimatic.core.utilities.ConversionHelper

Converts a map of lists to a map with lists of the specified type.

convertToNDimensionalArray(Object, Function<Object, S>, int) - Static method in class io.apimatic.core.utilities.ConversionHelper

Converts an n-dimensional array to a nested list with elements of the specified type.

convertToSimpleType(Object, Function<Object, S>) - Static method in class io.apimatic.core.utilities.ConversionHelper

Converts a single object to the specified type.

copy() - Method in class io.apimatic.core.authentication.AuthBuilder

copy() - Method in class io.apimatic.core.HttpRequest.Builder

copy() - Method in class io.apimatic.core.types.pagination.PaginatedData

CoreApiException - Exception in io.apimatic.core.types

This is the base class for all exceptions that represent an error response from the server.

CoreApiException(String) - Constructor for exception io.apimatic.core.types.CoreApiException

Initialization constructor.

CoreApiException(String, Context) - Constructor for exception io.apimatic.core.types.CoreApiException

Initialization constructor.

CoreHelper - Class in io.apimatic.core.utilities

This is a Helper class with commonly used utilities for the SDK.

CoreHelper() - Constructor for class io.apimatic.core.utilities.CoreHelper

CoreHttpClientConfiguration - Class in io.apimatic.core.configurations.http.client

Class to hold HTTP Client Configuration.

CoreHttpClientConfiguration.Builder - Class in io.apimatic.core.configurations.http.client

Class to build instances of CoreHttpClientConfiguration.

CoreJsonObject - Class in io.apimatic.core.utilities

Wrapper class for JSON object.

CoreJsonObject(JsonNode) - Constructor for class io.apimatic.core.utilities.CoreJsonObject

Initialization constructor.

CoreJsonValue - Class in io.apimatic.core.utilities

Wrapper class for JSON value.

CoreJsonValue(JsonNode) - Constructor for class io.apimatic.core.utilities.CoreJsonValue

Initialization constructor.

CoreProxyConfiguration - Class in io.apimatic.core.configurations.http.client

Represents a proxy configuration with address, port, and optional authentication credentials.

CoreProxyConfiguration.Builder - Class in io.apimatic.core.configurations.http.client

Builder class for constructing CoreProxyConfiguration instances.

create(T) - Static method in interface io.apimatic.core.types.pagination.CheckedSupplier

create(Response, P, List<I>, PaginationStrategy) - Static method in class io.apimatic.core.types.pagination.PageWrapper

Create an instance of PageWrapper with provided page and meta data.

createError(Throwable) - Static method in interface io.apimatic.core.types.pagination.CheckedSupplier

CursorPagination - Class in io.apimatic.core.types.pagination

CursorPagination(String, String) - Constructor for class io.apimatic.core.types.pagination.CursorPagination

D

DateHelper - Class in io.apimatic.core.utilities

This is a utility class for Date operations.

DateHelper() - Constructor for class io.apimatic.core.utilities.DateHelper

DateHelper.SimpleAdapter - Class in io.apimatic.core.utilities

Simple Adapter utility class.

DateHelper.SimpleDateDeserializer - Class in io.apimatic.core.utilities

A class to handle deserialization of date strings to LocalDate objects.

DateHelper.SimpleDateSerializer - Class in io.apimatic.core.utilities

A class to handle serialization of LocalDate objects to date strings.

decode(String) - Method in interface io.apimatic.core.security.DigestCodec

Decodes a string representation back into a byte array.

DEFAULT - Static variable in class io.apimatic.core.ErrorCase

A key for the default errors.

deserialize(JsonNode, TypeReference<T1>, Class<T2>, JsonDeserializer<T2>) - Static method in class io.apimatic.core.utilities.CoreHelper

Json deserialization of the given Json string using a specified JsonDerializer.

deserialize(String, TypeReference<T1>, Class<T2>, JsonDeserializer<T2>) - Static method in class io.apimatic.core.utilities.CoreHelper

Json deserialization of the given Json string using a specified JsonDerializer.

deserialize(String, Class<T>) - Static method in class io.apimatic.core.utilities.CoreHelper

Json deserialization of the given Json string.

deserialize(JsonNode, List<Class<? extends T>>, boolean) - Static method in class io.apimatic.core.utilities.CoreHelper

Strict JSON deserialization of the given JSON string with FAIL_ON_UNKNOWN_PROPERTIES flag as true, used particularly for type combinators.

deserialize(String) - Static method in class io.apimatic.core.utilities.CoreHelper

Json deserialization of the given Json string.

deserialize(String, TypeReference<T>) - Static method in class io.apimatic.core.utilities.CoreHelper

JSON Deserialization of the given json string.

deserialize(JsonNode, TypeReference<T>) - Static method in class io.apimatic.core.utilities.CoreHelper

JSON Deserialization of the given json string with FAIL_ON_UNKNOWN_PROPERTIES flag as true.

deserialize(JsonNode, Class<T>) - Static method in class io.apimatic.core.utilities.CoreHelper

JSON deserialization of the given JsonNode with FAIL_ON_UNKNOWN_PROPERTIES flag as true.

deserialize(JsonParser, DeserializationContext, String, List<Map<String, Class<? extends T>>>, List<Class<? extends T>>, boolean) - Static method in class io.apimatic.core.utilities.CoreHelper

JSON Deserialization from custom deserializer based on given discriminator and registry.

deserialize(JsonParser, DeserializationContext) - Method in class io.apimatic.core.utilities.DateHelper.SimpleDateDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc1123DateTimeDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc8601DateTimeDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.UnixTimestampDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc1123DateTimeDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc8601DateTimeDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.UnixTimestampDeserializer

deserializeArray(String, Class<T[]>) - Static method in class io.apimatic.core.utilities.CoreHelper

JSON Deserialization of the given json string.

deserializeArray(JsonNode, Class<T[]>) - Static method in class io.apimatic.core.utilities.CoreHelper

JSON Deserialization of the given json string with FAIL_ON_UNKNOWN_PROPERTIES flag as true.

deserializeAsObject(String) - Static method in class io.apimatic.core.utilities.CoreHelper

Json deserialization of the given Json string.

deserializer(Deserializer<ResponseType>) - Method in class io.apimatic.core.ResponseHandler.Builder

Setter for the deserializer.

deserializeRfc1123DateTime(String) - Static method in class io.apimatic.core.utilities.XmlLocalDateTimeHelper

Deserialize the RFC 1123 datetime xml string.

deserializeRfc1123DateTime(String) - Static method in class io.apimatic.core.utilities.XmlZonedDateTimeHelper

Deserialize the RFC 1123 zoned date time string.

deserializeRfc8601DateTime(String) - Static method in class io.apimatic.core.utilities.XmlLocalDateTimeHelper

Deserialize the RFC 8601 datetime xml string.

deserializeRfc8601DateTime(String) - Static method in class io.apimatic.core.utilities.XmlZonedDateTimeHelper

Deserialize the RFC 8601 zoned date time string.

deserializeSimpleDate(String) - Static method in class io.apimatic.core.utilities.XMLDateHelper

Deserialize the simple date string.

deserializeUnixTimeStamp(String) - Static method in class io.apimatic.core.utilities.XmlLocalDateTimeHelper

Deserialize the unix time stamp xml string.

deserializeUnixTimeStamp(String) - Static method in class io.apimatic.core.utilities.XmlZonedDateTimeHelper

Deserialize the unix time stamp zoned date time string.

deserializeXml(String, Class<T>) - Static method in class io.apimatic.core.utilities.CoreHelper

XML Deserialization of the given xml string.

deserializeXmlArray(String, Class<T[]>) - Static method in class io.apimatic.core.utilities.CoreHelper

XML Deserialization of the given xml string.

deserializeXmlSimpleTypesArray(String, Class<T>) - Static method in class io.apimatic.core.utilities.CoreHelper

XML Deserialization of the given xml string for simple types.

DigestCodec - Interface in io.apimatic.core.security

Interface for encoding and decoding digest values.

DigestCodecFactory - Class in io.apimatic.core.security

Factory class for creating digest codecs based on encoding type.

Dynamic - Class in io.apimatic.core.types.http.response

Represents dynamic response returned by an API call.

Dynamic(Response) - Constructor for class io.apimatic.core.types.http.response.Dynamic

Instantiate class.

E

encode(byte[]) - Method in interface io.apimatic.core.security.DigestCodec

Encodes a byte array digest into a string representation.

endpointConfiguration(Consumer<EndpointConfiguration.Builder>) - Method in class io.apimatic.core.ApiCall.Builder

EndpointConfiguration - Class in io.apimatic.core.configurations.http.request

The configuration for an endpoint.

EndpointConfiguration(boolean, RetryOption, ArraySerializationFormat) - Constructor for class io.apimatic.core.configurations.http.request.EndpointConfiguration

EndpointConfiguration.Builder - Class in io.apimatic.core.configurations.http.request

EntryList() - Constructor for class io.apimatic.core.utilities.MapAdapter.EntryList

equals(Object) - Method in class io.apimatic.core.types.OptionalNullable

equalsBigDecimalList(List<BigDecimal>, List<BigDecimal>) - Static method in class io.apimatic.core.utilities.TestHelper

Checks actual list against expected list to have same order and count and all corresponding values must be equal.

ErrorCase<ExceptionType extends CoreApiException> - Class in io.apimatic.core

A class is responsible to generate the SDK Exception.

excludeHeaders(String...) - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Excludes specified headers from logging.

excludeHeaders(String...) - Method in class io.apimatic.core.logger.configurations.SdkHttpLoggingConfiguration.Builder

Sets the headers to be excluded from logging.

execute() - Method in class io.apimatic.core.ApiCall

Execute the ApiCall and returns the expected response.

execute(Request) - Method in interface io.apimatic.core.request.async.RequestExecutor

Execute a given Request to get the response back.

executeAsync() - Method in class io.apimatic.core.ApiCall

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

extractData(Object) - Method in class io.apimatic.core.types.OptionalNullable.Serializer

Override this method to extract the required data from given data instance

extractExcludedHeaders(Map<String, String>, List<String>) - Static method in class io.apimatic.core.logger.LoggerUtilities

Extracts headers to log based on exclusion criteria.

extractHeadersToLog(Map<String, String>, List<String>, List<String>) - Static method in class io.apimatic.core.logger.LoggerUtilities

Extracts headers to log based on inclusion and exclusion criteria.

extractIncludedHeaders(Map<String, String>, List<String>) - Static method in class io.apimatic.core.logger.LoggerUtilities

Extracts headers to log based on inclusion criteria.

extractListData(Object) - Method in class io.apimatic.core.types.OptionalNullable.Rfc1123DateTimeSerializer

extractListData(Object) - Method in class io.apimatic.core.types.OptionalNullable.Rfc8601DateTimeSerializer

extractListData(Object) - Method in class io.apimatic.core.types.OptionalNullable.SimpleDateSerializer

extractListData(Object) - Method in class io.apimatic.core.types.OptionalNullable.UnixTimestampSerializer

extractListData(Object) - Method in class io.apimatic.core.types.OptionalNullable.ZonedRfc1123DateTimeSerializer

extractListData(Object) - Method in class io.apimatic.core.types.OptionalNullable.ZonedRfc8601DateTimeSerializer

extractListData(Object) - Method in class io.apimatic.core.types.OptionalNullable.ZonedUnixTimestampSerializer

extractMapData(Object) - Method in class io.apimatic.core.types.OptionalNullable.Rfc1123DateTimeSerializer

extractMapData(Object) - Method in class io.apimatic.core.types.OptionalNullable.Rfc8601DateTimeSerializer

extractMapData(Object) - Method in class io.apimatic.core.types.OptionalNullable.SimpleDateSerializer

extractMapData(Object) - Method in class io.apimatic.core.types.OptionalNullable.UnixTimestampSerializer

extractMapData(Object) - Method in class io.apimatic.core.types.OptionalNullable.ZonedRfc1123DateTimeSerializer

extractMapData(Object) - Method in class io.apimatic.core.types.OptionalNullable.ZonedRfc8601DateTimeSerializer

extractMapData(Object) - Method in class io.apimatic.core.types.OptionalNullable.ZonedUnixTimestampSerializer

extractSimpleData(Object) - Method in class io.apimatic.core.types.OptionalNullable.Rfc1123DateTimeSerializer

extractSimpleData(Object) - Method in class io.apimatic.core.types.OptionalNullable.Rfc8601DateTimeSerializer

extractSimpleData(Object) - Method in class io.apimatic.core.types.OptionalNullable.SimpleDateSerializer

extractSimpleData(Object) - Method in class io.apimatic.core.types.OptionalNullable.UnixTimestampSerializer

extractSimpleData(Object) - Method in class io.apimatic.core.types.OptionalNullable.ZonedRfc1123DateTimeSerializer

extractSimpleData(Object) - Method in class io.apimatic.core.types.OptionalNullable.ZonedRfc8601DateTimeSerializer

extractSimpleData(Object) - Method in class io.apimatic.core.types.OptionalNullable.ZonedUnixTimestampSerializer

F

fetchNextPageAsync() - Method in class io.apimatic.core.types.pagination.PaginatedData

Start fetching the next page asynchronously.

filterSensitiveHeaders(Map<String, String>, List<String>, boolean) - Static method in class io.apimatic.core.logger.LoggerUtilities

Filter sensitive headers from the given list of request headers.

formParam(Consumer<Parameter.Builder>) - Method in class io.apimatic.core.HttpRequest.Builder

To configure the form parameter.

formParam(Map<String, Object>) - Method in class io.apimatic.core.HttpRequest.Builder

To configure the optional form parameters.

fromArray(List<T>) - Static method in class io.apimatic.core.utilities.CoreJsonValue

Initializes JsonValue instance with provided list of values.

fromBoolean(Boolean) - Static method in class io.apimatic.core.utilities.CoreJsonValue

Initializes JsonValue instance with provided value.

fromDouble(Double) - Static method in class io.apimatic.core.utilities.CoreJsonValue

Initializes JsonValue instance with provided value.

fromInteger(Integer) - Static method in class io.apimatic.core.utilities.CoreJsonValue

Initializes JsonValue instance with provided value.

fromJsonString(String) - Static method in class io.apimatic.core.utilities.CoreJsonObject

Initializes JsonObject with provided JSON.

fromLong(Long) - Static method in class io.apimatic.core.utilities.CoreJsonValue

Initializes JsonValue instance with provided value.

fromObject(Object) - Static method in class io.apimatic.core.utilities.CoreJsonValue

Initializes JsonValue instance with provided value.

fromRfc1123DateTime(String) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Parse a datetime string in Rfc1123 format to a DateTime object.

fromRfc1123DateTime(String) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Parse a datetime string in Rfc1123 format to a DateTime object.

fromRfc8601DateTime(String) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Parse a datetime string in Rfc8601(Rfc3339) format to a DateTime object.

fromRfc8601DateTime(String) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Parse a datetime string in Rfc8601(Rfc3339) format to a DateTime object.

fromSimpleDate(String) - Static method in class io.apimatic.core.utilities.DateHelper

Parse a simple date string to a LocalDate object.

fromString(String) - Static method in class io.apimatic.core.utilities.CoreJsonValue

Initializes JsonValue instance with provided value.

fromUnixTimestamp(Long) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Parse a Unix Timestamp to a DateTime object.

fromUnixTimestamp(String) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Parse a Unix Timestamp string to a DateTime object.

fromUnixTimestamp(Long) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Parse a Unix Timestamp to a DateTime object.

fromUnixTimestamp(String) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Parse a Unix Timestamp string to a DateTime object.

G

get() - Method in interface io.apimatic.core.types.pagination.CheckedSupplier

Get the stored instance or throw a stored exception.

getAdditionalHeaders() - Method in class io.apimatic.core.GlobalConfiguration

getAdditionalProperties() - Method in class io.apimatic.core.types.AdditionalProperties

Gets the additional properties.

getAdditionalProperties() - Method in class io.apimatic.core.types.BaseModel

Any GETTER.

getAdditionalProperty(String) - Method in class io.apimatic.core.types.AdditionalProperties

Gets an additional property by key.

getAddress() - Method in class io.apimatic.core.configurations.http.client.CoreProxyConfiguration

getArraySerializationFormat() - Method in class io.apimatic.core.configurations.http.request.EndpointConfiguration

Enumeration for all ArraySerialization formats

getAuthentications() - Method in class io.apimatic.core.GlobalConfiguration

getAuthParams() - Method in class io.apimatic.core.authentication.AuthCredential

Getter for the map of authentication parameters.

getAuthParticipants() - Method in class io.apimatic.core.authentication.multiple.AuthGroup

Getter for the list of participants in this authentication group.

getBackOffFactor() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

To use in calculation of wait time for next request in case of failure.

getBase64EncodedCredentials(String, String) - Static method in class io.apimatic.core.utilities.CoreHelper

Responsible to encode into base64 the username and password

getBaseUri() - Method in class io.apimatic.core.GlobalConfiguration

getByteArray() - Method in class io.apimatic.core.types.http.request.MultipartWrapper

Getter for bytes.

getCompatibilityFactory() - Method in class io.apimatic.core.GlobalConfiguration

getCoreHttpRequest() - Method in class io.apimatic.core.HttpRequest

getCursorInput() - Method in class io.apimatic.core.types.pagination.PageWrapper

Gets the cursor input used for cursor-based pagination.

getEntries() - Method in class io.apimatic.core.utilities.MapAdapter.EntryList

Getter for the element entries.

getErrorMessage() - Method in class io.apimatic.core.authentication.multiple.And

Getter for the error message.

getErrorMessage() - Method in class io.apimatic.core.authentication.multiple.Or

Getter for the error message.

getErrorMessages() - Method in class io.apimatic.core.authentication.multiple.AuthGroup

Getter for the list of error message in this authentication group.

getFile(String) - Static method in class io.apimatic.core.utilities.TestHelper

Downloads a given url and return a path to its local version.

getFileWrapper() - Method in class io.apimatic.core.types.http.request.MultipartFileWrapper

Getter for file wrapper.

getFrom(OptionalNullable<T>) - Static method in class io.apimatic.core.types.OptionalNullable

Extracts the encapsulated value from the given OptionalNullable.

getGlobalHeaders() - Method in class io.apimatic.core.GlobalConfiguration

getHeaders() - Method in class io.apimatic.core.types.http.request.MultipartFileWrapper

Getter for headers.

getHeaders() - Method in class io.apimatic.core.types.http.request.MultipartWrapper

Getter for headers.

getHeaders() - Method in class io.apimatic.core.types.http.response.Dynamic

Get response headers for the HTTP response.

getHeaders() - Method in class io.apimatic.core.types.pagination.PageWrapper

Headers of the http response.

getHeadersToExclude() - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Gets the list of headers to exclude from logging.

getHeadersToInclude() - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Gets the list of headers to include in logging.

getHeadersToLog(HttpLoggingConfiguration, Map<String, String>, boolean) - Static method in class io.apimatic.core.logger.LoggerUtilities

Retrieves the headers to be logged based on the provided logging configuration, headers, and sensitivity masking configuration.

getHeadersToUnmask() - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Retrieves the list of headers to unmask from sensitive headers.

getHttpCallback() - Method in class io.apimatic.core.GlobalConfiguration

getHttpClient() - Method in class io.apimatic.core.GlobalConfiguration

getHttpClientInstance() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

The OkHttpClient instance used to make the HTTP calls.

getHttpContext() - Method in exception io.apimatic.core.types.CoreApiException

The HTTP response body from the API request.

getHttpMethodsToRetry() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

Http methods to retry against.

getHttpStatusCodesToRetry() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

Http status codes to retry against.

getItems() - Method in class io.apimatic.core.types.pagination.PageWrapper

Content of the page.

getItems(Function<CheckedSupplier<I, E>, T>) - Method in class io.apimatic.core.types.pagination.PaginatedData

Get the items in current page converted to type T.

getKey() - Method in class io.apimatic.core.Parameter

Getter for the key.

getLevel() - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration

Getter for level.

getLogger() - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration

Getter for Logger.

getLogger() - Method in class io.apimatic.core.logger.ConsoleLogger

Return instance of Logger

getLogger(LoggingConfiguration) - Static method in class io.apimatic.core.logger.SdkLoggerFactory

Returns an instance of ApiLogger based on the provided ReadonlyLogging configuration.

getLogger() - Method in class io.apimatic.core.logger.Slf4jLogger

Return instance of Logger

getLoggingConfiguration() - Method in class io.apimatic.core.GlobalConfiguration

getMapper() - Static method in class io.apimatic.core.utilities.CoreHelper

Deserialization of Json data.

getMaskSensitiveHeaders() - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration

Getter for mask sensitive header.

getMaximumRetryWaitTime() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

The maximum wait time for overall retrying requests.

getMultipartHeaders() - Method in class io.apimatic.core.Parameter

Getter for the multipartHeaders.

getMultiPartRequest() - Method in class io.apimatic.core.Parameter

Getter for the MultipartRequestType.

getMultipartSerializer() - Method in class io.apimatic.core.Parameter

Getter for the multipartSerializer.

getNextLinkInput() - Method in class io.apimatic.core.types.pagination.PageWrapper

Gets the next link input used for link-based pagination.

getNumberOfRetries() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

The number of retries to make.

getOffsetInput() - Method in class io.apimatic.core.types.pagination.PageWrapper

Gets the offset input used for offset-based pagination.

getPage(Function<CheckedSupplier<P, E>, T>) - Method in class io.apimatic.core.types.pagination.PaginatedData

Get the current page converted to type T.

getPageInput() - Method in class io.apimatic.core.types.pagination.PageWrapper

Gets the page number input used for page-based pagination.

getPageSize() - Method in class io.apimatic.core.types.pagination.PaginatedData

getPassword() - Method in class io.apimatic.core.configurations.http.client.CoreProxyConfiguration

getPort() - Method in class io.apimatic.core.configurations.http.client.CoreProxyConfiguration

getProxyConfiguration() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

Returns the proxy configuration used to route requests through a proxy server.

getQueryParameters(String) - Static method in class io.apimatic.core.utilities.CoreHelper

Extracts query parameters from a given URL into a map.

getQueryParametersFromUrl(String) - Static method in class io.apimatic.core.utilities.CoreHelper

Returns query parameters from url

getRawBody() - Method in class io.apimatic.core.types.http.response.Dynamic

Get the raw stream for the response body.

getRequestBuilder() - Method in class io.apimatic.core.ApiCall

getRequestBuilder() - Method in class io.apimatic.core.types.pagination.PaginatedData

getRequestConfig() - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration

Getter for the RequestLoggingConfiguration.

getResponse() - Method in class io.apimatic.core.ApiCall

getResponse() - Method in class io.apimatic.core.types.pagination.PaginatedData

getResponseCode() - Method in exception io.apimatic.core.types.CoreApiException

The HTTP response code from the API request.

getResponseConfig() - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration

Getter for the ResponseLoggingConfiguration.

getResult() - Method in class io.apimatic.core.types.pagination.PageWrapper

Content of the page.

getRetryInterval() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

To use in calculation of wait time for next request in case of failure.

getRetryOption() - Method in class io.apimatic.core.configurations.http.request.EndpointConfiguration

Retry options enumeration for HTTP request

getStatusCode() - Method in class io.apimatic.core.types.pagination.PageWrapper

HTTP Status code of the api response.

getStoredObject() - Method in class io.apimatic.core.utilities.CoreJsonObject

Getter for stored JSON object.

getStoredObject() - Method in class io.apimatic.core.utilities.CoreJsonValue

Getter for stored JSON object.

getStrictMapper() - Static method in class io.apimatic.core.utilities.CoreHelper

Strict Deserialization of Json data.

getTimeout() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

The timeout in seconds to use for making HTTP requests.

getUserAgent() - Method in class io.apimatic.core.GlobalConfiguration

getUserAgentConfig() - Method in class io.apimatic.core.GlobalConfiguration

getUsername() - Method in class io.apimatic.core.configurations.http.client.CoreProxyConfiguration

getValue() - Method in class io.apimatic.core.Parameter

Getter for the parameter value.

getValue(String) - Method in class io.apimatic.core.types.BaseModel

Provides access to all properties using property name as key.

getValueFromJson(String, String) - Static method in class io.apimatic.core.utilities.CoreHelper

Retrieves a value from a JSON string using a JSON pointer.

globalConfig(GlobalConfiguration) - Method in class io.apimatic.core.ApiCall.Builder

GlobalConfiguration - Class in io.apimatic.core

A class which hold the global configuration properties to make a successful Api Call

GlobalConfiguration.Builder - Class in io.apimatic.core

globalErrorCase(Map<String, ErrorCase<ExceptionType>>) - Method in class io.apimatic.core.ResponseHandler.Builder

Setter for the globalErrorCases.

globalHeader(String, String) - Method in class io.apimatic.core.GlobalConfiguration.Builder

H

handle(Request, Response) - Method in interface io.apimatic.core.request.async.AsyncResponseHandler

Handles the response for an endpoint.

handle(Context, EndpointConfiguration, GlobalConfiguration) - Method in class io.apimatic.core.ResponseHandler

Processes an HttpResponse and returns some value corresponding to that response.

hasBinaryResponse(boolean) - Method in class io.apimatic.core.configurations.http.request.EndpointConfiguration.Builder

Setter for the binary response.

hasBinaryResponse() - Method in class io.apimatic.core.configurations.http.request.EndpointConfiguration

Endpoint response has the binary response or not.

hashCode() - Method in class io.apimatic.core.types.OptionalNullable

HeaderAuth - Class in io.apimatic.core.authentication

HeaderAuth is an implementation of Authentication that supports HTTP authentication through HTTP Headers.

HeaderAuth(Map<String, String>) - Constructor for class io.apimatic.core.authentication.HeaderAuth

headerParam(Consumer<Parameter.Builder>) - Method in class io.apimatic.core.HttpRequest.Builder

To configure the header parameter.

headers(boolean) - Method in class io.apimatic.core.logger.configurations.SdkHttpLoggingConfiguration.Builder

Sets whether to log the headers.

HEADERS - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the headers of the HTTP request or response.

hex() - Static method in class io.apimatic.core.security.DigestCodecFactory

Creates a Hex codec.

HmacSignatureVerifier - Class in io.apimatic.core.security

HMAC-based signature verifier for HTTP requests.

HmacSignatureVerifier(String, String, DigestCodec, Function<Request, byte[]>, String, String) - Constructor for class io.apimatic.core.security.HmacSignatureVerifier

Initializes a new instance of the HmacSignatureVerifier class.

httpClient(HttpClient) - Method in class io.apimatic.core.GlobalConfiguration.Builder

httpClientInstance(OkHttpClient) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

The OkHttpClient instance used to make the HTTP calls.

httpClientInstance(OkHttpClient, boolean) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

The OkHttpClient instance used to make the HTTP calls.

httpMethod(Method) - Method in class io.apimatic.core.HttpRequest.Builder

Http Request Method.

httpMethodsToRetry(Set<Method>) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

Http methods to retry against.

HttpRequest - Class in io.apimatic.core

An HttpRequest instance is built through an HttpRequest builder.

HttpRequest.Builder - Class in io.apimatic.core

httpStatusCodesToRetry(Set<Integer>) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

Http status codes to retry against.

I

includeHeaders(String...) - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Includes specified headers in logging.

includeHeaders(String...) - Method in class io.apimatic.core.logger.configurations.SdkHttpLoggingConfiguration.Builder

Sets the headers to be included in logging.

includeQueryInPath(boolean) - Method in class io.apimatic.core.logger.configurations.SdkRequestLoggingConfiguration.Builder

Sets whether to include query parameters in the request path.

io.apimatic.core - package io.apimatic.core

io.apimatic.core.annotations - package io.apimatic.core.annotations

io.apimatic.core.authentication - package io.apimatic.core.authentication

io.apimatic.core.authentication.multiple - package io.apimatic.core.authentication.multiple

io.apimatic.core.configurations.http.client - package io.apimatic.core.configurations.http.client

io.apimatic.core.configurations.http.request - package io.apimatic.core.configurations.http.request

io.apimatic.core.exceptions - package io.apimatic.core.exceptions

io.apimatic.core.logger - package io.apimatic.core.logger

io.apimatic.core.logger.configurations - package io.apimatic.core.logger.configurations

io.apimatic.core.request.async - package io.apimatic.core.request.async

io.apimatic.core.security - package io.apimatic.core.security

io.apimatic.core.types - package io.apimatic.core.types

io.apimatic.core.types.http.request - package io.apimatic.core.types.http.request

io.apimatic.core.types.http.response - package io.apimatic.core.types.http.response

io.apimatic.core.types.pagination - package io.apimatic.core.types.pagination

io.apimatic.core.utilities - package io.apimatic.core.utilities

isArrayOfArrayOfJsonObjectsProperSubsetOf(String, String, boolean, boolean, boolean) - Static method in class io.apimatic.core.utilities.TestHelper

Check if left array of array of objects is a subset of right array of array of objects.

isArrayOfJsonObjectsProperSubsetOf(String, String, boolean, boolean, boolean) - Static method in class io.apimatic.core.utilities.TestHelper

Check if left array of objects is a subset of right array.

isCursorPagination() - Method in class io.apimatic.core.types.pagination.PageWrapper

isJsonObjectProperSubsetOf(String, String, boolean, boolean, boolean) - Static method in class io.apimatic.core.utilities.TestHelper

Recursively check whether the left JSON object is a proper subset of the right JSON object.

isLinkPagination() - Method in class io.apimatic.core.types.pagination.PageWrapper

isNullOrWhiteSpace(String) - Static method in class io.apimatic.core.utilities.CoreHelper

Validates if the string is null, empty or whitespace.

isNumberPagination() - Method in class io.apimatic.core.types.pagination.PageWrapper

isOffsetPagination() - Method in class io.apimatic.core.types.pagination.PageWrapper

isProperSubsetOf(String, String, boolean, boolean, boolean) - Static method in class io.apimatic.core.utilities.TestHelper

Utility to delegate call to suitable method.

isRequired(boolean) - Method in class io.apimatic.core.Parameter.Builder

Variable determines either we need to validate the parameter.

isSameAsFile(String, InputStream) - Static method in class io.apimatic.core.utilities.TestHelper

Compare the input stream to file byte-by-byte.

isTypeCombinatorDateTimeCase(Object) - Static method in class io.apimatic.core.utilities.CoreHelper

Check either the object has TypeCombinatorDateTimeCase annotation.

isTypeCombinatorStringCase(Object) - Static method in class io.apimatic.core.utilities.CoreHelper

Check either the object has TypeCombinatorStringCase annotation.

items(Function<CheckedSupplier<I, E>, T>) - Method in class io.apimatic.core.types.pagination.PaginatedData

K

key(String) - Method in class io.apimatic.core.Parameter.Builder

Setter for the key.

L

level(Level) - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration.Builder

Set level for logging.

LinkPagination - Class in io.apimatic.core.types.pagination

LinkPagination(String) - Constructor for class io.apimatic.core.types.pagination.LinkPagination

LocalDateTimeHelper - Class in io.apimatic.core.utilities

This is a utility class for LocalDateTime operations.

LocalDateTimeHelper() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper

LocalDateTimeHelper.Rfc1123DateTimeAdapter - Class in io.apimatic.core.utilities

Rfc1123 Date Time adapter utility class.

LocalDateTimeHelper.Rfc1123DateTimeDeserializer - Class in io.apimatic.core.utilities

A class to handle deserialization of DateTime objects to Rfc1123 format strings.

LocalDateTimeHelper.Rfc1123DateTimeSerializer - Class in io.apimatic.core.utilities

A class to handle serialization of Rfc1123 format strings to DateTime objects.

LocalDateTimeHelper.Rfc8601DateTimeAdapter - Class in io.apimatic.core.utilities

Rfc8601 Date Time adapter utility class.

LocalDateTimeHelper.Rfc8601DateTimeDeserializer - Class in io.apimatic.core.utilities

A class to handle deserialization of DateTime objects to Rfc8601(Rfc3339) format strings.

LocalDateTimeHelper.Rfc8601DateTimeSerializer - Class in io.apimatic.core.utilities

A class to handle serialization of Rfc8601(Rfc3339) format strings to DateTime objects.

LocalDateTimeHelper.UnixTimestampAdapter - Class in io.apimatic.core.utilities

UnixTimestamp adapter utility class.

LocalDateTimeHelper.UnixTimestampDeserializer - Class in io.apimatic.core.utilities

A class to handle deserialization of DateTime objects to Unix Timestamps.

LocalDateTimeHelper.UnixTimestampSerializer - Class in io.apimatic.core.utilities

A class to handle serialization of Unix Timestamps to DateTime objects.

localErrorCase(String, ErrorCase<ExceptionType>) - Method in class io.apimatic.core.ResponseHandler.Builder

Setter for the localErrorCase.

log(Level, String, Map<String, Object>) - Method in class io.apimatic.core.logger.ConsoleLogger

Logs a message with the specified logging level, format, and arguments.

log(Level, String, Map<String, Object>) - Method in class io.apimatic.core.logger.Slf4jLogger

Log provided message according to logging level.

logger(Logger) - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration.Builder

Set Logger for logging.

logger(Logger) - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration.Builder

Set Logger wrapper for logging.

LoggerConstants - Class in io.apimatic.core.logger

Class defining constants related to logging.

LoggerUtilities - Class in io.apimatic.core.logger

loggingConfiguration(LoggingConfiguration) - Method in class io.apimatic.core.GlobalConfiguration.Builder

logRequest(Request) - Method in class io.apimatic.core.logger.NullSdkLogger

logRequest(Request) - Method in class io.apimatic.core.logger.SdkLogger

Log requests.

logResponse(Response) - Method in class io.apimatic.core.logger.NullSdkLogger

logResponse(Response) - Method in class io.apimatic.core.logger.SdkLogger

Log Responses.

M

makeHttpCallAsync(RequestSupplier, RequestExecutor, AsyncResponseHandler<ResponseType, ExceptionType>, ApiLogger) - Static method in class io.apimatic.core.request.async.AsyncExecutor

Make an asynchronous HTTP end point call.

MapAdapter - Class in io.apimatic.core.utilities

This is a utility class for XML map marshalling and unmarshalling.

MapAdapter() - Constructor for class io.apimatic.core.utilities.MapAdapter

MapAdapter.EntryList - Class in io.apimatic.core.utilities

Holds the element entries of the map.

marshal(LocalDate) - Method in class io.apimatic.core.utilities.DateHelper.SimpleAdapter

marshal(LocalDateTime) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc1123DateTimeAdapter

marshal(LocalDateTime) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc8601DateTimeAdapter

marshal(LocalDateTime) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.UnixTimestampAdapter

marshal(Map<String, String>) - Method in class io.apimatic.core.utilities.MapAdapter

marshal(ZonedDateTime) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc1123DateTimeAdapter

marshal(ZonedDateTime) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc8601DateTimeAdapter

marshal(ZonedDateTime) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.UnixTimestampAdapter

maskSensitiveHeaders(boolean) - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration.Builder

Set mask sensitive headers flag.

maximumRetryWaitTime(long) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

The maximum wait time for overall retrying requests.

METHOD - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the method of the HTTP request.

MultipartFileWrapper - Class in io.apimatic.core.types.http.request

To wrap file and headers to be sent as part of a multipart request.

MultipartFileWrapper(CoreFileWrapper, HttpHeaders) - Constructor for class io.apimatic.core.types.http.request.MultipartFileWrapper

Initialization constructor.

multipartHeaders(String, String) - Method in class io.apimatic.core.Parameter.Builder

Add the multi part headers for the multi part request.

multiPartRequestType(MutliPartRequestType) - Method in class io.apimatic.core.Parameter.Builder

Setter for the multipPart request type.

multipartSerializer(Serializer) - Method in class io.apimatic.core.Parameter.Builder

Setter for the multipartSerializer.

MultipartWrapper - Class in io.apimatic.core.types.http.request

To wrap byteArray and headers to be sent as part of a multipart request.

MultipartWrapper(String, HttpHeaders) - Constructor for class io.apimatic.core.types.http.request.MultipartWrapper

Initialization constructor.

N

newBuilder() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

Builds a new CoreHttpClientConfiguration.Builder object.

newBuilder() - Method in class io.apimatic.core.configurations.http.client.CoreProxyConfiguration

Creates a new builder initialized with the current configuration's values.

newBuilder() - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration

Builds a new SdkLoggingConfiguration.Builder object.

newBuilder() - Method in class io.apimatic.core.logger.configurations.SdkRequestLoggingConfiguration

Builds a new SdkRequestLoggingConfiguration.Builder object.

newBuilder() - Method in class io.apimatic.core.logger.configurations.SdkResponseLoggingConfiguration

Builds a new SdkResponseLoggingConfiguration.Builder object.

NULL_STRING - Static variable in class io.apimatic.core.utilities.TestHelper

GUID to represent NUll string.

nullableResponseType(boolean) - Method in class io.apimatic.core.ResponseHandler.Builder

Setter for the isNullableResponseType.

nullify404(boolean) - Method in class io.apimatic.core.ResponseHandler.Builder

Setter for the nullify404.

NullSdkLogger - Class in io.apimatic.core.logger

NullSdkLogger() - Constructor for class io.apimatic.core.logger.NullSdkLogger

numberOfRetries(int) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

The number of retries to make.

O

of(T) - Static method in class io.apimatic.core.types.OptionalNullable

Creates an OptionalNullable instance with the provided value.

OffsetPagination - Class in io.apimatic.core.types.pagination

OffsetPagination(String) - Constructor for class io.apimatic.core.types.pagination.OffsetPagination

OneOfValidationException - Exception in io.apimatic.core.types

This is the base class for all exceptions that represent an error response from the server.

OneOfValidationException(String, String, JsonNode) - Constructor for exception io.apimatic.core.types.OneOfValidationException

Initialization constructor.

OneOfValidationException(List<String>, JsonNode) - Constructor for exception io.apimatic.core.types.OneOfValidationException

Initialization constructor.

OptionalNullable<T> - Class in io.apimatic.core.types

Class to encapsulate fields which are Optional as well as Nullable.

OptionalNullable.Rfc1123DateTimeSerializer - Class in io.apimatic.core.types

A class to handle serialization of Rfc1123 format strings to DateTime objects.

OptionalNullable.Rfc8601DateTimeSerializer - Class in io.apimatic.core.types

A class to handle serialization of Rfc8601(Rfc3339) format strings to DateTime objects.

OptionalNullable.Serializer - Class in io.apimatic.core.types

JsonSerializer for the OptionalNullable instance.

OptionalNullable.SimpleDateSerializer - Class in io.apimatic.core.types

A class to handle serialization of LocalDate objects to date strings.

OptionalNullable.UnixTimestampSerializer - Class in io.apimatic.core.types

A class to handle serialization of Unix Timestamps to DateTime objects.

OptionalNullable.ZonedRfc1123DateTimeSerializer - Class in io.apimatic.core.types

A class to handle serialization of Rfc1123 format strings to DateTime objects.

OptionalNullable.ZonedRfc8601DateTimeSerializer - Class in io.apimatic.core.types

A class to handle serialization of Rfc8601(Rfc3339) format strings to DateTime objects.

OptionalNullable.ZonedUnixTimestampSerializer - Class in io.apimatic.core.types

A class to handle serialization of Unix Timestamps to DateTime objects.

or(Consumer<AuthBuilder>) - Method in class io.apimatic.core.authentication.AuthBuilder

Registers the or group for authentication.

Or - Class in io.apimatic.core.authentication.multiple

Handles the OR authentication group.

Or(List<Authentication>) - Constructor for class io.apimatic.core.authentication.multiple.Or

P

PagePagination - Class in io.apimatic.core.types.pagination

PagePagination(String) - Constructor for class io.apimatic.core.types.pagination.PagePagination

pages(Function<CheckedSupplier<P, E>, T>) - Method in class io.apimatic.core.types.pagination.PaginatedData

PageWrapper<I,P> - Class in io.apimatic.core.types.pagination

paginate(Function<PaginatedData<I, P, ResponseType, ExceptionType>, T>, Function<PageWrapper<I, ResponseType>, P>, Function<ResponseType, List<I>>, PaginationStrategy...) - Method in class io.apimatic.core.ApiCall

Prepare this ApiCall for pagination.

PaginatedData<I,P,R,E extends CoreApiException> - Class in io.apimatic.core.types.pagination

PaginatedData(ApiCall<R, E>, Function<PageWrapper<I, R>, P>, Function<R, List<I>>, PaginationStrategy...) - Constructor for class io.apimatic.core.types.pagination.PaginatedData

PaginationStrategy - Interface in io.apimatic.core.types.pagination

Parameter - Class in io.apimatic.core

HTTP parameters consist of a type, a name, and a value.

Parameter.Builder - Class in io.apimatic.core

parse(Class<T>) - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as instance of class cls.

parseAsBoolean() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as boolean.

parseAsByte() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as boolean.

parseAsCharacter() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as character.

parseAsDictionary() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as a map of keys and values.

parseAsDouble() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as double.

parseAsFloat() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as float.

parseAsInteger() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as integer.

parseAsLong() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as long.

parseAsShort() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as short.

parseAsString() - Method in class io.apimatic.core.types.http.response.Dynamic

Parse response as string.

password(String) - Method in class io.apimatic.core.configurations.http.client.CoreProxyConfiguration.Builder

Sets the proxy password for authentication.

path(String) - Method in class io.apimatic.core.HttpRequest.Builder

Endpoint route path.

prepareForComparison(String, TypeReference<T>) - Static method in class io.apimatic.core.utilities.TestHelper

Modify a json String according to a given TypeReference, ensuring that inner fields are dealt with properly.

prepareFormFields(Map<?, ?>, ArraySerializationFormat) - Static method in class io.apimatic.core.utilities.CoreHelper

Prepares Array style form fields from a given array of values.

proxyConfiguration(ProxyConfiguration) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

Sets the proxy configuration to be used for routing requests through a proxy server.

Q

QUERY_PARAMETER - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the query parameters of the HTTP request.

QueryAuth - Class in io.apimatic.core.authentication

QueryAuth is an implementation of Authentication that supports HTTP authentication through Query parameters.

QueryAuth(Map<String, String>) - Constructor for class io.apimatic.core.authentication.QueryAuth

queryParam(Map<String, Object>) - Method in class io.apimatic.core.HttpRequest.Builder

Optional query parameters.

queryParam(Consumer<Parameter.Builder>) - Method in class io.apimatic.core.HttpRequest.Builder

To configure the query paramater.

R

removeNullValues(Map<String, ?>) - Static method in class io.apimatic.core.utilities.CoreHelper

Removes null values from the given map.

removeQueryParametersFromUrl(String) - Static method in class io.apimatic.core.utilities.CoreHelper

Returns Url without query parameters

replaceAll(StringBuilder, String, String) - Static method in class io.apimatic.core.utilities.CoreHelper

Replaces all occurrences of the given string in the string builder.

requestBuilder(Consumer<HttpRequest.Builder>) - Method in class io.apimatic.core.ApiCall.Builder

requestBuilder(HttpRequest.Builder) - Method in class io.apimatic.core.ApiCall.Builder

requestConfig(SdkRequestLoggingConfiguration.Builder) - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration.Builder

Sets the RequestLoggingConfiguration.Builder for the builder.

RequestExecutor - Interface in io.apimatic.core.request.async

A Request executor that executes request and returns the response asynchronously.

RequestSupplier - Interface in io.apimatic.core.request.async

Request Supplier.

resolveResponsePointer(String, Response) - Static method in class io.apimatic.core.utilities.CoreHelper

Resolves a pointer within a JSON response body or headers.

responseClassType(ResponseClassType) - Method in class io.apimatic.core.ResponseHandler.Builder

Setter for the responseClassType.

responseConfig(SdkResponseLoggingConfiguration.Builder) - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration.Builder

Sets the ResponseLoggingConfiguration.Builder for the builder.

responseHandler(Consumer<ResponseHandler.Builder<ResponseType, ExceptionType>>) - Method in class io.apimatic.core.ApiCall.Builder

ResponseHandler<ResponseType,ExceptionType extends CoreApiException> - Class in io.apimatic.core

Handler that encapsulates the process of generating a response object from a Response.

ResponseHandler.Builder<ResponseType,ExceptionType extends CoreApiException> - Class in io.apimatic.core

retryInterval(long) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

To use in calculation of wait time for next request in case of failure.

retryOption(RetryOption) - Method in class io.apimatic.core.configurations.http.request.EndpointConfiguration.Builder

Setter for the RetryOption.

Rfc1123DateTimeAdapter() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc1123DateTimeAdapter

Rfc1123DateTimeAdapter() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc1123DateTimeAdapter

Rfc1123DateTimeDeserializer() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc1123DateTimeDeserializer

Rfc1123DateTimeDeserializer() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc1123DateTimeDeserializer

Rfc1123DateTimeSerializer() - Constructor for class io.apimatic.core.types.OptionalNullable.Rfc1123DateTimeSerializer

Rfc1123DateTimeSerializer() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc1123DateTimeSerializer

Rfc1123DateTimeSerializer() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc1123DateTimeSerializer

Rfc8601DateTimeAdapter() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc8601DateTimeAdapter

Rfc8601DateTimeAdapter() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc8601DateTimeAdapter

Rfc8601DateTimeDeserializer() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc8601DateTimeDeserializer

Rfc8601DateTimeDeserializer() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc8601DateTimeDeserializer

Rfc8601DateTimeSerializer() - Constructor for class io.apimatic.core.types.OptionalNullable.Rfc8601DateTimeSerializer

Rfc8601DateTimeSerializer() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc8601DateTimeSerializer

Rfc8601DateTimeSerializer() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc8601DateTimeSerializer

S

SdkBaseHttpLoggingConfiguration - Class in io.apimatic.core.logger.configurations

Represents base configuration for http logging.

SdkBaseHttpLoggingConfiguration() - Constructor for class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

SdkHttpLoggingConfiguration<T extends SdkHttpLoggingConfiguration<T,B>,B extends SdkHttpLoggingConfiguration.Builder<T,B>> - Class in io.apimatic.core.logger.configurations

Represents configuration for logging requests and responses.

SdkHttpLoggingConfiguration(SdkHttpLoggingConfiguration.Builder<T, B>) - Constructor for class io.apimatic.core.logger.configurations.SdkHttpLoggingConfiguration

Constructs a new SdkHttpLoggingConfiguration instance with default values.

SdkHttpLoggingConfiguration.Builder<T extends SdkHttpLoggingConfiguration<T,B>,B extends SdkHttpLoggingConfiguration.Builder<T,B>> - Class in io.apimatic.core.logger.configurations

Builder class for SdkHttpLoggingConfiguration.

SdkLogger - Class in io.apimatic.core.logger

Class to log the Http api messages.

SdkLogger(LoggingConfiguration) - Constructor for class io.apimatic.core.logger.SdkLogger

Default Constructor.

SdkLoggerFactory - Class in io.apimatic.core.logger

SdkLoggingConfiguration - Class in io.apimatic.core.logger.configurations

To hold logging configuration.

SdkLoggingConfiguration.Builder - Class in io.apimatic.core.logger.configurations

Class to build instances of SdkLoggingConfiguration.

SdkRequestLoggingConfiguration - Class in io.apimatic.core.logger.configurations

Represents options for logging requests.

SdkRequestLoggingConfiguration.Builder - Class in io.apimatic.core.logger.configurations

Builder class for SdkHttpLoggingConfiguration.

SdkResponseLoggingConfiguration - Class in io.apimatic.core.logger.configurations

Represents configuration for logging responses.

SdkResponseLoggingConfiguration.Builder - Class in io.apimatic.core.logger.configurations

Builder class for ResponseLoggingConfiguration.

self() - Method in class io.apimatic.core.logger.configurations.SdkHttpLoggingConfiguration.Builder

self() - Method in class io.apimatic.core.logger.configurations.SdkRequestLoggingConfiguration.Builder

Returns the SdkRequestLoggingConfiguration.Builder

self() - Method in class io.apimatic.core.logger.configurations.SdkResponseLoggingConfiguration.Builder

Returns the SdkResponseLoggingConfiguration.Builder

serialize(OptionalNullable<Object>, JsonGenerator, SerializerProvider) - Method in class io.apimatic.core.types.OptionalNullable.Serializer

serialize(Object) - Static method in class io.apimatic.core.utilities.CoreHelper

Json Serialization of a given object.

serialize(Object, JsonSerializer) - Static method in class io.apimatic.core.utilities.CoreHelper

Json Serialization of a given object using a specified JsonSerializer.

serialize(LocalDate, JsonGenerator, SerializerProvider) - Method in class io.apimatic.core.utilities.DateHelper.SimpleDateSerializer

serialize(LocalDateTime, JsonGenerator, SerializerProvider) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc1123DateTimeSerializer

serialize(LocalDateTime, JsonGenerator, SerializerProvider) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc8601DateTimeSerializer

serialize(LocalDateTime, JsonGenerator, SerializerProvider) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.UnixTimestampSerializer

serialize(ZonedDateTime, JsonGenerator, SerializerProvider) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc1123DateTimeSerializer

serialize(ZonedDateTime, JsonGenerator, SerializerProvider) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc8601DateTimeSerializer

serialize(ZonedDateTime, JsonGenerator, SerializerProvider) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.UnixTimestampSerializer

serializeEnumContainer(Object) - Static method in class io.apimatic.core.utilities.CoreHelper

Json Serialization of an ENUM defined under oneOf/anyOf container.

Serializer() - Constructor for class io.apimatic.core.types.OptionalNullable.Serializer

serializeRfc1123DateTime(LocalDateTime, String) - Static method in class io.apimatic.core.utilities.XmlLocalDateTimeHelper

Serialize the RFC 1123 date time object.

serializeRfc1123DateTime(ZonedDateTime, String) - Static method in class io.apimatic.core.utilities.XmlZonedDateTimeHelper

Serialize the RFC 1123 zoned date time object.

serializeRfc8601DateTime(LocalDateTime, String) - Static method in class io.apimatic.core.utilities.XmlLocalDateTimeHelper

Serialize the RFC 8601 date time object.

serializeRfc8601DateTime(ZonedDateTime, String) - Static method in class io.apimatic.core.utilities.XmlZonedDateTimeHelper

Serialize the RFC 8601 zoned date time object.

serializeSimpleDate(LocalDate, String) - Static method in class io.apimatic.core.utilities.XMLDateHelper

Serialize the simple date.

serializeTypeCombinator(Object) - Static method in class io.apimatic.core.utilities.CoreHelper

Json Serialization of a given container object based on annotation.

serializeUnixTimeStamp(LocalDateTime, String) - Static method in class io.apimatic.core.utilities.XmlLocalDateTimeHelper

Serialize the Unix time stamp object.

serializeUnixTimeStamp(ZonedDateTime, String) - Static method in class io.apimatic.core.utilities.XmlZonedDateTimeHelper

Serialize the Unixtime stamp zoned date time object.

serializeXml(T, String, Class<T>) - Static method in class io.apimatic.core.utilities.CoreHelper

Xml Serialization of a given object.

serializeXmlArray(T[], String, String, Class<T>) - Static method in class io.apimatic.core.utilities.CoreHelper

Xml Serialization of a given object list.

server(String) - Method in class io.apimatic.core.HttpRequest.Builder

Base uri server address.

setAdditionalProperties(String, Object) - Method in class io.apimatic.core.types.BaseModel

Any SETTER.

setAdditionalProperty(String, T) - Method in class io.apimatic.core.types.AdditionalProperties

Sets an additional property.

setAdditionalProperty(String, T, boolean) - Method in class io.apimatic.core.types.AdditionalProperties

Sets an additional property with an option to skip null values.

setCursorInput(String) - Method in class io.apimatic.core.types.pagination.PageWrapper

Sets the cursor input

setLogBody(boolean) - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Sets whether to log the request body.

setLogHeaders(boolean) - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Sets whether to log the request headers.

setNextLinkInput(String) - Method in class io.apimatic.core.types.pagination.PageWrapper

Sets the next link input

setOffsetInput(int) - Method in class io.apimatic.core.types.pagination.PageWrapper

Sets the offset input

setPageInput(int) - Method in class io.apimatic.core.types.pagination.PageWrapper

Sets the page input

setReason(String, ExceptionCreator<ExceptionType>) - Static method in class io.apimatic.core.ErrorCase

Create the errorcase using the error reason and exception creator functional interface which throws the respective exception while throwing.

setTemplate(String, ExceptionCreator<ExceptionType>) - Static method in class io.apimatic.core.ErrorCase

Create the errorcase using the error reason and exception creator functional interface which throws the respective exception while throwing.

setValue(String, Object) - Method in class io.apimatic.core.types.BaseModel

Setter for additional properties.

shouldEncode(boolean) - Method in class io.apimatic.core.Parameter.Builder

Setter for the shouldEncode.

shouldEncode() - Method in class io.apimatic.core.Parameter

Getter for the shouldEncode.

shouldIncludeQueryInPath() - Method in class io.apimatic.core.logger.configurations.SdkRequestLoggingConfiguration

Checks if query parameters are included in the request path.

shouldLogBody() - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Checks if logging of request body is enabled.

shouldLogHeaders() - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Checks if logging of request headers is enabled.

shouldOverrideHttpClientConfigurations() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

Allow the SDK to override HTTP client instance's settings used for features like retries, timeouts etc.

shouldRetryOnTimeout(boolean) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

Whether to retry on request timeout.

shouldRetryOnTimeout() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

Whether to retry on request timeout.

SimpleAdapter() - Constructor for class io.apimatic.core.utilities.DateHelper.SimpleAdapter

SimpleDateDeserializer() - Constructor for class io.apimatic.core.utilities.DateHelper.SimpleDateDeserializer

SimpleDateSerializer() - Constructor for class io.apimatic.core.types.OptionalNullable.SimpleDateSerializer

SimpleDateSerializer() - Constructor for class io.apimatic.core.utilities.DateHelper.SimpleDateSerializer

Single - Class in io.apimatic.core.authentication.multiple

Handles a single authentication scheme.

Single(Authentication) - Constructor for class io.apimatic.core.authentication.multiple.Single

skipSslCertVerification(boolean) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

Whether to prevent SSL cert verification or not.

skipSslCertVerification() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

Allow or prevent skipping SSL certificate verification.

Slf4jLogger - Class in io.apimatic.core.logger

Slf4jLogger(Logger) - Constructor for class io.apimatic.core.logger.Slf4jLogger

Constructs a new Slf4jLogger instance wrapping the provided SLF4J Logger.

STATUS_CODE - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the status code of the HTTP response.

supply() - Method in interface io.apimatic.core.request.async.RequestSupplier

Supplies the Request object.

T

templateParam(Consumer<Parameter.Builder>) - Method in class io.apimatic.core.HttpRequest.Builder

To configure the template parameter.

TestHelper - Class in io.apimatic.core.utilities

Contains utility methods for comparing objects, arrays and files.

throwException(Context) - Method in class io.apimatic.core.ErrorCase

this method throw the configured exception using functional interface.

timeout(long) - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration.Builder

The timeout in seconds to use for making HTTP requests.

toArrayOfMapOfRfc1123DateTime(List<Map<String, LocalDateTime>>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a List of Map of DateTime objects to Rfc1123 formatted strings.

toArrayOfMapOfRfc1123DateTime(List<Map<String, ZonedDateTime>>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a List of Map of DateTime objects to Rfc1123 formatted strings.

toArrayOfMapOfRfc8601DateTime(List<Map<String, LocalDateTime>>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a List of Map of DateTime objects to Rfc8601(Rfc3339) formatted strings.

toArrayOfMapOfRfc8601DateTime(List<Map<String, ZonedDateTime>>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a List of Map of DateTime objects to Rfc8601(Rfc3339) formatted strings.

toArrayOfMapOfSimpleDate(List<Map<String, LocalDate>>) - Static method in class io.apimatic.core.utilities.DateHelper

Convert a List of Map of LocalDate objects to strings.

toArrayOfMapOfUnixTimestamp(List<Map<String, LocalDateTime>>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a List of Map of DateTime objects to Unix Timestamp strings.

toArrayOfMapOfUnixTimestamp(List<Map<String, ZonedDateTime>>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a List of Map of DateTime objects to Unix Timestamp strings.

toArrayOfMapOfUnixTimestampLong(List<Map<String, LocalDateTime>>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a List of Map of DateTime objects to Unix Timestamp Longs.

toArrayOfMapOfUnixTimestampLong(List<Map<String, ZonedDateTime>>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a List of Map of DateTime objects to Unix Timestamp Longs.

toBuilder() - Method in class io.apimatic.core.ApiCall

Converts this ApiCall instance to its builder.

toBuilder() - Method in class io.apimatic.core.configurations.http.request.EndpointConfiguration

Creates a builder initialized with the values from this instance.

toBuilder() - Method in class io.apimatic.core.ResponseHandler

Converts this ResponseHandler to its builder.

toRfc1123DateTime(LocalDateTime) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a DateTime object to a Rfc1123 formatted string.

toRfc1123DateTime(List<LocalDateTime>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a List of DateTime objects to Rfc1123 formatted strings.

toRfc1123DateTime(Map<String, LocalDateTime>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a Map of DateTime objects to Rfc1123 formatted strings.

toRfc1123DateTime(ZonedDateTime) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a DateTime object to a Rfc1123 formatted string.

toRfc1123DateTime(List<ZonedDateTime>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a List of DateTime objects to Rfc1123 formatted strings.

toRfc1123DateTime(Map<String, ZonedDateTime>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a Map of DateTime objects to Rfc1123 formatted strings.

toRfc8601DateTime(LocalDateTime) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a DateTime object to a Rfc8601(Rfc3339) formatted string.

toRfc8601DateTime(List<LocalDateTime>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a List of DateTime objects to Rfc8601(Rfc3339) formatted strings.

toRfc8601DateTime(Map<String, LocalDateTime>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a Map of DateTime objects to Rfc8601(Rfc3339) formatted strings.

toRfc8601DateTime(ZonedDateTime) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a DateTime object to a Rfc8601(Rfc3339) formatted string.

toRfc8601DateTime(List<ZonedDateTime>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a List of DateTime objects to Rfc8601(Rfc3339) formatted strings.

toRfc8601DateTime(Map<String, ZonedDateTime>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a Map of DateTime objects to Rfc8601(Rfc3339) formatted strings.

toSimpleDate(LocalDate) - Static method in class io.apimatic.core.utilities.DateHelper

Convert a LocalDate object to a string.

toSimpleDate(List<LocalDate>) - Static method in class io.apimatic.core.utilities.DateHelper

Convert a List of LocalDate objects to strings.

toSimpleDate(Map<String, LocalDate>) - Static method in class io.apimatic.core.utilities.DateHelper

Convert a Map of LocalDate objects to strings.

toString() - Method in class io.apimatic.core.configurations.http.client.CoreHttpClientConfiguration

Converts this HttpClientConfiguration into string format.

toString() - Method in class io.apimatic.core.configurations.http.client.CoreProxyConfiguration

Returns a string representation of this proxy configuration.

toString() - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration

Converts this LoggingConfiguration into string format.

toString() - Method in class io.apimatic.core.logger.configurations.SdkRequestLoggingConfiguration

Converts SdkRequestLoggingConfiguration into string format.

toString() - Method in class io.apimatic.core.logger.configurations.SdkResponseLoggingConfiguration

Converts SdkResponseLoggingConfiguration into string format.

toString() - Method in class io.apimatic.core.types.AdditionalProperties

toString() - Method in class io.apimatic.core.types.OptionalNullable

Converts this OptionalNullable into string format.

toString() - Method in class io.apimatic.core.utilities.CoreJsonObject

Converts the JSON into string.

toString() - Method in class io.apimatic.core.utilities.CoreJsonValue

Converts the JSON into string.

toUnixTimestamp(LocalDateTime) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a DateTime object to a Unix Timestamp string.

toUnixTimestamp(List<LocalDateTime>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a List of DateTime objects to Unix Timestamp strings.

toUnixTimestamp(Map<String, LocalDateTime>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a Map of DateTime objects to Unix Timestamp strings.

toUnixTimestamp(ZonedDateTime) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a DateTime object to a Unix Timestamp string.

toUnixTimestamp(List<ZonedDateTime>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a List of DateTime objects to Unix Timestamp strings.

toUnixTimestamp(Map<String, ZonedDateTime>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a Map of DateTime objects to Unix Timestamp strings.

toUnixTimestampLong(LocalDateTime) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a DateTime object to a Unix Timestamp Long.

toUnixTimestampLong(List<LocalDateTime>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a List of DateTime objects to Unix Timestamp Longs.

toUnixTimestampLong(Map<String, LocalDateTime>) - Static method in class io.apimatic.core.utilities.LocalDateTimeHelper

Convert a Map of DateTime objects to Unix Timestamp Longs.

toUnixTimestampLong(ZonedDateTime) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a DateTime object to a Unix Timestamp Long.

toUnixTimestampLong(List<ZonedDateTime>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a List of DateTime objects to Unix Timestamp Longs.

toUnixTimestampLong(Map<String, ZonedDateTime>) - Static method in class io.apimatic.core.utilities.ZonedDateTimeHelper

Convert a Map of DateTime objects to Unix Timestamp Longs.

tryDeserialize(String, Class<T>) - Static method in class io.apimatic.core.utilities.CoreHelper

Json deserialization of the given Json string.

trySerialize(Object) - Static method in class io.apimatic.core.utilities.CoreHelper

Json Serialization of a given object.

tryUrlDecode(String) - Static method in class io.apimatic.core.utilities.CoreHelper

Tries URL decoding using UTF-8.

tryUrlEncode(String, boolean) - Static method in class io.apimatic.core.utilities.CoreHelper

Tries URL encode using UTF-8.

TypeCombinator - Interface in io.apimatic.core.annotations

This is a container of annotations for oneOf/anyOf cases.

TypeCombinator.FormSerialize - Annotation Type in io.apimatic.core.annotations

TypeCombinator.TypeCombinatorCase - Annotation Type in io.apimatic.core.annotations

TypeCombinator.TypeCombinatorStringCase - Annotation Type in io.apimatic.core.annotations

U

UnixTimestampAdapter() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper.UnixTimestampAdapter

UnixTimestampAdapter() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper.UnixTimestampAdapter

UnixTimestampDeserializer() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper.UnixTimestampDeserializer

UnixTimestampDeserializer() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper.UnixTimestampDeserializer

UnixTimestampSerializer() - Constructor for class io.apimatic.core.types.OptionalNullable.UnixTimestampSerializer

UnixTimestampSerializer() - Constructor for class io.apimatic.core.utilities.LocalDateTimeHelper.UnixTimestampSerializer

UnixTimestampSerializer() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper.UnixTimestampSerializer

unmarshal(String) - Method in class io.apimatic.core.utilities.DateHelper.SimpleAdapter

unmarshal(String) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc1123DateTimeAdapter

unmarshal(String) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.Rfc8601DateTimeAdapter

unmarshal(String) - Method in class io.apimatic.core.utilities.LocalDateTimeHelper.UnixTimestampAdapter

unmarshal(MapAdapter.EntryList) - Method in class io.apimatic.core.utilities.MapAdapter

unmarshal(String) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc1123DateTimeAdapter

unmarshal(String) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.Rfc8601DateTimeAdapter

unmarshal(String) - Method in class io.apimatic.core.utilities.ZonedDateTimeHelper.UnixTimestampAdapter

unmaskHeaders(String...) - Method in class io.apimatic.core.logger.configurations.SdkBaseHttpLoggingConfiguration

Unmask specified headers from logging.

unmaskHeaders(String...) - Method in class io.apimatic.core.logger.configurations.SdkHttpLoggingConfiguration.Builder

Sets the headers to be unmasked in logging.

updateParameterByJsonPointer(String, UnaryOperator<Object>) - Method in class io.apimatic.core.HttpRequest.Builder

Update the request parameters using a setter thats called via a JSON pointer.

updateUserAgent(String, Map<String, String>) - Static method in class io.apimatic.core.utilities.CoreHelper

Updates the user agent header value.

updateValueByPointer(T, String, UnaryOperator<Object>) - Static method in class io.apimatic.core.utilities.CoreHelper

Updates the value of an object by a JSON pointer using the provided updater function.

URL - Static variable in class io.apimatic.core.logger.LoggerConstants

Key representing the URL of the HTTP request.

useDefaultLogger() - Method in class io.apimatic.core.logger.configurations.SdkLoggingConfiguration.Builder

Sets the logger instance to ConsoleLogger.

userAgent(String) - Method in class io.apimatic.core.GlobalConfiguration.Builder

userAgentConfig(Map<String, String>) - Method in class io.apimatic.core.GlobalConfiguration.Builder

username(String) - Method in class io.apimatic.core.configurations.http.client.CoreProxyConfiguration.Builder

Sets the proxy username for authentication.

V

validate() - Method in class io.apimatic.core.authentication.AuthCredential

Validates the credentials for authentication.

validate() - Method in class io.apimatic.core.authentication.multiple.And

Validates the OR group authentication.

validate() - Method in class io.apimatic.core.authentication.multiple.Or

Validates the AND group authentication.

validate() - Method in class io.apimatic.core.authentication.multiple.Single

Validates the single/leaf authentication.

validate() - Method in class io.apimatic.core.Parameter

Validate the parameter fields.

value(Object) - Method in class io.apimatic.core.Parameter.Builder

Setter for the value.

verifyAsync(Request) - Method in class io.apimatic.core.security.HmacSignatureVerifier

Verifies the HMAC signature of the specified HTTP request.

W

withAuth(Consumer<AuthBuilder>) - Method in class io.apimatic.core.HttpRequest.Builder

Setter for Authentication Builder, used for authenticating the request.

X

XMLDateHelper - Class in io.apimatic.core.utilities

This is a utility class for XML LocalDate operations.

XMLDateHelper() - Constructor for class io.apimatic.core.utilities.XMLDateHelper

XmlLocalDateTimeHelper - Class in io.apimatic.core.utilities

This is a utility class for XML LocalDateTime operations.

XmlLocalDateTimeHelper() - Constructor for class io.apimatic.core.utilities.XmlLocalDateTimeHelper

XmlZonedDateTimeHelper - Class in io.apimatic.core.utilities

This is a utility class for XML ZonedDateTime operations.

XmlZonedDateTimeHelper() - Constructor for class io.apimatic.core.utilities.XmlZonedDateTimeHelper

Z

ZonedDateTimeHelper - Class in io.apimatic.core.utilities

This is a utility class for ZonedDateTime operations.

ZonedDateTimeHelper() - Constructor for class io.apimatic.core.utilities.ZonedDateTimeHelper

ZonedDateTimeHelper.Rfc1123DateTimeAdapter - Class in io.apimatic.core.utilities

Rfc1123 Date Time adapter utility class.

ZonedDateTimeHelper.Rfc1123DateTimeDeserializer - Class in io.apimatic.core.utilities

A class to handle deserialization of DateTime objects to Rfc1123 format strings.

ZonedDateTimeHelper.Rfc1123DateTimeSerializer - Class in io.apimatic.core.utilities

A class to handle serialization of Rfc1123 format strings to DateTime objects.

ZonedDateTimeHelper.Rfc8601DateTimeAdapter - Class in io.apimatic.core.utilities

Rfc8601 Date Time adapter utility class.

ZonedDateTimeHelper.Rfc8601DateTimeDeserializer - Class in io.apimatic.core.utilities

A class to handle deserialization of DateTime objects to Rfc8601(Rfc3339) format strings.

ZonedDateTimeHelper.Rfc8601DateTimeSerializer - Class in io.apimatic.core.utilities

A class to handle serialization of Rfc8601(Rfc3339) format strings to DateTime objects.

ZonedDateTimeHelper.UnixTimestampAdapter - Class in io.apimatic.core.utilities

UnixTimestamp adapter utility class.

ZonedDateTimeHelper.UnixTimestampDeserializer - Class in io.apimatic.core.utilities

A class to handle deserialization of DateTime objects to Unix Timestamps.

ZonedDateTimeHelper.UnixTimestampSerializer - Class in io.apimatic.core.utilities

A class to handle serialization of Unix Timestamps to DateTime objects.

ZonedRfc1123DateTimeSerializer() - Constructor for class io.apimatic.core.types.OptionalNullable.ZonedRfc1123DateTimeSerializer

ZonedRfc8601DateTimeSerializer() - Constructor for class io.apimatic.core.types.OptionalNullable.ZonedRfc8601DateTimeSerializer

ZonedUnixTimestampSerializer() - Constructor for class io.apimatic.core.types.OptionalNullable.ZonedUnixTimestampSerializer

A B C D E F G H I K L M N O P Q R S T U V W X Z