org.apache.hadoop.fs.s3a

Class S3AReadOpContext

java.lang.Object

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

org.apache.hadoop.fs.s3a.S3AOpContext

org.apache.hadoop.fs.s3a.S3AReadOpContext

public class S3AReadOpContext
extends S3AOpContext

Read-specific operation context struct.

Field Summary

Fields inherited from class org.apache.hadoop.fs.s3a.S3AOpContext

dstFileStatus

Constructor Summary

Constructors

Constructor and Description

S3AReadOpContext(org.apache.hadoop.fs.Path path, boolean isS3GuardEnabled, Invoker invoker, Invoker s3guardInvoker, org.apache.hadoop.fs.FileSystem.Statistics stats, S3AStatisticsContext instrumentation, org.apache.hadoop.fs.FileStatus dstFileStatus, S3AInputPolicy inputPolicy, ChangeDetectionPolicy changeDetectionPolicy, long readahead, org.apache.hadoop.fs.store.audit.AuditSpan auditSpan) Instantiate.

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.fs.store.audit.AuditSpan	getAuditSpan() Get the audit which was active when the file was opened.
ChangeDetectionPolicy	getChangeDetectionPolicy()
S3AInputPolicy	getInputPolicy() Get the IO policy.
org.apache.hadoop.fs.Path	getPath() Get the path of this read.
long	getReadahead() Get the readahead for this operation.
Invoker	getReadInvoker() Get invoker to use for read operations.
String	toString()

Methods inherited from class org.apache.hadoop.fs.s3a.S3AOpContext

getDstFileStatus, getInvoker, getS3guardInvoker, getStats, isS3GuardEnabled

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

getBulkOperationState, getOperationId, getS3AStatisticsContext, newOperationId

Methods inherited from class java.lang.Object

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

Constructor Detail

S3AReadOpContext

public S3AReadOpContext(org.apache.hadoop.fs.Path path,
                        boolean isS3GuardEnabled,
                        Invoker invoker,
                        @Nullable
                        Invoker s3guardInvoker,
                        @Nullable
                        org.apache.hadoop.fs.FileSystem.Statistics stats,
                        S3AStatisticsContext instrumentation,
                        org.apache.hadoop.fs.FileStatus dstFileStatus,
                        S3AInputPolicy inputPolicy,
                        ChangeDetectionPolicy changeDetectionPolicy,
                        long readahead,
                        org.apache.hadoop.fs.store.audit.AuditSpan auditSpan)

Instantiate.

Parameters:

path - path of read

isS3GuardEnabled - true iff S3Guard is enabled.

invoker - invoker for normal retries.

s3guardInvoker - S3Guard-specific retry invoker.

stats - Fileystem statistics (may be null)

instrumentation - statistics context

dstFileStatus - target file status

inputPolicy - the input policy

changeDetectionPolicy - change detection policy.

readahead - readahead for GET operations/skip, etc.

auditSpan - active audit

Method Detail

getReadInvoker

public Invoker getReadInvoker()

Get invoker to use for read operations. When S3Guard is enabled we use the S3Guard invoker, which deals with things like FileNotFoundException differently.

Returns:

invoker to use for read codepaths

getPath

public org.apache.hadoop.fs.Path getPath()

Get the path of this read.

Returns:

path.

getInputPolicy

public S3AInputPolicy getInputPolicy()

Get the IO policy.

Returns:

the initial input policy.

getChangeDetectionPolicy

public ChangeDetectionPolicy getChangeDetectionPolicy()

getReadahead

public long getReadahead()

Get the readahead for this operation.

Returns:

a value >= 0

getAuditSpan

public org.apache.hadoop.fs.store.audit.AuditSpan getAuditSpan()

Get the audit which was active when the file was opened.

Returns:

active span

toString

public String toString()

Overrides:

toString in class ActiveOperationContext