org.apache.hadoop.fs.azurebfs.constants

Class ConfigurationKeys

java.lang.Object

org.apache.hadoop.fs.azurebfs.constants.ConfigurationKeys

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public final class ConfigurationKeys
extends Object

Responsible to keep all the Azure Blob File System configurations keys in Hadoop configuration file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AZURE_ABFS_ENDPOINT End point of ABFS account: "fs.azure.abfs.endpoint".
static String	AZURE_BACKOFF_INTERVAL
static String	AZURE_BLOCK_LOCATION_HOST_PROPERTY_NAME
static String	AZURE_BLOCK_SIZE_PROPERTY_NAME
static String	AZURE_CONCURRENT_CONNECTION_VALUE_IN
static String	AZURE_CONCURRENT_CONNECTION_VALUE_OUT
static String	AZURE_CREATE_REMOTE_FILESYSTEM_DURING_INITIALIZATION
static String	AZURE_CUSTOM_TOKEN_FETCH_RETRY_COUNT
static String	AZURE_KEY_ACCOUNT_KEYPROVIDER
static String	AZURE_KEY_ACCOUNT_SHELLKEYPROVIDER_SCRIPT
static String	AZURE_LIST_MAX_RESULTS
static String	AZURE_MAX_BACKOFF_INTERVAL
static String	AZURE_MAX_IO_RETRIES
static String	AZURE_MIN_BACKOFF_INTERVAL
static String	AZURE_READ_BUFFER_SIZE
static String	AZURE_SKIP_USER_GROUP_METADATA_DURING_INITIALIZATION
static String	AZURE_TOLERATE_CONCURRENT_APPEND
static String	AZURE_WRITE_BUFFER_SIZE
static String	FS_AZURE_ABFS_LATENCY_TRACK Key for enabling the tracking of ABFS API latency and sending the latency numbers to the ABFS API service
static String	FS_AZURE_ACCOUNT_AUTH_TYPE_PROPERTY_NAME Key for auth type properties: "fs.azure.account.auth.type".
static String	FS_AZURE_ACCOUNT_KEY_PROPERTY_NAME
static String	FS_AZURE_ACCOUNT_KEY_PROPERTY_NAME_REGX
static String	FS_AZURE_ACCOUNT_OAUTH_CLIENT_ENDPOINT Key for oauth AAD client endpoint: "fs.azure.account.oauth2.client.endpoint".
static String	FS_AZURE_ACCOUNT_OAUTH_CLIENT_ID Key for oauth AAD client id: "fs.azure.account.oauth2.client.id".
static String	FS_AZURE_ACCOUNT_OAUTH_CLIENT_SECRET Key for oauth AAD client secret: "fs.azure.account.oauth2.client.secret".
static String	FS_AZURE_ACCOUNT_OAUTH_MSI_AUTHORITY Key for oauth msi Authority: "fs.azure.account.oauth2.msi.authority".
static String	FS_AZURE_ACCOUNT_OAUTH_MSI_ENDPOINT Key for oauth msi endpoint: "fs.azure.account.oauth2.msi.endpoint".
static String	FS_AZURE_ACCOUNT_OAUTH_MSI_TENANT Key for oauth msi tenant id: "fs.azure.account.oauth2.msi.tenant".
static String	FS_AZURE_ACCOUNT_OAUTH_REFRESH_TOKEN Key for oauth refresh token: "fs.azure.account.oauth2.refresh.token".
static String	FS_AZURE_ACCOUNT_OAUTH_REFRESH_TOKEN_ENDPOINT Key for oauth AAD refresh token endpoint: "fs.azure.account.oauth2.refresh.token.endpoint".
static String	FS_AZURE_ACCOUNT_OAUTH_USER_NAME Key for oauth user name: "fs.azure.account.oauth2.user.name".
static String	FS_AZURE_ACCOUNT_OAUTH_USER_PASSWORD Key for oauth user password: "fs.azure.account.oauth2.user.password".
static String	FS_AZURE_ACCOUNT_TOKEN_PROVIDER_TYPE_PROPERTY_NAME Key for oauth token provider type: "fs.azure.account.oauth.provider.type".
static String	FS_AZURE_ALWAYS_USE_HTTPS
static String	FS_AZURE_ATOMIC_RENAME_KEY
static String	FS_AZURE_CLUSTER_NAME
static String	FS_AZURE_CLUSTER_TYPE
static String	FS_AZURE_DELEGATION_TOKEN_PROVIDER_TYPE
static String	FS_AZURE_DISABLE_OUTPUTSTREAM_FLUSH Provides a config control to disable or enable OutputStream Flush API operations in AbfsOutputStream.
static String	FS_AZURE_ENABLE_AUTOTHROTTLING
static String	FS_AZURE_ENABLE_CHECK_ACCESS Provides a config to enable/disable the checkAccess API.
static String	FS_AZURE_ENABLE_DELEGATION_TOKEN
static String	FS_AZURE_ENABLE_FLUSH Provides a config control to enable or disable ABFS Flush operations - HFlush and HSync.
static String	FS_AZURE_FILE_OWNER_DOMAINNAME If the domain name is specified and “fs.azure.identity.transformer.enable.short.name” is true, then the {alias} part of a UPN can be specified as input to APIs like setOwner and setAcl and it will be transformed to a UPN by appending @ and the domain specified by this configuration property.
static String	FS_AZURE_FILE_OWNER_ENABLE_SHORTNAME User principal names (UPNs) have the format “{alias}@{domain}”.
static String	FS_AZURE_OVERRIDE_OWNER_SP An Azure Active Directory object ID (oid) used as the replacement for names contained in the list specified by “fs.azure.identity.transformer.service.principal.substitution.list.
static String	FS_AZURE_OVERRIDE_OWNER_SP_LIST A comma separated list of names to be replaced with the service principal ID specified by “fs.default.identity.transformer.service.principal.id”.
static String	FS_AZURE_READ_AHEAD_QUEUE_DEPTH
static String	FS_AZURE_SAS_TOKEN_PROVIDER_TYPE Key for SAS token provider
static String	FS_AZURE_SECURE_MODE
static String	FS_AZURE_SKIP_SUPER_USER_REPLACEMENT By default this is set as false, so “$superuser” is replaced with the current user when it appears as the owner or owning group of a file or directory.
static String	FS_AZURE_SSL_CHANNEL_MODE_KEY
static String	FS_AZURE_USE_UPN
static String	FS_AZURE_USER_AGENT_PREFIX_KEY

