com.amazonaws.services.s3

Class S3ClientOptions

java.lang.Object

com.amazonaws.services.s3.S3ClientOptions

public class S3ClientOptions
extends Object

S3 client configuration options such as the request access style.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CHUNKED_ENCODING_DISABLED The default setting for use of chunked encoding
static boolean	DEFAULT_PATH_STYLE_ACCESS The default setting for use of path-style access

Constructor Summary

Constructors

Constructor and Description
S3ClientOptions()
S3ClientOptions(S3ClientOptions other)

Method Summary

Methods

Modifier and Type	Method and Description
S3ClientOptions	disableChunkedEncoding() Deprecated. Use withChunkedEncodingDisabled(boolean) instead
boolean	isChunkedEncodingDisabled() Returns whether the client has chunked encoding disabled for all requests.
boolean	isPathStyleAccess() Returns whether the client uses path-style access for all requests.
void	setChunkedEncodingDisabled(boolean chunkedEncodingDisabled) Configures the client to disable chunked encoding for all requests.
void	setPathStyleAccess(boolean pathStyleAccess) Configures the client to use path-style access for all requests.
S3ClientOptions	withChunkedEncodingDisabled(boolean chunkedEncodingDisabled) Configures the client to disable chunked encoding for all requests.
S3ClientOptions	withPathStyleAccess(boolean pathStyleAccess) Configures the client to use path-style access for all requests.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PATH_STYLE_ACCESS

public static final boolean DEFAULT_PATH_STYLE_ACCESS

The default setting for use of path-style access

See Also:

Constant Field Values

DEFAULT_CHUNKED_ENCODING_DISABLED

public static final boolean DEFAULT_CHUNKED_ENCODING_DISABLED

The default setting for use of chunked encoding

See Also:

Constant Field Values

Constructor Detail

S3ClientOptions

public S3ClientOptions()

S3ClientOptions

public S3ClientOptions(S3ClientOptions other)

Method Detail

isPathStyleAccess

public boolean isPathStyleAccess()

Returns whether the client uses path-style access for all requests.

Amazon S3 supports virtual-hosted-style and path-style access in all Regions. The path-style syntax, however, requires that you use the region-specific endpoint when attempting to access a bucket.

The default behaviour is to detect which access style to use based on the configured endpoint (an IP will result in path-style access) and the bucket being accessed (some buckets are not valid DNS names). Setting this flag will result in path-style access being used for all requests.

Returns:

True is the client should always use path-style access

setPathStyleAccess

public void setPathStyleAccess(boolean pathStyleAccess)

Configures the client to use path-style access for all requests.

Amazon S3 supports virtual-hosted-style and path-style access in all Regions. The path-style syntax, however, requires that you use the region-specific endpoint when attempting to access a bucket.

The default behaviour is to detect which access style to use based on the configured endpoint (an IP will result in path-style access) and the bucket being accessed (some buckets are not valid DNS names). Setting this flag will result in path-style access being used for all requests.

Parameters:

pathStyleAccess - True to always use path-style access.

withPathStyleAccess

public S3ClientOptions withPathStyleAccess(boolean pathStyleAccess)

Configures the client to use path-style access for all requests.

Amazon S3 supports virtual-hosted-style and path-style access in all Regions. The path-style syntax, however, requires that you use the region-specific endpoint when attempting to access a bucket.

The default behaviour is to detect which access style to use based on the configured endpoint (an IP will result in path-style access) and the bucket being accessed (some buckets are not valid DNS names). Setting this flag will result in path-style access being used for all requests.

Parameters:

pathStyleAccess - True to always use path-style access.

Returns:

The updated S3ClientOptions object with the new path-style access setting.

isChunkedEncodingDisabled

public boolean isChunkedEncodingDisabled()

Returns whether the client has chunked encoding disabled for all requests.

The default behavior is to enable chunked encoding automatically for PutObjectRequest and UploadPartRequest. Setting this flag will result in disabling chunked encoding for all requests.

Note: Enabling this option has performance implications since the checksum for the payload will have to be pre-calculated before sending the data. If your payload is large this will affect the overall time required to upload an object. Using this option is recommended only if your endpoint does not implement chunked uploading.

Returns:

True if chunked encoding is explicitly disabled for all requests

setChunkedEncodingDisabled

public void setChunkedEncodingDisabled(boolean chunkedEncodingDisabled)

Configures the client to disable chunked encoding for all requests.

The default behavior is to enable chunked encoding automatically for PutObjectRequest and UploadPartRequest. Setting this flag will result in disabling chunked encoding for all requests.

Note: Enabling this option has performance implications since the checksum for the payload will have to be pre-calculated before sending the data. If your payload is large this will affect the overall time required to upload an object. Using this option is recommended only if your endpoint does not implement chunked uploading.

Parameters:

chunkedEncodingDisabled - True to disable chunked encoding

withChunkedEncodingDisabled

public S3ClientOptions withChunkedEncodingDisabled(boolean chunkedEncodingDisabled)

Configures the client to disable chunked encoding for all requests.

The default behavior is to enable chunked encoding automatically for PutObjectRequest and UploadPartRequest. Setting this flag will result in disabling chunked encoding for all requests.

Note: Enabling this option has performance implications since the checksum for the payload will have to be pre-calculated before sending the data. If your payload is large this will affect the overall time required to upload an object. Using this option is recommended only if your endpoint does not implement chunked uploading.

Parameters:

chunkedEncodingDisabled - True to disable chunked encoding

disableChunkedEncoding

public S3ClientOptions disableChunkedEncoding()

Deprecated. Use withChunkedEncodingDisabled(boolean) instead

Configures the client to disable chunked encoding for all requests.

The default behavior is to enable chunked encoding automatically for PutObjectRequest and UploadPartRequest. Setting this flag will result in disabling chunked encoding for all requests.

Note: Enabling this option has performance implications since the checksum for the payload will have to be pre-calculated before sending the data. If your payload is large this will affect the overall time required to upload an object. Using this option is recommended only if your endpoint does not implement chunked uploading.

Returns:

The updated S3ClientOptions object with chunked encoding disabled setting.