Interface S3CrtProxyConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<S3CrtProxyConfiguration.Builder,
,S3CrtProxyConfiguration> CrtProxyConfiguration.Builder
,SdkBuilder<S3CrtProxyConfiguration.Builder,
S3CrtProxyConfiguration>
- Enclosing class:
S3CrtProxyConfiguration
public static interface S3CrtProxyConfiguration.Builder
extends CrtProxyConfiguration.Builder, CopyableBuilder<S3CrtProxyConfiguration.Builder,S3CrtProxyConfiguration>
Builder for
S3CrtProxyConfiguration
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
An immutable object that is created from the properties that have been set on the builder.Set the hostname of the proxy.The password to use for basic proxy authenticationport
(int port) Set the port that the proxy expects connections on.The HTTP scheme to use for connecting to the proxy.useEnvironmentVariableValues
(Boolean useEnvironmentVariableValues) The option whether to use environment variable values fromProxySystemSetting
if any of the config options are missing.The username to use for basic proxy authenticationuseSystemPropertyValues
(Boolean useSystemPropertyValues) 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.crtcore.CrtProxyConfiguration.Builder
addNonProxyHost, nonProxyHosts
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation
-
Method Details
-
host
Description copied from interface:CrtProxyConfiguration.Builder
Set the hostname of the proxy.- Specified by:
host
in interfaceCrtProxyConfiguration.Builder
- Parameters:
host
- The proxy host.- Returns:
- This object for method chaining.
-
port
Description copied from interface:CrtProxyConfiguration.Builder
Set the port that the proxy expects connections on.- Specified by:
port
in interfaceCrtProxyConfiguration.Builder
- Parameters:
port
- The proxy port.- Returns:
- This object for method chaining.
-
scheme
Description copied from interface:CrtProxyConfiguration.Builder
The HTTP scheme to use for connecting to the proxy. Valid values arehttp
andhttps
.The client defaults to
http
if none is given.- Specified by:
scheme
in interfaceCrtProxyConfiguration.Builder
- Parameters:
scheme
- The proxy scheme.- Returns:
- This object for method chaining.
-
username
Description copied from interface:CrtProxyConfiguration.Builder
The username to use for basic proxy authenticationIf not set, the client will not use basic authentication
- Specified by:
username
in interfaceCrtProxyConfiguration.Builder
- Parameters:
username
- The basic authentication username.- Returns:
- This object for method chaining.
-
password
Description copied from interface:CrtProxyConfiguration.Builder
The password to use for basic proxy authenticationIf not set, the client will not use basic authentication
- Specified by:
password
in interfaceCrtProxyConfiguration.Builder
- Parameters:
password
- The basic authentication password.- Returns:
- This object for method chaining.
-
useSystemPropertyValues
Description copied from interface:CrtProxyConfiguration.Builder
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 theCrtProxyConfiguration
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.- Specified by:
useSystemPropertyValues
in interfaceCrtProxyConfiguration.Builder
- Parameters:
useSystemPropertyValues
- The option whether to use system property values- Returns:
- This object for method chaining.
-
useEnvironmentVariableValues
Description copied from interface:CrtProxyConfiguration.Builder
The option whether to use environment variable values fromProxySystemSetting
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 theCrtProxyConfiguration
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.Comma-separated host names in the NO_PROXY environment variable indicate multiple hosts to exclude from proxy settings.
- Specified by:
useEnvironmentVariableValues
in interfaceCrtProxyConfiguration.Builder
- Parameters:
useEnvironmentVariableValues
- The option whether to use environment variable values- Returns:
- This object for method chaining.
-
build
S3CrtProxyConfiguration build()Description copied from interface:SdkBuilder
An immutable object that is created from the properties that have been set on the builder.- Specified by:
build
in interfaceBuildable
- Specified by:
build
in interfaceCrtProxyConfiguration.Builder
- Specified by:
build
in interfaceSdkBuilder<S3CrtProxyConfiguration.Builder,
S3CrtProxyConfiguration> - Returns:
- an instance of T
-