Method Summary

Modifier and Type	Method and Description
static String	accountProperty(String property, String account)

Methods inherited from class java.lang.Object

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

Field Detail

FS_AZURE_ACCOUNT_KEY_PROPERTY_NAME

public static final String FS_AZURE_ACCOUNT_KEY_PROPERTY_NAME

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_KEY_PROPERTY_NAME_REGX

public static final String FS_AZURE_ACCOUNT_KEY_PROPERTY_NAME_REGX

See Also:

Constant Field Values

FS_AZURE_SECURE_MODE

public static final String FS_AZURE_SECURE_MODE

See Also:

Constant Field Values

AZURE_MIN_BACKOFF_INTERVAL

public static final String AZURE_MIN_BACKOFF_INTERVAL

See Also:

Constant Field Values

AZURE_MAX_BACKOFF_INTERVAL

public static final String AZURE_MAX_BACKOFF_INTERVAL

See Also:

Constant Field Values

AZURE_BACKOFF_INTERVAL

public static final String AZURE_BACKOFF_INTERVAL

See Also:

Constant Field Values

AZURE_MAX_IO_RETRIES

public static final String AZURE_MAX_IO_RETRIES

See Also:

Constant Field Values

AZURE_CUSTOM_TOKEN_FETCH_RETRY_COUNT

public static final String AZURE_CUSTOM_TOKEN_FETCH_RETRY_COUNT

See Also:

Constant Field Values

AZURE_WRITE_BUFFER_SIZE

public static final String AZURE_WRITE_BUFFER_SIZE

See Also:

Constant Field Values

AZURE_READ_BUFFER_SIZE

public static final String AZURE_READ_BUFFER_SIZE

See Also:

Constant Field Values

AZURE_BLOCK_SIZE_PROPERTY_NAME

public static final String AZURE_BLOCK_SIZE_PROPERTY_NAME

See Also:

Constant Field Values

AZURE_BLOCK_LOCATION_HOST_PROPERTY_NAME

public static final String AZURE_BLOCK_LOCATION_HOST_PROPERTY_NAME

See Also:

Constant Field Values

AZURE_CONCURRENT_CONNECTION_VALUE_OUT

public static final String AZURE_CONCURRENT_CONNECTION_VALUE_OUT

See Also:

Constant Field Values

AZURE_CONCURRENT_CONNECTION_VALUE_IN

public static final String AZURE_CONCURRENT_CONNECTION_VALUE_IN

See Also:

Constant Field Values

AZURE_TOLERATE_CONCURRENT_APPEND

public static final String AZURE_TOLERATE_CONCURRENT_APPEND

See Also:

Constant Field Values

AZURE_LIST_MAX_RESULTS

