software.amazon.awssdk.crtcore

Interface CrtProxyConfiguration.Builder

All Known Implementing Classes:

CrtProxyConfiguration.DefaultBuilder

Enclosing class:

CrtProxyConfiguration

public static interface CrtProxyConfiguration.Builder

Builder for CrtProxyConfiguration.

Method Summary

Modifier and Type	Method and Description
CrtProxyConfiguration	build()
CrtProxyConfiguration.Builder	host(String host) Set the hostname of the proxy.
CrtProxyConfiguration.Builder	password(String password) The password to use for basic proxy authentication
CrtProxyConfiguration.Builder	port(int port) Set the port that the proxy expects connections on.
CrtProxyConfiguration.Builder	scheme(String scheme) The HTTP scheme to use for connecting to the proxy.
CrtProxyConfiguration.Builder	useEnvironmentVariableValues(Boolean useEnvironmentVariableValues) The option whether to use environment variable values from ProxySystemSetting if any of the config options are missing.
CrtProxyConfiguration.Builder	username(String username) The username to use for basic proxy authentication
CrtProxyConfiguration.Builder	useSystemPropertyValues(Boolean useSystemPropertyValues) The option whether to use system property values from ProxySystemSetting if any of the config options are missing.

Method Detail

host

CrtProxyConfiguration.Builder host(String host)

Set the hostname of the proxy.

Parameters:

host - The proxy host.

Returns:

This object for method chaining.

port

CrtProxyConfiguration.Builder port(int port)

Set the port that the proxy expects connections on.

Parameters:

port - The proxy port.

Returns:

This object for method chaining.

scheme

CrtProxyConfiguration.Builder scheme(String scheme)

The HTTP scheme to use for connecting to the proxy. Valid values are http and https.

The client defaults to http if none is given.

Parameters:

scheme - The proxy scheme.

Returns:

This object for method chaining.

username

CrtProxyConfiguration.Builder username(String username)

The username to use for basic proxy authentication

If not set, the client will not use basic authentication

Parameters:

username - The basic authentication username.

Returns:

This object for method chaining.

password

CrtProxyConfiguration.Builder password(String password)

The password to use for basic proxy authentication

If not set, the client will not use basic authentication

Parameters:

password - The basic authentication password.

Returns:

This object for method chaining.

useSystemPropertyValues

CrtProxyConfiguration.Builder useSystemPropertyValues(Boolean useSystemPropertyValues)

The option whether to use system property values from ProxySystemSetting if any of the config options are missing. The value is set to "true" by default which means SDK will automatically use system property values if options are not provided during building the CrtProxyConfiguration object. To disable this behaviour, set this value to false.It is important to note that when this property is set to "true," all proxy settings will exclusively originate from system properties, and no partial settings will be obtained from EnvironmentVariableValues.

Parameters:

useSystemPropertyValues - The option whether to use system property values

Returns:

This object for method chaining.

useEnvironmentVariableValues

CrtProxyConfiguration.Builder useEnvironmentVariableValues(Boolean useEnvironmentVariableValues)

The option whether to use environment variable values from ProxySystemSetting if any of the config options are missing. The value is set to "true" by default which means SDK will automatically use environment variable values if options are not provided during building the CrtProxyConfiguration object. To disable this behavior, set this value to false.It is important to note that when this property is set to "true," all proxy settings will exclusively originate from environment variableValues, and no partial settings will be obtained from SystemPropertyValues.

Parameters:

useEnvironmentVariableValues - The option whether to use environment variable values

Returns:

This object for method chaining.

build

CrtProxyConfiguration build()