@InterfaceAudience.Public @InterfaceStability.Evolving public final class Constants extends Object
S3AFileSystem.
Some of the strings are marked as Unstable. This means
that they may be unsupported in future; at which point they will be marked
as deprecated and simply ignored.| Modifier and Type | Field and Description |
|---|---|
static String |
ACCESS_KEY |
static String |
ASSUMED_ROLE_ARN
AWS Role to request.
|
static String |
ASSUMED_ROLE_CREDENTIALS_DEFAULT |
static String |
ASSUMED_ROLE_CREDENTIALS_PROVIDER
list of providers to authenticate for the assumed role.
|
static String |
ASSUMED_ROLE_POLICY
JSON policy containing the policy to apply to the role.
|
static String |
ASSUMED_ROLE_SESSION_DURATION
Duration of assumed roles before a refresh is attempted.
|
static String |
ASSUMED_ROLE_SESSION_DURATION_DEFAULT
Default duration of an assumed role.
|
static String |
ASSUMED_ROLE_SESSION_NAME
Session name for the assumed role, must be valid characters according
to the AWS APIs.
|
static String |
ASSUMED_ROLE_STS_ENDPOINT
Security Token Service Endpoint.
|
static String |
ASSUMED_ROLE_STS_ENDPOINT_REGION
Region for the STS endpoint; only relevant if the endpoint
is set.
|
static String |
ASSUMED_ROLE_STS_ENDPOINT_REGION_DEFAULT
Default value for the STS endpoint region; needed for
v4 signing.
|
static String |
AWS_CREDENTIALS_PROVIDER |
static String |
BUFFER_DIR |
static String |
CANNED_ACL |
static String |
DEFAULT_CANNED_ACL |
static int |
DEFAULT_ESTABLISH_TIMEOUT |
static int |
DEFAULT_FAST_BUFFER_SIZE |
static boolean |
DEFAULT_FAST_UPLOAD
Deprecated.
|
static int |
DEFAULT_FAST_UPLOAD_ACTIVE_BLOCKS
Limit of queued block upload operations before writes
block.
|
static String |
DEFAULT_FAST_UPLOAD_BUFFER
Default buffer option: "disk".
|
static int |
DEFAULT_KEEPALIVE_TIME |
static int |
DEFAULT_LIST_VERSION |
static int |
DEFAULT_MAX_ERROR_RETRIES |
static int |
DEFAULT_MAX_PAGING_KEYS |
static int |
DEFAULT_MAX_THREADS |
static int |
DEFAULT_MAX_TOTAL_TASKS |
static int |
DEFAULT_MAXIMUM_CONNECTIONS |
static boolean |
DEFAULT_METADATASTORE_AUTHORITATIVE |
static long |
DEFAULT_MIN_MULTIPART_THRESHOLD |
static long |
DEFAULT_MULTIPART_SIZE |
static boolean |
DEFAULT_PURGE_EXISTING_MULTIPART |
static long |
DEFAULT_PURGE_EXISTING_MULTIPART_AGE |
static long |
DEFAULT_READAHEAD_RANGE |
static Class<? extends S3ClientFactory> |
DEFAULT_S3_CLIENT_FACTORY_IMPL |
static int |
DEFAULT_S3GUARD_METASTORE_LOCAL_ENTRY_TTL |
static int |
DEFAULT_S3GUARD_METASTORE_LOCAL_MAX_RECORDS |
static boolean |
DEFAULT_SECURE_CONNECTIONS |
static int |
DEFAULT_SOCKET_RECV_BUFFER |
static int |
DEFAULT_SOCKET_SEND_BUFFER |
static int |
DEFAULT_SOCKET_TIMEOUT |
static String |
ENABLE_MULTI_DELETE |
static String |
ENDPOINT |
static String |
ESTABLISH_TIMEOUT |
static String |
ETAG_CHECKSUM_ENABLED
Should etags be exposed as checksums?
|
static boolean |
ETAG_CHECKSUM_ENABLED_DEFAULT
Default value: false.
|
static String |
FAIL_INJECT_CLIENT_FACTORY |
static String |
FAIL_INJECT_INCONSISTENCY_KEY
Inconsistency (visibility delay) injection settings.
|
static String |
FAIL_INJECT_INCONSISTENCY_MSEC |
static String |
FAIL_INJECT_INCONSISTENCY_PROBABILITY |
static String |
FAIL_INJECT_THROTTLE_PROBABILITY |
static String |
FAST_BUFFER_SIZE
Deprecated.
|
static String |
FAST_UPLOAD
Deprecated.
|
static String |
FAST_UPLOAD_ACTIVE_BLOCKS
Maximum Number of blocks a single output stream can have
active (uploading, or queued to the central FileSystem
instance's pool of queued operations.
|
static String |
FAST_UPLOAD_BUFFER
What buffer to use.
|
static String |
FAST_UPLOAD_BUFFER_ARRAY
Use an in-memory array.
|
static String |
FAST_UPLOAD_BUFFER_DISK
Buffer blocks to disk: "disk".
|
static String |
FAST_UPLOAD_BYTEBUFFER
Use a byte buffer.
|
static String |
FS_S3A |
static String |
FS_S3A_BLOCK_SIZE |
static String |
FS_S3A_BUCKET_PREFIX
Prefix for S3A bucket-specific properties: "fs.s3a.bucket.".
|
static String |
FS_S3A_PREFIX
Prefix for all S3A properties: "fs.s3a.".
|
static String |
HADOOP_TMP_DIR
default hadoop temp dir on local system: "hadoop.tmp.dir".
|
static String |
INPUT_FADV_NORMAL
General input.
|
static String |
INPUT_FADV_RANDOM
Optimized purely for random seek+read/positionedRead operations;
The performance of sequential IO may be reduced in exchange for
more efficient
seek() operations. |
static String |
INPUT_FADV_SEQUENTIAL
Optimized for sequential access.
|
static String |
INPUT_FADVISE
Which input strategy to use for buffering, seeking and similar when
reading data.
|
static String |
KEEPALIVE_TIME |
static String |
LIST_VERSION
S3 API level parameters.
|
static String |
MAX_ERROR_RETRIES |
static int |
MAX_MULTIPART_COUNT
Maximum number of partitions in a multipart upload: 10000.
|
static String |
MAX_PAGING_KEYS |
static String |
MAX_THREADS |
static String |
MAX_TOTAL_TASKS |
static String |
MAXIMUM_CONNECTIONS |
static String |
METADATASTORE_AUTHORITATIVE
Whether or not to allow MetadataStore to be source of truth.
|
static String |
MIN_MULTIPART_THRESHOLD |
static int |
MULTIPART_MIN_SIZE
The minimum multipart size which S3 supports.
|
static String |
MULTIPART_SIZE |
static String |
PATH_STYLE_ACCESS |
static String |
PROXY_DOMAIN |
static String |
PROXY_HOST |
static String |
PROXY_PASSWORD |
static String |
PROXY_PORT |
static String |
PROXY_USERNAME |
static String |
PROXY_WORKSTATION |
static String |
PURGE_EXISTING_MULTIPART |
static String |
PURGE_EXISTING_MULTIPART_AGE |
static String |
READAHEAD_RANGE
read ahead buffer size to prevent connection re-establishments.
|
static String |
RETRY_INTERVAL
Interval between retry attempts.: "fs.s3a.retry.interval".
|
static String |
RETRY_INTERVAL_DEFAULT
Default retry interval: "500ms".
|
static String |
RETRY_LIMIT
Number of times to retry any repeatable S3 client request on failure,
excluding throttling requests: "fs.s3a.retry.limit".
|
static int |
RETRY_LIMIT_DEFAULT
Default retry limit: 20.
|
static String |
RETRY_THROTTLE_INTERVAL
Interval between retry attempts on throttled requests: "fs.s3a.retry.throttle.interval".
|
static String |
RETRY_THROTTLE_INTERVAL_DEFAULT
Default throttled retry interval: "500ms".
|
static String |
RETRY_THROTTLE_LIMIT
Number of times to retry any throttled request: "fs.s3a.retry.throttle.limit".
|
static int |
RETRY_THROTTLE_LIMIT_DEFAULT
Default throttled retry limit: 20.
|
static String |
S3_CLIENT_FACTORY_IMPL |
static String |
S3_METADATA_STORE_IMPL |
static int |
S3A_DEFAULT_PORT |
static String |
S3A_SECURITY_CREDENTIAL_PROVIDER_PATH
Extra set of security credentials which will be prepended to that
set in
"hadoop.security.credential.provider.path". |
static String |
S3GUARD_CLI_PRUNE_AGE
Minimum period of time (in milliseconds) to keep metadata (may only be
applied when a prune command is manually run).
|
static int |
S3GUARD_DDB_BACKGROUND_SLEEP_MSEC_DEFAULT |
static String |
S3GUARD_DDB_BACKGROUND_SLEEP_MSEC_KEY
Period of time (in milliseconds) to sleep between batches of writes.
|
static int |
S3GUARD_DDB_BATCH_WRITE_REQUEST_LIMIT
The maximum put or delete requests per BatchWriteItem request.
|
static String |
S3GUARD_DDB_MAX_RETRIES |
static int |
S3GUARD_DDB_MAX_RETRIES_DEFAULT
Max retries on batched/throttled DynamoDB operations before giving up and
throwing an IOException.
|
static String |
S3GUARD_DDB_REGION_KEY
The region of the DynamoDB service.
|
static long |
S3GUARD_DDB_TABLE_CAPACITY_READ_DEFAULT |
static String |
S3GUARD_DDB_TABLE_CAPACITY_READ_KEY |
static long |
S3GUARD_DDB_TABLE_CAPACITY_WRITE_DEFAULT |
static String |
S3GUARD_DDB_TABLE_CAPACITY_WRITE_KEY |
static String |
S3GUARD_DDB_TABLE_CREATE_KEY
Whether to create the DynamoDB table if the table does not exist.
|
static String |
S3GUARD_DDB_TABLE_NAME_KEY
The DynamoDB table name to use.
|
static String |
S3GUARD_DDB_TABLE_TAG
A prefix for adding tags to the DDB Table upon creation.
|
static String |
S3GUARD_DDB_TEST_TABLE_NAME_KEY
Test table name to use during DynamoDB integration test.
|
static String |
S3GUARD_DDB_THROTTLE_RETRY_INTERVAL |
static String |
S3GUARD_DDB_THROTTLE_RETRY_INTERVAL_DEFAULT |
static String |
S3GUARD_METASTORE_DYNAMO
Use DynamoDB for the metadata: "org.apache.hadoop.fs.s3a.s3guard.DynamoDBMetadataStore".
|
static String |
S3GUARD_METASTORE_LOCAL
Use Local memory for the metadata: "org.apache.hadoop.fs.s3a.s3guard.LocalMetadataStore".
|
static String |
S3GUARD_METASTORE_LOCAL_ENTRY_TTL
Time to live in milliseconds in LocalMetadataStore.
|
static String |
S3GUARD_METASTORE_LOCAL_MAX_RECORDS
Maximum number of records in LocalMetadataStore.
|
static String |
S3GUARD_METASTORE_NULL
The default "Null" metadata store: "org.apache.hadoop.fs.s3a.s3guard.NullMetadataStore".
|
static String |
S3N_FOLDER_SUFFIX |
static String |
SECRET_KEY |
static String |
SECURE_CONNECTIONS |
static String |
SERVER_SIDE_ENCRYPTION_AES256
Deprecated.
|
static String |
SERVER_SIDE_ENCRYPTION_ALGORITHM |
static String |
SERVER_SIDE_ENCRYPTION_KEY
Used to specify which AWS KMS key to use if
SERVER_SIDE_ENCRYPTION_ALGORITHM is
SSE-KMS (will default to aws/s3
master key if left blank). |
static String |
SESSION_TOKEN |
static String |
SIGNING_ALGORITHM |
static String |
SOCKET_RECV_BUFFER |
static String |
SOCKET_SEND_BUFFER |
static String |
SOCKET_TIMEOUT |
static String |
USER_AGENT_PREFIX |
public static final String HADOOP_TMP_DIR
public static final int MULTIPART_MIN_SIZE
public static final String ACCESS_KEY
public static final String SECRET_KEY
public static final String AWS_CREDENTIALS_PROVIDER
public static final String S3A_SECURITY_CREDENTIAL_PROVIDER_PATH
"hadoop.security.credential.provider.path".
This extra option allows for per-bucket overrides.public static final String SESSION_TOKEN
public static final String ASSUMED_ROLE_ARN
public static final String ASSUMED_ROLE_SESSION_NAME
public static final String ASSUMED_ROLE_SESSION_DURATION
public static final String ASSUMED_ROLE_STS_ENDPOINT
public static final String ASSUMED_ROLE_STS_ENDPOINT_REGION
public static final String ASSUMED_ROLE_STS_ENDPOINT_REGION_DEFAULT
public static final String ASSUMED_ROLE_SESSION_DURATION_DEFAULT
public static final String ASSUMED_ROLE_CREDENTIALS_PROVIDER
public static final String ASSUMED_ROLE_POLICY
public static final String ASSUMED_ROLE_CREDENTIALS_DEFAULT
public static final String MAXIMUM_CONNECTIONS
public static final int DEFAULT_MAXIMUM_CONNECTIONS
public static final String SECURE_CONNECTIONS
public static final boolean DEFAULT_SECURE_CONNECTIONS
public static final String ENDPOINT
public static final String PATH_STYLE_ACCESS
public static final String PROXY_HOST
public static final String PROXY_PORT
public static final String PROXY_USERNAME
public static final String PROXY_PASSWORD
public static final String PROXY_DOMAIN
public static final String PROXY_WORKSTATION
public static final String MAX_ERROR_RETRIES
public static final int DEFAULT_MAX_ERROR_RETRIES
public static final String ESTABLISH_TIMEOUT
public static final int DEFAULT_ESTABLISH_TIMEOUT
public static final String SOCKET_TIMEOUT
public static final int DEFAULT_SOCKET_TIMEOUT
public static final String SOCKET_SEND_BUFFER
public static final int DEFAULT_SOCKET_SEND_BUFFER
public static final String SOCKET_RECV_BUFFER
public static final int DEFAULT_SOCKET_RECV_BUFFER
public static final String MAX_PAGING_KEYS
public static final int DEFAULT_MAX_PAGING_KEYS
public static final String MAX_THREADS
public static final int DEFAULT_MAX_THREADS
public static final String KEEPALIVE_TIME
public static final int DEFAULT_KEEPALIVE_TIME
public static final String MAX_TOTAL_TASKS
public static final int DEFAULT_MAX_TOTAL_TASKS
public static final String MULTIPART_SIZE
public static final long DEFAULT_MULTIPART_SIZE
public static final String MIN_MULTIPART_THRESHOLD
public static final long DEFAULT_MIN_MULTIPART_THRESHOLD
public static final String ENABLE_MULTI_DELETE
public static final String BUFFER_DIR
@Deprecated public static final String FAST_UPLOAD
@Deprecated public static final boolean DEFAULT_FAST_UPLOAD
@Deprecated public static final String FAST_BUFFER_SIZE
public static final int DEFAULT_FAST_BUFFER_SIZE
@InterfaceStability.Unstable public static final String FAST_UPLOAD_BUFFER
FAST_UPLOAD_BUFFER_DISK
Value: "fs.s3a.fast.upload.buffer"@InterfaceStability.Unstable public static final String FAST_UPLOAD_BUFFER_DISK
@InterfaceStability.Unstable public static final String FAST_UPLOAD_BUFFER_ARRAY
@InterfaceStability.Unstable public static final String FAST_UPLOAD_BYTEBUFFER
FAST_UPLOAD_BUFFER_ARRAY: "bytebuffer".@InterfaceStability.Unstable public static final String DEFAULT_FAST_UPLOAD_BUFFER
@InterfaceStability.Unstable public static final String FAST_UPLOAD_ACTIVE_BLOCKS
Default is DEFAULT_FAST_UPLOAD_ACTIVE_BLOCKS
@InterfaceStability.Unstable public static final int DEFAULT_FAST_UPLOAD_ACTIVE_BLOCKS
public static final String CANNED_ACL
public static final String DEFAULT_CANNED_ACL
public static final String PURGE_EXISTING_MULTIPART
public static final boolean DEFAULT_PURGE_EXISTING_MULTIPART
public static final String PURGE_EXISTING_MULTIPART_AGE
public static final long DEFAULT_PURGE_EXISTING_MULTIPART_AGE
public static final String SERVER_SIDE_ENCRYPTION_ALGORITHM
@Deprecated public static final String SERVER_SIDE_ENCRYPTION_AES256
public static final String SERVER_SIDE_ENCRYPTION_KEY
SERVER_SIDE_ENCRYPTION_ALGORITHM is
SSE-KMS (will default to aws/s3
master key if left blank).
With with SSE_C, the base-64 encoded AES 256 key.
May be set within a JCEKS file.
Value: ""fs.s3a.server-side-encryption.key"".public static final String SIGNING_ALGORITHM
public static final String S3N_FOLDER_SUFFIX
public static final String FS_S3A_BLOCK_SIZE
public static final String FS_S3A
public static final String FS_S3A_PREFIX
public static final String FS_S3A_BUCKET_PREFIX
public static final int S3A_DEFAULT_PORT
public static final String USER_AGENT_PREFIX
public static final String METADATASTORE_AUTHORITATIVE
public static final boolean DEFAULT_METADATASTORE_AUTHORITATIVE
public static final String READAHEAD_RANGE
public static final long DEFAULT_READAHEAD_RANGE
@InterfaceStability.Unstable public static final String INPUT_FADVISE
@InterfaceStability.Unstable public static final String INPUT_FADV_NORMAL
@InterfaceStability.Unstable public static final String INPUT_FADV_SEQUENTIAL
@InterfaceStability.Unstable public static final String INPUT_FADV_RANDOM
seek() operations.
Value: "random"@InterfaceAudience.Private @InterfaceStability.Unstable public static final String S3_CLIENT_FACTORY_IMPL
@InterfaceAudience.Private @InterfaceStability.Unstable public static final Class<? extends S3ClientFactory> DEFAULT_S3_CLIENT_FACTORY_IMPL
@InterfaceAudience.Private public static final int MAX_MULTIPART_COUNT
public static final String S3_METADATA_STORE_IMPL
@InterfaceStability.Unstable public static final String S3GUARD_CLI_PRUNE_AGE
@InterfaceStability.Unstable public static final String S3GUARD_DDB_REGION_KEY
@InterfaceStability.Unstable public static final String S3GUARD_DDB_TABLE_NAME_KEY
@InterfaceStability.Unstable public static final String S3GUARD_DDB_TABLE_TAG
@InterfaceStability.Unstable public static final String S3GUARD_DDB_TEST_TABLE_NAME_KEY
@InterfaceStability.Unstable public static final String S3GUARD_DDB_TABLE_CREATE_KEY
@InterfaceStability.Unstable public static final String S3GUARD_DDB_TABLE_CAPACITY_READ_KEY
public static final long S3GUARD_DDB_TABLE_CAPACITY_READ_DEFAULT
@InterfaceStability.Unstable public static final String S3GUARD_DDB_TABLE_CAPACITY_WRITE_KEY
public static final long S3GUARD_DDB_TABLE_CAPACITY_WRITE_DEFAULT
public static final int S3GUARD_DDB_BATCH_WRITE_REQUEST_LIMIT
@InterfaceStability.Unstable public static final String S3GUARD_DDB_MAX_RETRIES
public static final int S3GUARD_DDB_MAX_RETRIES_DEFAULT
@InterfaceStability.Unstable public static final String S3GUARD_DDB_THROTTLE_RETRY_INTERVAL
public static final String S3GUARD_DDB_THROTTLE_RETRY_INTERVAL_DEFAULT
@InterfaceStability.Unstable public static final String S3GUARD_DDB_BACKGROUND_SLEEP_MSEC_KEY
public static final int S3GUARD_DDB_BACKGROUND_SLEEP_MSEC_DEFAULT
@InterfaceStability.Unstable public static final String S3GUARD_METASTORE_NULL
@InterfaceStability.Unstable public static final String S3GUARD_METASTORE_LOCAL
@InterfaceStability.Unstable public static final String S3GUARD_METASTORE_LOCAL_MAX_RECORDS
public static final int DEFAULT_S3GUARD_METASTORE_LOCAL_MAX_RECORDS
@InterfaceStability.Unstable public static final String S3GUARD_METASTORE_LOCAL_ENTRY_TTL
public static final int DEFAULT_S3GUARD_METASTORE_LOCAL_ENTRY_TTL
@InterfaceStability.Unstable public static final String S3GUARD_METASTORE_DYNAMO
@InterfaceStability.Unstable public static final String FAIL_INJECT_INCONSISTENCY_KEY
@InterfaceStability.Unstable public static final String FAIL_INJECT_INCONSISTENCY_MSEC
@InterfaceStability.Unstable public static final String FAIL_INJECT_INCONSISTENCY_PROBABILITY
@InterfaceStability.Unstable public static final String LIST_VERSION
@InterfaceStability.Unstable public static final int DEFAULT_LIST_VERSION
@InterfaceStability.Unstable public static final String FAIL_INJECT_THROTTLE_PROBABILITY
@InterfaceStability.Unstable public static final String FAIL_INJECT_CLIENT_FACTORY
public static final String RETRY_LIMIT
public static final int RETRY_LIMIT_DEFAULT
public static final String RETRY_INTERVAL
public static final String RETRY_INTERVAL_DEFAULT
public static final String RETRY_THROTTLE_LIMIT
public static final int RETRY_THROTTLE_LIMIT_DEFAULT
public static final String RETRY_THROTTLE_INTERVAL
public static final String RETRY_THROTTLE_INTERVAL_DEFAULT
public static final String ETAG_CHECKSUM_ENABLED
public static final boolean ETAG_CHECKSUM_ENABLED_DEFAULT
Copyright © 2008–2019 Apache Software Foundation. All rights reserved.