com.orbitz.consul

Class Consul.Builder

java.lang.Object

com.orbitz.consul.Consul.Builder

Enclosing class:

Consul

public static class Consul.Builder
extends Object

Builder for Consul client objects.

Method Summary

Modifier and Type	Method and Description
Consul	build() Constructs a new Consul client.
Consul.Builder	withAclToken(String token) Sets the ACL token to be used with Consul
Consul.Builder	withBasicAuth(String username, String password) Sets the username and password to be used for basic authentication
Consul.Builder	withConnectTimeoutMillis(long timeoutMillis) Connect timeout for OkHttpClient
Consul.Builder	withHostAndPort(com.google.common.net.HostAndPort hostAndPort) Sets the URL from a HostAndPort object.
Consul.Builder	withPing(boolean ping) Instructs the builder that the AgentClient should attempt a ping before returning the Consul instance
Consul.Builder	withReadTimeoutMillis(long timeoutMillis) Read timeout for OkHttpClient
Consul.Builder	withSslContext(SSLContext sslContext) Sets the SSLContext for the client.
Consul.Builder	withUrl(String url) Sets the URL from a string.
Consul.Builder	withUrl(URL url) Sets the URL from a URL object.
Consul.Builder	withWriteTimeoutMillis(long timeoutMillis) Write timeout for OkHttpClient

Methods inherited from class java.lang.Object

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

Method Detail

withUrl

public Consul.Builder withUrl(URL url)

Sets the URL from a URL object.

Parameters:

url - The Consul agent URL.

Returns:

The builder.

withPing

public Consul.Builder withPing(boolean ping)

Instructs the builder that the AgentClient should attempt a ping before returning the Consul instance

Parameters:

ping - Whether the ping should be done or not

Returns:

The builder.

withBasicAuth

public Consul.Builder withBasicAuth(String username,
                                    String password)

Sets the username and password to be used for basic authentication

Parameters:

username - the value of the username

password - the value of the password

Returns:

The builder.

withAclToken

public Consul.Builder withAclToken(String token)

Sets the ACL token to be used with Consul

Parameters:

token - the value of the token

Returns:

The builder.

withHostAndPort

public Consul.Builder withHostAndPort(com.google.common.net.HostAndPort hostAndPort)

Sets the URL from a HostAndPort object.

Parameters:

hostAndPort - The Consul agent host and port.

Returns:

The builder.

withUrl

public Consul.Builder withUrl(String url)

Sets the URL from a string.

Parameters:

url - The Consul agent URL.

Returns:

The builder.

withSslContext

public Consul.Builder withSslContext(SSLContext sslContext)

Sets the SSLContext for the client.

Parameters:

sslContext - The SSL context for HTTPS agents.

Returns:

The builder.

withConnectTimeoutMillis

public Consul.Builder withConnectTimeoutMillis(long timeoutMillis)

Connect timeout for OkHttpClient

Parameters:

timeoutMillis - timeout values in milliseconds

Returns:

The builder

withReadTimeoutMillis

public Consul.Builder withReadTimeoutMillis(long timeoutMillis)

Read timeout for OkHttpClient

Parameters:

timeoutMillis - timeout value in milliseconds

Returns:

The builder

withWriteTimeoutMillis

public Consul.Builder withWriteTimeoutMillis(long timeoutMillis)

Write timeout for OkHttpClient

Parameters:

timeoutMillis - timeout value in milliseconds

Returns:

The builder

build

public Consul build()

Constructs a new Consul client.

Returns:

A new Consul client.