com.plaid.client

Class PlaidClient.Builder

java.lang.Object

com.plaid.client.PlaidClient.Builder

Enclosing class:

PlaidClient

public static class PlaidClient.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_CONNECT_TIMEOUT_SECONDS
static String	DEFAULT_DEVELOPMENT_BASE_URL
static String	DEFAULT_PRODUCTION_BASE_URL
static long	DEFAULT_READ_TIMEOUT_SECONDS
static String	DEFAULT_SANDBOX_BASE_URL

Method Summary

Modifier and Type	Method and Description
PlaidClient.Builder	baseUrl(String baseUrl) Set a custom base API url, if productionBaseUrl() or sandboxBaseUrl() aren't sufficient.
PlaidClient	build() Validate builder parameters, create, and return a new PlaidClient
PlaidClient.Builder	clientIdAndSecret(String clientId, String secret) Set the client ID and secret credentials.
PlaidClient.Builder	developmentBaseUrl() Configure the client to use the default sandbox URL.
PlaidClient.Builder	logLevel(okhttp3.logging.HttpLoggingInterceptor.Level level) Convenience method to set the HTTP client's logging level.
okhttp3.OkHttpClient.Builder	okHttpClientBuilder() Generally, you should not need this!
PlaidClient.Builder	productionBaseUrl() Configure the client to use the default production URL.
PlaidClient.Builder	publicKey(String publicKey) Set the public key credential.
PlaidClient.Builder	sandboxBaseUrl() Configure the client to use the default sandbox URL.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRODUCTION_BASE_URL

public static String DEFAULT_PRODUCTION_BASE_URL

DEFAULT_DEVELOPMENT_BASE_URL

public static String DEFAULT_DEVELOPMENT_BASE_URL

DEFAULT_SANDBOX_BASE_URL

public static String DEFAULT_SANDBOX_BASE_URL

DEFAULT_READ_TIMEOUT_SECONDS

public static long DEFAULT_READ_TIMEOUT_SECONDS

DEFAULT_CONNECT_TIMEOUT_SECONDS

public static long DEFAULT_CONNECT_TIMEOUT_SECONDS

Method Detail

build

public PlaidClient build()

Validate builder parameters, create, and return a new PlaidClient

Returns:

A brand new PlaidClient

okHttpClientBuilder

public okhttp3.OkHttpClient.Builder okHttpClientBuilder()

Generally, you should not need this!

Direct access to the underlying OkHTTP client builder for advanced settings like SSL, proxy, logging, and timeout options if needed.

Returns:

the underlying builder.

logLevel

public PlaidClient.Builder logLevel(okhttp3.logging.HttpLoggingInterceptor.Level level)

Convenience method to set the HTTP client's logging level.

Parameters:

level - Desired logging level.

Returns:

this. To satisfy the builder pattern.

baseUrl

public PlaidClient.Builder baseUrl(String baseUrl)

Set a custom base API url, if productionBaseUrl() or sandboxBaseUrl() aren't sufficient.

Parameters:

baseUrl - The base URL you wish to use.

Returns:

this. To satisfy the builder pattern.

productionBaseUrl

public PlaidClient.Builder productionBaseUrl()

Configure the client to use the default production URL.

Returns:

this. To satisfy the builder pattern.

sandboxBaseUrl

public PlaidClient.Builder sandboxBaseUrl()

Configure the client to use the default sandbox URL.

Returns:

this. To satisfy the builder pattern.

developmentBaseUrl

public PlaidClient.Builder developmentBaseUrl()

Configure the client to use the default sandbox URL.

Returns:

this. To satisfy the builder pattern.

publicKey

public PlaidClient.Builder publicKey(String publicKey)

Set the public key credential. Only required if this client will be used to call API endpoints that need a public key. Can be found in your Account Dashboard. See documentation for details.

Parameters:

publicKey - Your Plaid API Public key.

Returns:

This PlaidClient.Builder to satisfy the builder pattern.

clientIdAndSecret

public PlaidClient.Builder clientIdAndSecret(String clientId,
                                             String secret)

Set the client ID and secret credentials. Most API calls require these, you'll almost always want to set them. Can be found in your Account Dashboard.

Parameters:

clientId - Your Plaid API Client ID

secret - Your Plaid API Secret

Returns:

This PlaidClient.Builder to satisfy the builder pattern.