Class S3ClientOptions
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final boolean
S3 accelerate is by default not enabledstatic final boolean
The default setting for use of chunked encodingstatic final boolean
The default setting for use of path-style accessstatic final boolean
The default setting for use of payload signing -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.S3ClientOptions
(S3ClientOptions other) Deprecated.Will be removed once S3ClientOptions is made an immutable class. -
Method Summary
Modifier and TypeMethodDescriptionstatic S3ClientOptions.Builder
builder()
Deprecated.Usebuilder()
to build new S3ClientOptions instead.boolean
Returns whether the client has enabled accelerate mode for getting and putting objects.boolean
Returns whether the client has chunked encoding disabled for all requests.boolean
Returns whether the client uses path-style access for all requests.boolean
Returns whether the client is configured to sign payloads in all situations.void
setChunkedEncodingDisabled
(boolean chunkedEncodingDisabled) Deprecated.Usebuilder()
to build new S3ClientOptions instead.void
setPathStyleAccess
(boolean pathStyleAccess) Deprecated.Usebuilder()
to build new S3ClientOptions instead.withChunkedEncodingDisabled
(boolean chunkedEncodingDisabled) Deprecated.Usebuilder()
to build new S3ClientOptions instead.withPathStyleAccess
(boolean pathStyleAccess) Deprecated.Usebuilder()
to build new S3ClientOptions instead.
-
Field Details
-
DEFAULT_PATH_STYLE_ACCESS
public static final boolean DEFAULT_PATH_STYLE_ACCESSThe default setting for use of path-style access- See Also:
-
DEFAULT_CHUNKED_ENCODING_DISABLED
public static final boolean DEFAULT_CHUNKED_ENCODING_DISABLEDThe default setting for use of chunked encoding- See Also:
-
DEFAULT_PAYLOAD_SIGNING_ENABLED
public static final boolean DEFAULT_PAYLOAD_SIGNING_ENABLEDThe default setting for use of payload signing- See Also:
-
DEFAULT_ACCELERATE_MODE_ENABLED
public static final boolean DEFAULT_ACCELERATE_MODE_ENABLEDS3 accelerate is by default not enabled- See Also:
-
-
Constructor Details
-
S3ClientOptions
Deprecated.Usebuilder()
to build new S3ClientOptions instead. -
S3ClientOptions
Deprecated.Will be removed once S3ClientOptions is made an immutable class.
-
-
Method Details
-
builder
- Returns:
- a new S3ClientOptions builder.
-
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
-
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
-
isAccelerateModeEnabled
public boolean isAccelerateModeEnabled()Returns whether the client has enabled accelerate mode for getting and putting objects.
The default behavior is to disable accelerate mode for any operations (GET, PUT, DELETE). You need to call
AmazonS3Client.setBucketAccelerateConfiguration(com.amazonaws.services.s3.model.SetBucketAccelerateConfigurationRequest)
first to use this feature.- Returns:
- True if accelerate mode is enabled.
-
isPayloadSigningEnabled
public boolean isPayloadSigningEnabled()Returns whether the client is configured to sign payloads in all situations.
Payload signing is optional when chunked encoding is not used and requests are made against an HTTPS endpoint. Under these conditions the client will by default opt to not sign payloads to optimize performance. If this flag is set to true the client will instead always sign payloads.
Note: Payload signing can be expensive, particularly if transferring large payloads in a single chunk. Enabling this option will result in a performance penalty.
- Returns:
- True if body signing is explicitly enabled for all requests
-
setPathStyleAccess
Deprecated.Usebuilder()
to build new S3ClientOptions instead. -
withPathStyleAccess
Deprecated.Usebuilder()
to build new S3ClientOptions instead. -
setChunkedEncodingDisabled
Deprecated.Usebuilder()
to build new S3ClientOptions instead. -
withChunkedEncodingDisabled
Deprecated.Usebuilder()
to build new S3ClientOptions instead. -
disableChunkedEncoding
Deprecated.Usebuilder()
to build new S3ClientOptions instead.
-
builder()
to build new S3ClientOptions instead.