public static final String AZURE_LIST_MAX_RESULTS

See Also:

Constant Field Values

AZURE_CREATE_REMOTE_FILESYSTEM_DURING_INITIALIZATION

public static final String AZURE_CREATE_REMOTE_FILESYSTEM_DURING_INITIALIZATION

See Also:

Constant Field Values

AZURE_SKIP_USER_GROUP_METADATA_DURING_INITIALIZATION

public static final String AZURE_SKIP_USER_GROUP_METADATA_DURING_INITIALIZATION

See Also:

Constant Field Values

FS_AZURE_ENABLE_AUTOTHROTTLING

public static final String FS_AZURE_ENABLE_AUTOTHROTTLING

See Also:

Constant Field Values

FS_AZURE_ALWAYS_USE_HTTPS

public static final String FS_AZURE_ALWAYS_USE_HTTPS

See Also:

Constant Field Values

FS_AZURE_ATOMIC_RENAME_KEY

public static final String FS_AZURE_ATOMIC_RENAME_KEY

See Also:

Constant Field Values

FS_AZURE_READ_AHEAD_QUEUE_DEPTH

public static final String FS_AZURE_READ_AHEAD_QUEUE_DEPTH

See Also:

Constant Field Values

FS_AZURE_ENABLE_FLUSH

public static final String FS_AZURE_ENABLE_FLUSH

Provides a config control to enable or disable ABFS Flush operations - HFlush and HSync. Default is true.

See Also:

Constant Field Values

FS_AZURE_DISABLE_OUTPUTSTREAM_FLUSH

public static final String FS_AZURE_DISABLE_OUTPUTSTREAM_FLUSH

Provides a config control to disable or enable OutputStream Flush API operations in AbfsOutputStream. Flush() will trigger actions that guarantee that buffered data is persistent with a perf cost while the API documentation does not have such expectations of data being persisted. Default value of this config is true.

See Also:

Constant Field Values

FS_AZURE_USER_AGENT_PREFIX_KEY

public static final String FS_AZURE_USER_AGENT_PREFIX_KEY

See Also:

Constant Field Values

FS_AZURE_CLUSTER_NAME

public static final String FS_AZURE_CLUSTER_NAME

See Also:

Constant Field Values

FS_AZURE_CLUSTER_TYPE

public static final String FS_AZURE_CLUSTER_TYPE

See Also:

Constant Field Values

FS_AZURE_SSL_CHANNEL_MODE_KEY

public static final String FS_AZURE_SSL_CHANNEL_MODE_KEY

See Also:

Constant Field Values

FS_AZURE_ENABLE_CHECK_ACCESS

public static final String FS_AZURE_ENABLE_CHECK_ACCESS

Provides a config to enable/disable the checkAccess API. By default this will be FileSystemConfigurations.DEFAULT_ENABLE_CHECK_ACCESS.

See Also:

Constant Field Values

FS_AZURE_USE_UPN

public static final String FS_AZURE_USE_UPN

See Also:

Constant Field Values

FS_AZURE_FILE_OWNER_ENABLE_SHORTNAME

public static final String FS_AZURE_FILE_OWNER_ENABLE_SHORTNAME

User principal names (UPNs) have the format “{alias}@{domain}”. If true, only {alias} is included when a UPN would otherwise appear in the output of APIs like getFileStatus, getOwner, getAclStatus, etc. Default is false.

See Also:

Constant Field Values

FS_AZURE_FILE_OWNER_DOMAINNAME

public static final String FS_AZURE_FILE_OWNER_DOMAINNAME

If the domain name is specified and “fs.azure.identity.transformer.enable.short.name” is true, then the {alias} part of a UPN can be specified as input to APIs like setOwner and setAcl and it will be transformed to a UPN by appending @ and the domain specified by this configuration property.

See Also:

Constant Field Values

FS_AZURE_OVERRIDE_OWNER_SP

public static final String FS_AZURE_OVERRIDE_OWNER_SP

An Azure Active Directory object ID (oid) used as the replacement for names contained in the list specified by “fs.azure.identity.transformer.service.principal.substitution.list. Notice that instead of setting oid, you can also set $superuser.

See Also:

Constant Field Values

FS_AZURE_OVERRIDE_OWNER_SP_LIST

public static final String FS_AZURE_OVERRIDE_OWNER_SP_LIST

A comma separated list of names to be replaced with the service principal ID specified by “fs.default.identity.transformer.service.principal.id”. This substitution occurs when setOwner, setAcl, modifyAclEntries, or removeAclEntries are invoked with identities contained in the substitution list. Notice that when in non-secure cluster, asterisk symbol "*" can be used to match all user/group.

