com.spotify.google.cloud.pubsub.client

Class Pubsub.Builder

java.lang.Object

com.spotify.google.cloud.pubsub.client.Pubsub.Builder

Enclosing class:

Pubsub

public static class Pubsub.Builder
extends Object

A Pubsub.Builder that can be used to build a new Pubsub client.

Method Summary

Modifier and Type	Method and Description
Pubsub.Builder	allowPoolingConnections(boolean allowPoolingConnections) Set whether to allow connection pooling or not.
Pubsub	build() Creates a new Pubsub.
Pubsub.Builder	compressionLevel(int compressionLevel) Set the Gzip compression level to use, 0-9 or -1 for default.
Pubsub.Builder	connectTimeout(int connectTimeout) Set the maximum time in milliseconds the client will can wait when connecting to a remote host.
Pubsub.Builder	credential(com.google.api.client.auth.oauth2.Credential credential) Set Google Cloud API credentials to use.
Pubsub.Builder	enabledCipherSuites(List<String> enabledCipherSuites) Set cipher suites to enable for SSL/TLS.
Pubsub.Builder	enabledCipherSuites(String... enabledCipherSuites) Set cipher suites to enable for SSL/TLS.
Pubsub.Builder	maxConnections(int maxConnections) Set the maximum number of connections client will open.
Pubsub.Builder	pooledConnectionIdleTimeout(int pooledConnectionIdleTimeout) Set the maximum number of milliseconds an idle pooled connection will be be kept.
Pubsub.Builder	pooledConnectionTTL(int pooledConnectionTTL) Set the maximum number of milliseconds a pooled connection will be reused.
Pubsub.Builder	readTimeout(int readTimeout) Set the connection read timeout in milliseconds.
Pubsub.Builder	requestTimeout(int requestTimeout) Set the request timeout in milliseconds.
Pubsub.Builder	uri(URI uri) The Google Cloud Pub/Sub API URI.

Methods inherited from class java.lang.Object

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

Method Detail

build

public Pubsub build()

Creates a new Pubsub.

connectTimeout

public Pubsub.Builder connectTimeout(int connectTimeout)

Set the maximum time in milliseconds the client will can wait when connecting to a remote host.

Parameters:

connectTimeout - the connect timeout in milliseconds.

Returns:

this config builder.

compressionLevel

public Pubsub.Builder compressionLevel(int compressionLevel)

Set the Gzip compression level to use, 0-9 or -1 for default.

Parameters:

compressionLevel - The compression level to use.

Returns:

this config builder.

See Also:

Deflater.setLevel(int), Deflater.DEFAULT_COMPRESSION, Deflater.BEST_COMPRESSION, Deflater.BEST_SPEED

readTimeout

public Pubsub.Builder readTimeout(int readTimeout)

Set the connection read timeout in milliseconds.

Parameters:

readTimeout - the read timeout in milliseconds.

Returns:

this config builder.

requestTimeout

public Pubsub.Builder requestTimeout(int requestTimeout)

Set the request timeout in milliseconds.

Parameters:

requestTimeout - the maximum time in milliseconds.

Returns:

this config builder.

maxConnections

public Pubsub.Builder maxConnections(int maxConnections)

Set the maximum number of connections client will open. Default is unlimited (-1).

Parameters:

maxConnections - the maximum number of connections.

Returns:

this config builder.

pooledConnectionTTL

public Pubsub.Builder pooledConnectionTTL(int pooledConnectionTTL)

Set the maximum number of milliseconds a pooled connection will be reused. -1 for no limit.

Parameters:

pooledConnectionTTL - the maximum time in milliseconds.

Returns:

this config builder.

pooledConnectionIdleTimeout

public Pubsub.Builder pooledConnectionIdleTimeout(int pooledConnectionIdleTimeout)

Set the maximum number of milliseconds an idle pooled connection will be be kept.

Parameters:

pooledConnectionIdleTimeout - the timeout in milliseconds.

Returns:

this config builder.

allowPoolingConnections

public Pubsub.Builder allowPoolingConnections(boolean allowPoolingConnections)

Set whether to allow connection pooling or not. Default is true.

Parameters:

allowPoolingConnections - the maximum number of connections.

Returns:

this config builder.

credential

public Pubsub.Builder credential(com.google.api.client.auth.oauth2.Credential credential)

Set Google Cloud API credentials to use. Set to null to use application default credentials.

Parameters:

credential - the credentials used to authenticate.

enabledCipherSuites

public Pubsub.Builder enabledCipherSuites(String... enabledCipherSuites)

Set cipher suites to enable for SSL/TLS.

Parameters:

enabledCipherSuites - The cipher suites to enable.

enabledCipherSuites

public Pubsub.Builder enabledCipherSuites(List<String> enabledCipherSuites)

Set cipher suites to enable for SSL/TLS.

Parameters:

enabledCipherSuites - The cipher suites to enable.

uri

public Pubsub.Builder uri(URI uri)

The Google Cloud Pub/Sub API URI. By default, this is the Google Cloud Pub/Sub provider, however you may run a local Developer Server.

Parameters:

uri - the service to connect to.