io.apimatic.core.configurations.http.request

Class EndpointConfiguration

java.lang.Object

io.apimatic.core.configurations.http.request.EndpointConfiguration

All Implemented Interfaces:

io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration

public class EndpointConfiguration
extends Object
implements io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration

The configuration for an endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EndpointConfiguration.Builder

Constructor Summary

Constructors

Constructor and Description
EndpointConfiguration(boolean hasBinary, io.apimatic.coreinterfaces.http.request.configuration.RetryOption retryOption, io.apimatic.coreinterfaces.http.request.ArraySerializationFormat arraySerializationFormat)

Method Summary

Modifier and Type	Method and Description
io.apimatic.coreinterfaces.http.request.ArraySerializationFormat	getArraySerializationFormat() Enumeration for all ArraySerialization formats
io.apimatic.coreinterfaces.http.request.configuration.RetryOption	getRetryOption() Retry options enumeration for HTTP request
boolean	hasBinaryResponse() Endpoint response has the binary response or not.
EndpointConfiguration.Builder	toBuilder() Creates a builder initialized with the values from this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointConfiguration

public EndpointConfiguration(boolean hasBinary,
                             io.apimatic.coreinterfaces.http.request.configuration.RetryOption retryOption,
                             io.apimatic.coreinterfaces.http.request.ArraySerializationFormat arraySerializationFormat)

Parameters:

hasBinary - A boolean variable for binary response.

retryOption - Retry options enumeration for HTTP request.

arraySerializationFormat - Enumeration for all ArraySerialization formats.

Method Detail

getRetryOption

public io.apimatic.coreinterfaces.http.request.configuration.RetryOption getRetryOption()

Retry options enumeration for HTTP request

Specified by:

getRetryOption in interface io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration

Returns:

the option for the retries RetryOption.

hasBinaryResponse

public boolean hasBinaryResponse()

Endpoint response has the binary response or not.

Specified by:

hasBinaryResponse in interface io.apimatic.coreinterfaces.http.request.configuration.CoreEndpointConfiguration

Returns:

the response is binary or not.

getArraySerializationFormat

public io.apimatic.coreinterfaces.http.request.ArraySerializationFormat getArraySerializationFormat()

Enumeration for all ArraySerialization formats

Returns:

the array serialization format.

toBuilder

public EndpointConfiguration.Builder toBuilder()

Creates a builder initialized with the values from this instance.

Returns:

a new EndpointConfiguration.Builder pre-populated with this configuration's values.