Interface ProxyConfiguration.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>
,SdkBuilder<ProxyConfiguration.Builder,ProxyConfiguration>
- Enclosing class:
- ProxyConfiguration
public static interface ProxyConfiguration.Builder extends CopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>
Builder forProxyConfiguration
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ProxyConfiguration.Builder
host(String host)
Set the hostname of the proxy.ProxyConfiguration.Builder
nonProxyHosts(Set<String> nonProxyHosts)
Set the set of hosts that should not be proxied.ProxyConfiguration.Builder
password(String password)
Set the password used to authenticate with the proxy password.ProxyConfiguration.Builder
port(int port)
Set the port that the proxy expects connections on.ProxyConfiguration.Builder
scheme(String scheme)
The HTTP scheme to use for connecting to the proxy.ProxyConfiguration.Builder
useEnvironmentVariableValues(Boolean useEnvironmentVariablesValues)
Set the option whether to use environment variable values forProxyEnvironmentSetting
if any of the config options are missing.ProxyConfiguration.Builder
username(String username)
Set the username used to authenticate with the proxy username.ProxyConfiguration.Builder
useSystemPropertyValues(Boolean useSystemPropertyValues)
Set the option whether to use system property values fromProxySystemSetting
if any of the config options are missing.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
-
-
-
Method Detail
-
host
ProxyConfiguration.Builder host(String host)
Set the hostname of the proxy.- Parameters:
host
- The proxy host.- Returns:
- This object for method chaining.
-
port
ProxyConfiguration.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
ProxyConfiguration.Builder scheme(String scheme)
The HTTP scheme to use for connecting to the proxy. Valid values arehttp
andhttps
.The client defaults to
http
if none is given.- Parameters:
scheme
- The proxy scheme.- Returns:
- This object for method chaining.
-
nonProxyHosts
ProxyConfiguration.Builder nonProxyHosts(Set<String> nonProxyHosts)
Set the set of hosts that should not be proxied. Any request whose host portion matches any of the patterns given in the set will be sent to the remote host directly instead of through the proxy.- Parameters:
nonProxyHosts
- The set of hosts that should not be proxied.- Returns:
- This object for method chaining.
-
username
ProxyConfiguration.Builder username(String username)
Set the username used to authenticate with the proxy username.- Parameters:
username
- The proxy username.- Returns:
- This object for method chaining.
-
password
ProxyConfiguration.Builder password(String password)
Set the password used to authenticate with the proxy password.- Parameters:
password
- The proxy password.- Returns:
- This object for method chaining.
-
useSystemPropertyValues
ProxyConfiguration.Builder useSystemPropertyValues(Boolean useSystemPropertyValues)
Set the option whether to use system property values fromProxySystemSetting
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 theProxyConfiguration
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 be obtained from System Property Values, and no partial settings will be obtained from Environment Variable Values.- Parameters:
useSystemPropertyValues
- The option whether to use system property values- Returns:
- This object for method chaining.
-
useEnvironmentVariableValues
ProxyConfiguration.Builder useEnvironmentVariableValues(Boolean useEnvironmentVariablesValues)
Set the option whether to use environment variable values forProxyEnvironmentSetting
if any of the config options are missing. The value is set to "true" by default, enabling the SDK to automatically use environment variable values for proxy configuration options that are not provided during building theProxyConfiguration
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 Variable Values, and no partial settings will be obtained from System Property Values.Comma-separated host names in the NO_PROXY environment variable indicate multiple hosts to exclude from proxy settings.
- Parameters:
useEnvironmentVariablesValues
- The option whether to use environment variable values- Returns:
- This object for method chaining.
-
-