@InterfaceAudience.Private @InterfaceStability.Unstable

Package org.apache.hadoop.fs.s3a.impl

Implementation classes private to the S3A store.

See: Description

Interface Summary

Interface	Description
AWSHeaders	Common S3 HTTP header values used throughout the Amazon Web Services S3 Java client.
ContextAccessors	An interface to implement for providing accessors to S3AFileSystem-level API calls.
CopyFromLocalOperation.CopyFromLocalOperationCallbacks	Define the contract for CopyFromLocalOperation to interact with any external resources.
CreateFileBuilder.CreateFileBuilderCallbacks	Callbacks for creating the file.
DirectoryPolicy	Interface for Directory Marker policies to implement.
GetContentSummaryOperation.GetContentSummaryCallbacks	Callbacks used by the operation.
HeaderProcessing.HeaderProcessingCallbacks
ListingOperationCallbacks	These are all the callbacks which Listing operations need, derived from the actual appropriate S3AFileSystem methods.
MkdirOperation.MkdirCallbacks	Callbacks used by mkdir.
OperationCallbacks	These are all the callbacks which the RenameOperation and DeleteOperation operations need, derived from the appropriate S3AFileSystem methods.
ProgressListener	Interface for progress listeners to implement.
RequestFactoryImpl.PrepareRequest	This is a callback for anything to "prepare" every request after creation.

Class Summary

Class	Description
AbstractStoreOperation	Base class of operations in the store.
ActiveOperationContext	Context for any active operation.
AWSClientConfig	Methods for configuring the S3 client.
BulkDeleteRetryHandler	Handler for bulk delete retry events.
CallableSupplier<T>	A bridge from Callable to Supplier; catching exceptions raised by the callable and wrapping them as appropriate.
ChangeDetectionPolicy	Object change detection policy.
ChangeTracker	Change tracking for input streams: the version ID or etag of the object is tracked and compared on open/re-open.
ConfigurationHelper	Helper class for configuration; where methods related to extracting configuration should go instead of S3AUtils.
ConfigureShadedAWSSocketFactory	This interacts with the Shaded httpclient library used in the full AWS SDK.
CopyFromLocalOperation	Implementation of CopyFromLocalOperation.
CreateFileBuilder	Builder used in create file; takes a callback to the operation to create the file.
CreateFileBuilder.CreateFileOptions	Create file options as built from the builder set or the classic entry point.
DeleteOperation	Implementation of the delete() operation.
DirectoryPolicyImpl	Implementation of directory policy.
DirMarkerTracker	Tracks directory markers which have been reported in object listings.
DirMarkerTracker.Marker	This is a marker entry stored in the map and returned as markers are deleted.
ErrorTranslation	Translate from AWS SDK-wrapped exceptions into IOExceptions with as much information as possible.
ErrorTranslation.AwsErrorCodes	AWS error codes explicitly recognized and processes specially; kept in their own class for isolation.
ExecutingStoreOperation<T>	A subclass of AbstractStoreOperation which provides a method ExecutingStoreOperation.execute() that may be invoked exactly once.
GetContentSummaryOperation	GetContentSummary operation.
HeaderProcessing	Part of the S3A FS where object headers are processed.
InternalConstants	Internal constants private only to the S3A codebase.
MkdirOperation	The mkdir operation.
NetworkBinding	Configures network settings when communicating with AWS services.
OpenFileSupport	Helper class for openFile() logic, especially processing file status args and length/etag/versionID.
OpenFileSupport.OpenFileInformation	The information on a file needed to open it.
PutObjectOptions	Extensible structure for options when putting/writing objects.
RenameOperation	A parallelized rename operation.
RequestFactoryImpl	The standard implementation of the request factory.
RequestFactoryImpl.RequestFactoryBuilder	Builder.
S3AMultipartUploaderBuilder	Builder for S3A multipart uploaders.
S3ExpressStorage	Anything needed to support Amazon S3 Express One Zone Storage.
SDKStreamDrainer<TStream extends InputStream & software.amazon.awssdk.http.Abortable>	Drains/aborts s3 or other AWS SDK streams.
StoreContext	This class provides the core context of the S3A filesystem to subsidiary components, without exposing the entire parent class.
StoreContextBuilder	Builder for the store context.
V2Migration	This class provides utility methods required for migrating S3A to AWS Java SDK V2.

Enum Summary

Enum	Description
AWSCannedACL	Enum to map AWS SDK V1 Acl values to SDK V2.
ChangeDetectionPolicy.Mode	What to do when change is detected.
ChangeDetectionPolicy.Source	The S3 object attribute used to detect change.
DirectoryPolicy.MarkerPolicy	Supported retention policies.
InstantiationIOException.Kind	An (extensible) enum of kinds of instantiation failure.
ProgressListenerEvent	Enum for progress listener events.
StatusProbeEnum	Enum of probes which can be made of S3.

Exception Summary

Exception	Description
InstantiationIOException	An instantiation exception raised during reflection-based creation of classes.
MultiObjectDeleteException	Exception raised in S3AFileSystem.deleteObjects(software.amazon.awssdk.services.s3.model.DeleteObjectsRequest) when one or more of the keys could not be deleted.

Package org.apache.hadoop.fs.s3a.impl Description

Implementation classes private to the S3A store. Do not use outside of the hadoop-aws module.