com.amazonaws.mobileconnectors.apigateway

Class ApiClientFactory

java.lang.Object

com.amazonaws.mobileconnectors.apigateway.ApiClientFactory

public class ApiClientFactory
extends Object

Factory to create a client for APIs defined on Amazon API Gateway.

Constructor Summary

Constructors

Constructor and Description
ApiClientFactory()

Method Summary

Modifier and Type	Method and Description
ApiClientFactory	apiKey(String apiKey) Sets the apiKey in header for each call to endpoint.
<T> T	build(Class<T> apiClass) Instantiates a client for the given API.
ApiClientFactory	clientConfiguration(ClientConfiguration clientConfiguration) Specify the client configuration to use with this factory
ApiClientFactory	credentialsProvider(AWSCredentialsProvider provider) Sets the credentials provider, needed if APIs require authentication.
ApiClientFactory	endpoint(String endpoint) Sets the endpoint of the APIs.
ApiClientFactory	region(String region) Sets the region of the endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiClientFactory

public ApiClientFactory()

Method Detail

endpoint

public ApiClientFactory endpoint(String endpoint)

Sets the endpoint of the APIs.

Parameters:

endpoint - endpoint url

Returns:

the factory itself for chaining

apiKey

public ApiClientFactory apiKey(String apiKey)

Sets the apiKey in header for each call to endpoint.

Parameters:

apiKey - to send in header

Returns:

the factory itself for chaining

region

public ApiClientFactory region(String region)

Sets the region of the endpoint. If not set, the region will be deduced from endpoint.

Parameters:

region - a region string

Returns:

the factory itself for chaining

clientConfiguration

public ApiClientFactory clientConfiguration(ClientConfiguration clientConfiguration)

Specify the client configuration to use with this factory

Parameters:

clientConfiguration - Configuration to use

Returns:

the factory itself for chaining

credentialsProvider

public ApiClientFactory credentialsProvider(AWSCredentialsProvider provider)

Sets the credentials provider, needed if APIs require authentication.

Parameters:

provider - an AWS credentials provider

Returns:

the factory itself for chaining

build

public <T> T build(Class<T> apiClass)

Instantiates a client for the given API.

Type Parameters:

T - the api client interface.

Parameters:

apiClass - API class defined in API Gateway.

Returns:

a client for the given API.