org.apache.hadoop.fs.s3a

Class S3AOpContext

java.lang.Object

org.apache.hadoop.fs.s3a.impl.ActiveOperationContext

org.apache.hadoop.fs.s3a.S3AOpContext

Direct Known Subclasses:

S3AReadOpContext

public class S3AOpContext
extends ActiveOperationContext

Class for operation context struct passed through codepaths for main S3AFileSystem operations. Anything op-specific should be moved to a subclass of this. This was originally a base class, but ActiveOperationContext was created to be more minimal and cover many more operation type.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.hadoop.fs.FileStatus	dstFileStatus FileStatus for "destination" path being operated on.

Constructor Summary

Constructors

Constructor and Description
S3AOpContext(boolean isS3GuardEnabled, Invoker invoker, org.apache.hadoop.fs.FileSystem.Statistics stats, S3AStatisticsContext instrumentation, org.apache.hadoop.fs.FileStatus dstFileStatus) Constructor using common invoker and retry policy.
S3AOpContext(boolean isS3GuardEnabled, Invoker invoker, Invoker s3guardInvoker, org.apache.hadoop.fs.FileSystem.Statistics stats, S3AStatisticsContext instrumentation, org.apache.hadoop.fs.FileStatus dstFileStatus) Alternate constructor that allows passing in two invokers, the common one, and another with the S3Guard Retry Policy.

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.fs.FileStatus	getDstFileStatus()
Invoker	getInvoker()
Invoker	getS3guardInvoker()
org.apache.hadoop.fs.FileSystem.Statistics	getStats()
boolean	isS3GuardEnabled()

Methods inherited from class org.apache.hadoop.fs.s3a.impl.ActiveOperationContext

getBulkOperationState, getOperationId, getS3AStatisticsContext, newOperationId, toString

Methods inherited from class java.lang.Object

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

Field Detail

dstFileStatus

protected final org.apache.hadoop.fs.FileStatus dstFileStatus

FileStatus for "destination" path being operated on.

Constructor Detail

S3AOpContext

public S3AOpContext(boolean isS3GuardEnabled,
                    Invoker invoker,
                    @Nullable
                    Invoker s3guardInvoker,
                    @Nullable
                    org.apache.hadoop.fs.FileSystem.Statistics stats,
                    S3AStatisticsContext instrumentation,
                    org.apache.hadoop.fs.FileStatus dstFileStatus)

Alternate constructor that allows passing in two invokers, the common one, and another with the S3Guard Retry Policy.

Parameters:

isS3GuardEnabled - true if s3Guard is active

invoker - invoker, which contains retry policy

s3guardInvoker - s3guard-specific retry policy invoker

stats - optional stats object

instrumentation - instrumentation to use

dstFileStatus - file status from existence check

S3AOpContext

public S3AOpContext(boolean isS3GuardEnabled,
                    Invoker invoker,
                    @Nullable
                    org.apache.hadoop.fs.FileSystem.Statistics stats,
                    S3AStatisticsContext instrumentation,
                    org.apache.hadoop.fs.FileStatus dstFileStatus)

Constructor using common invoker and retry policy.

Parameters:

isS3GuardEnabled - true if s3Guard is active

invoker - invoker, which contains retry policy

stats - optional stats object

instrumentation - instrumentation to use

dstFileStatus - file status from existence check

Method Detail

isS3GuardEnabled

public boolean isS3GuardEnabled()

getInvoker

public Invoker getInvoker()

getStats

@Nullable
public org.apache.hadoop.fs.FileSystem.Statistics getStats()

getS3guardInvoker

@Nullable
public Invoker getS3guardInvoker()

getDstFileStatus

public org.apache.hadoop.fs.FileStatus getDstFileStatus()