Package com.stripe.net

Class RawRequestOptions.RawRequestOptionsBuilder

java.lang.Object

com.stripe.net.RequestOptions.RequestOptionsBuilder

com.stripe.net.RawRequestOptions.RawRequestOptionsBuilder

Enclosing class:

RawRequestOptions

public static final class RawRequestOptions.RawRequestOptionsBuilder
extends RequestOptions.RequestOptionsBuilder

Field Summary

Fields inherited from class com.stripe.net.RequestOptions.RequestOptionsBuilder

apiKey, baseUrl, clientId, connectionProxy, connectTimeout, idempotencyKey, maxNetworkRetries, proxyCredential, readTimeout, stripeAccount, stripeVersionOverride

Constructor Summary

Constructors

Constructor	Description
RawRequestOptionsBuilder()	Constructs a raw request options builder with default values.

Method Summary

Modifier and Type	Method	Description
RawRequestOptions	build()	Constructs a RequestOptions with the specified values.
Map<String,String>	getAdditionalHeaders()
RawRequestOptions.ApiMode	getApiMode()
RawRequestOptions.RawRequestOptionsBuilder	setAdditionalHeaders(Map<String,String> additionalHeaders)
RawRequestOptions.RawRequestOptionsBuilder	setApiKey(String apiKey)
RawRequestOptions.RawRequestOptionsBuilder	setApiMode(RawRequestOptions.ApiMode apiMode)
RawRequestOptions.RawRequestOptionsBuilder	setBaseUrl(String baseUrl)
RawRequestOptions.RawRequestOptionsBuilder	setClientId(String clientId)
RawRequestOptions.RawRequestOptionsBuilder	setConnectionProxy(Proxy connectionProxy)
RawRequestOptions.RawRequestOptionsBuilder	setConnectTimeout(int timeout)	Sets the timeout value that will be used for making new connections to the Stripe API (in milliseconds).
RawRequestOptions.RawRequestOptionsBuilder	setIdempotencyKey(String idempotencyKey)
RawRequestOptions.RawRequestOptionsBuilder	setMaxNetworkRetries(int maxNetworkRetries)	Sets the maximum number of times the request will be retried in the event of a failure.
RawRequestOptions.RawRequestOptionsBuilder	setProxyCredential(PasswordAuthentication proxyCredential)
RawRequestOptions.RawRequestOptionsBuilder	setReadTimeout(int timeout)	Sets the timeout value that will be used when reading data from an established connection to the Stripe API (in milliseconds).
RawRequestOptions.RawRequestOptionsBuilder	setStripeAccount(String stripeAccount)

Methods inherited from class com.stripe.net.RequestOptions.RequestOptionsBuilder

clearApiKey, clearClientId, clearIdempotencyKey, clearStripeAccount, getApiKey, getClientId, getConnectionProxy, getConnectTimeout, getIdempotencyKey, getMaxNetworkRetries, getProxyCredential, getReadTimeout, getStripeAccount, unsafeSetStripeVersionOverride

Methods inherited from class java.lang.Object

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

Constructor Details

RawRequestOptionsBuilder

public RawRequestOptionsBuilder()

Constructs a raw request options builder with default values. ApiMode is set to ApiMode.STANDARD by default.

Method Details

getApiMode

public RawRequestOptions.ApiMode getApiMode()

setApiMode

public RawRequestOptions.RawRequestOptionsBuilder setApiMode(RawRequestOptions.ApiMode apiMode)

getAdditionalHeaders

public Map<String,String> getAdditionalHeaders()

setAdditionalHeaders

public RawRequestOptions.RawRequestOptionsBuilder setAdditionalHeaders(Map<String,String> additionalHeaders)

setApiKey

public RawRequestOptions.RawRequestOptionsBuilder setApiKey(String apiKey)

Overrides:

setApiKey in class RequestOptions.RequestOptionsBuilder

setClientId

public RawRequestOptions.RawRequestOptionsBuilder setClientId(String clientId)

Overrides:

setClientId in class RequestOptions.RequestOptionsBuilder

setIdempotencyKey

public RawRequestOptions.RawRequestOptionsBuilder setIdempotencyKey(String idempotencyKey)

Overrides:

setIdempotencyKey in class RequestOptions.RequestOptionsBuilder

setStripeAccount

public RawRequestOptions.RawRequestOptionsBuilder setStripeAccount(String stripeAccount)

Overrides:

setStripeAccount in class RequestOptions.RequestOptionsBuilder

setBaseUrl

public RawRequestOptions.RawRequestOptionsBuilder setBaseUrl(String baseUrl)

Overrides:

setBaseUrl in class RequestOptions.RequestOptionsBuilder

setConnectTimeout

public RawRequestOptions.RawRequestOptionsBuilder setConnectTimeout(int timeout)

Description copied from class: RequestOptions.RequestOptionsBuilder

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

Overrides:

setConnectTimeout in class RequestOptions.RequestOptionsBuilder

Parameters:

timeout - timeout value in milliseconds

setReadTimeout

public RawRequestOptions.RawRequestOptionsBuilder setReadTimeout(int timeout)

Description copied from class: RequestOptions.RequestOptionsBuilder

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.

Overrides:

setReadTimeout in class RequestOptions.RequestOptionsBuilder

Parameters:

timeout - timeout value in milliseconds

setMaxNetworkRetries

public RawRequestOptions.RawRequestOptionsBuilder setMaxNetworkRetries(int maxNetworkRetries)

Description copied from class: RequestOptions.RequestOptionsBuilder

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

Overrides:

setMaxNetworkRetries in class RequestOptions.RequestOptionsBuilder

Parameters:

maxNetworkRetries - the number of times to retry the request

setConnectionProxy

public RawRequestOptions.RawRequestOptionsBuilder setConnectionProxy(Proxy connectionProxy)

Overrides:

setConnectionProxy in class RequestOptions.RequestOptionsBuilder

setProxyCredential

public RawRequestOptions.RawRequestOptionsBuilder setProxyCredential(PasswordAuthentication proxyCredential)

Overrides:

setProxyCredential in class RequestOptions.RequestOptionsBuilder

build

public RawRequestOptions build()

Description copied from class: RequestOptions.RequestOptionsBuilder

Constructs a RequestOptions with the specified values.

Overrides:

build in class RequestOptions.RequestOptionsBuilder