See Also:

Constant Field Values

FS_AZURE_SKIP_SUPER_USER_REPLACEMENT

public static final String FS_AZURE_SKIP_SUPER_USER_REPLACEMENT

By default this is set as false, so “$superuser” is replaced with the current user when it appears as the owner or owning group of a file or directory. To disable it, set it as true.

See Also:

Constant Field Values

AZURE_KEY_ACCOUNT_KEYPROVIDER

public static final String AZURE_KEY_ACCOUNT_KEYPROVIDER

See Also:

Constant Field Values

AZURE_KEY_ACCOUNT_SHELLKEYPROVIDER_SCRIPT

public static final String AZURE_KEY_ACCOUNT_SHELLKEYPROVIDER_SCRIPT

See Also:

Constant Field Values

AZURE_ABFS_ENDPOINT

public static final String AZURE_ABFS_ENDPOINT

End point of ABFS account: "fs.azure.abfs.endpoint".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_AUTH_TYPE_PROPERTY_NAME

public static final String FS_AZURE_ACCOUNT_AUTH_TYPE_PROPERTY_NAME

Key for auth type properties: "fs.azure.account.auth.type".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_TOKEN_PROVIDER_TYPE_PROPERTY_NAME

public static final String FS_AZURE_ACCOUNT_TOKEN_PROVIDER_TYPE_PROPERTY_NAME

Key for oauth token provider type: "fs.azure.account.oauth.provider.type".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_CLIENT_ID

public static final String FS_AZURE_ACCOUNT_OAUTH_CLIENT_ID

Key for oauth AAD client id: "fs.azure.account.oauth2.client.id".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_CLIENT_SECRET

public static final String FS_AZURE_ACCOUNT_OAUTH_CLIENT_SECRET

Key for oauth AAD client secret: "fs.azure.account.oauth2.client.secret".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_CLIENT_ENDPOINT

public static final String FS_AZURE_ACCOUNT_OAUTH_CLIENT_ENDPOINT

Key for oauth AAD client endpoint: "fs.azure.account.oauth2.client.endpoint".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_MSI_TENANT

public static final String FS_AZURE_ACCOUNT_OAUTH_MSI_TENANT

Key for oauth msi tenant id: "fs.azure.account.oauth2.msi.tenant".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_MSI_ENDPOINT

public static final String FS_AZURE_ACCOUNT_OAUTH_MSI_ENDPOINT

Key for oauth msi endpoint: "fs.azure.account.oauth2.msi.endpoint".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_MSI_AUTHORITY

public static final String FS_AZURE_ACCOUNT_OAUTH_MSI_AUTHORITY

Key for oauth msi Authority: "fs.azure.account.oauth2.msi.authority".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_USER_NAME

public static final String FS_AZURE_ACCOUNT_OAUTH_USER_NAME

Key for oauth user name: "fs.azure.account.oauth2.user.name".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_USER_PASSWORD

public static final String FS_AZURE_ACCOUNT_OAUTH_USER_PASSWORD

Key for oauth user password: "fs.azure.account.oauth2.user.password".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_REFRESH_TOKEN

public static final String FS_AZURE_ACCOUNT_OAUTH_REFRESH_TOKEN

Key for oauth refresh token: "fs.azure.account.oauth2.refresh.token".

See Also:

Constant Field Values

FS_AZURE_ACCOUNT_OAUTH_REFRESH_TOKEN_ENDPOINT

public static final String FS_AZURE_ACCOUNT_OAUTH_REFRESH_TOKEN_ENDPOINT

Key for oauth AAD refresh token endpoint: "fs.azure.account.oauth2.refresh.token.endpoint".

See Also:

Constant Field Values

FS_AZURE_ABFS_LATENCY_TRACK

public static final String FS_AZURE_ABFS_LATENCY_TRACK

Key for enabling the tracking of ABFS API latency and sending the latency numbers to the ABFS API service

See Also:

Constant Field Values

FS_AZURE_ENABLE_DELEGATION_TOKEN

public static final String FS_AZURE_ENABLE_DELEGATION_TOKEN

See Also:

Constant Field Values

FS_AZURE_DELEGATION_TOKEN_PROVIDER_TYPE

public static final String FS_AZURE_DELEGATION_TOKEN_PROVIDER_TYPE

See Also:

Constant Field Values

FS_AZURE_SAS_TOKEN_PROVIDER_TYPE

public static final String FS_AZURE_SAS_TOKEN_PROVIDER_TYPE

Key for SAS token provider

See Also:

Constant Field Values

Method Detail

accountProperty

public static String accountProperty(String property,
                                     String account)