com.stripe.net

Class RequestOptions.RequestOptionsBuilder

java.lang.Object

com.stripe.net.RequestOptions.RequestOptionsBuilder

Enclosing class:

RequestOptions

public static final class RequestOptions.RequestOptionsBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RequestOptionsBuilder() Constructs a request options builder with the global parameters (API key and client ID) as default values.

Method Summary

Modifier and Type	Method and Description
RequestOptions	build() Constructs a RequestOptions with the specified values.
RequestOptions.RequestOptionsBuilder	clearApiKey()
RequestOptions.RequestOptionsBuilder	clearClientId()
RequestOptions.RequestOptionsBuilder	clearIdempotencyKey()
RequestOptions.RequestOptionsBuilder	clearStripeAccount()
RequestOptions.RequestOptionsBuilder	clearStripeVersionOverride()
java.lang.String	getApiKey()
java.lang.String	getClientId()
int	getConnectTimeout()
java.lang.String	getIdempotencyKey()
int	getMaxNetworkRetries()
int	getReadTimeout()
java.lang.String	getStripeAccount()
java.lang.String	getStripeVersionOverride()
RequestOptions.RequestOptionsBuilder	setApiKey(java.lang.String apiKey)
RequestOptions.RequestOptionsBuilder	setClientId(java.lang.String clientId)
RequestOptions.RequestOptionsBuilder	setConnectTimeout(int timeout) Sets the timeout value that will be used for making new connections to the Stripe API (in milliseconds).
RequestOptions.RequestOptionsBuilder	setIdempotencyKey(java.lang.String idempotencyKey)
RequestOptions.RequestOptionsBuilder	setMaxNetworkRetries(int maxNetworkRetries) Sets the maximum number of times the request will be retried in the event of a failure.
RequestOptions.RequestOptionsBuilder	setReadTimeout(int timeout) Sets the timeout value that will be used when reading data from an established connection to the Stripe API (in milliseconds).
RequestOptions.RequestOptionsBuilder	setStripeAccount(java.lang.String stripeAccount)
RequestOptions.RequestOptionsBuilder	setStripeVersionOverride(java.lang.String stripeVersionOverride) Do not use this except for in API where JSON response is not fully deserialized into explicit Stripe classes, but only passed to other clients as raw data -- essentially making request on behalf of others with their API version.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestOptionsBuilder

public RequestOptionsBuilder()

Constructs a request options builder with the global parameters (API key and client ID) as default values.

Method Detail

getApiKey

public java.lang.String getApiKey()

setApiKey

public RequestOptions.RequestOptionsBuilder setApiKey(java.lang.String apiKey)

clearApiKey

public RequestOptions.RequestOptionsBuilder clearApiKey()

getClientId

public java.lang.String getClientId()

setClientId

public RequestOptions.RequestOptionsBuilder setClientId(java.lang.String clientId)

clearClientId

public RequestOptions.RequestOptionsBuilder clearClientId()

setIdempotencyKey

public RequestOptions.RequestOptionsBuilder setIdempotencyKey(java.lang.String idempotencyKey)

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public RequestOptions.RequestOptionsBuilder setConnectTimeout(int timeout)

Sets the timeout value that will be used for making new connections to the Stripe API (in milliseconds).

Parameters:

timeout - timeout value in milliseconds

getReadTimeout

public int getReadTimeout()

setReadTimeout

public RequestOptions.RequestOptionsBuilder setReadTimeout(int timeout)

Sets the timeout value that will be used when reading data from an established connection to the Stripe API (in milliseconds).

Note that this value should be set conservatively because some API requests can take time and a short timeout increases the likelihood of causing a problem in the backend.

Parameters:

timeout - timeout value in milliseconds

getMaxNetworkRetries

public int getMaxNetworkRetries()

setMaxNetworkRetries

public RequestOptions.RequestOptionsBuilder setMaxNetworkRetries(int maxNetworkRetries)

Sets the maximum number of times the request will be retried in the event of a failure.

Parameters:

maxNetworkRetries - the number of times to retry the request

clearIdempotencyKey

public RequestOptions.RequestOptionsBuilder clearIdempotencyKey()

getIdempotencyKey

public java.lang.String getIdempotencyKey()

getStripeAccount

public java.lang.String getStripeAccount()

setStripeAccount

public RequestOptions.RequestOptionsBuilder setStripeAccount(java.lang.String stripeAccount)

clearStripeAccount

public RequestOptions.RequestOptionsBuilder clearStripeAccount()

getStripeVersionOverride

public java.lang.String getStripeVersionOverride()

setStripeVersionOverride

public RequestOptions.RequestOptionsBuilder setStripeVersionOverride(java.lang.String stripeVersionOverride)

Do not use this except for in API where JSON response is not fully deserialized into explicit Stripe classes, but only passed to other clients as raw data -- essentially making request on behalf of others with their API version. One example is in EphemeralKey.create(Map, RequestOptions). Setting this value in a typical scenario will result in deserialization error as the model classes have schema according to the pinned Stripe.API_VERSION and not the stripeVersionOverride

Parameters:

stripeVersionOverride - stripe version override which belongs to the client to make request on behalf of.

Returns:

option builder

clearStripeVersionOverride

public RequestOptions.RequestOptionsBuilder clearStripeVersionOverride()

build

public RequestOptions build()

Constructs a RequestOptions with the specified values.