com.squareup.square

Class SquareClient.Builder

java.lang.Object

com.squareup.square.SquareClient.Builder

Enclosing class:

SquareClient

public static class SquareClient.Builder
extends Object

Class to build instances of SquareClient.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SquareClient.Builder	accessToken(String accessToken) Credentials setter for BearerAuth.
SquareClient.Builder	additionalHeaders(Headers additionalHeaders) Additional headers to add to each API request.
SquareClient	build() Builds a new SquareClient object using the set fields.
SquareClient.Builder	customUrl(String customUrl) Sets the base URL requests are made to.
SquareClient.Builder	environment(Environment environment) Current API environment.
SquareClient.Builder	httpCallback(HttpCallback httpCallback) HttpCallback.
SquareClient.Builder	httpClientConfig(Consumer<HttpClientConfiguration.Builder> action) Setter for the Builder of httpClientConfiguration, takes in an operation to be performed on the builder instance of HTTP client configuration.
SquareClient.Builder	squareVersion(String squareVersion) Square Connect API versions.
SquareClient.Builder	timeout(long timeout) Deprecated. This method will be removed in a future version. Use httpClientConfig instead.
SquareClient.Builder	userAgentDetail(String userAgentDetail) Additional detail which can be appended with User-Agent header.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

accessToken

public SquareClient.Builder accessToken(String accessToken)

Credentials setter for BearerAuth.

Parameters:

accessToken - String value for accessToken.

Returns:

Builder

environment

public SquareClient.Builder environment(Environment environment)

Current API environment.

Parameters:

environment - The environment for client.

Returns:

Builder

customUrl

public SquareClient.Builder customUrl(String customUrl)

Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`

Parameters:

customUrl - The customUrl for client.

Returns:

Builder

squareVersion

public SquareClient.Builder squareVersion(String squareVersion)

Square Connect API versions.

Parameters:

squareVersion - The squareVersion for client.

Returns:

Builder

additionalHeaders

public SquareClient.Builder additionalHeaders(Headers additionalHeaders)

Additional headers to add to each API request.

Parameters:

additionalHeaders - The additionalHeaders for client.

Returns:

Builder

userAgentDetail

public SquareClient.Builder userAgentDetail(String userAgentDetail)

Additional detail which can be appended with User-Agent header.

Parameters:

userAgentDetail - The userAgentDetail for client.

Returns:

Builder

timeout

@Deprecated
public SquareClient.Builder timeout(long timeout)

Deprecated. This method will be removed in a future version. Use httpClientConfig instead.

The timeout to use for making HTTP requests.

Parameters:

timeout - must be greater then 0.

Returns:

Builder

httpCallback

public SquareClient.Builder httpCallback(HttpCallback httpCallback)

HttpCallback.

Parameters:

httpCallback - Callback to be called before and after the HTTP call.

Returns:

Builder

httpClientConfig

public SquareClient.Builder httpClientConfig(Consumer<HttpClientConfiguration.Builder> action)

Setter for the Builder of httpClientConfiguration, takes in an operation to be performed on the builder instance of HTTP client configuration.

Parameters:

action - Consumer for the builder of httpClientConfiguration.

Returns:

Builder

build

public SquareClient build()

Builds a new SquareClient object using the set fields.

Returns:

SquareClient