Package org.apache.iceberg.azure

Class AzureProperties

java.lang.Object

org.apache.iceberg.azure.AzureProperties

All Implemented Interfaces:

Serializable

public class AzureProperties
extends Object
implements Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADLS_CONNECTION_STRING_PREFIX
static final String	ADLS_READ_BLOCK_SIZE
static final String	ADLS_REFRESH_CREDENTIALS_ENABLED	Controls whether vended credentials should be refreshed or not.
static final String	ADLS_REFRESH_CREDENTIALS_ENDPOINT	When set, the VendedAdlsCredentialProvider will be used to fetch and refresh vended credentials from this endpoint.
static final String	ADLS_SAS_TOKEN_EXPIRES_AT_MS_PREFIX
static final String	ADLS_SAS_TOKEN_PREFIX
static final String	ADLS_SHARED_KEY_ACCOUNT_KEY
static final String	ADLS_SHARED_KEY_ACCOUNT_NAME
static final String	ADLS_TOKEN
static final String	ADLS_TOKEN_CREDENTIAL_PROVIDER	Configure the ADLS token credential provider used to get TokenCredential.
static final String	ADLS_TOKEN_PROVIDER_PREFIX	Used by the configured ADLS_TOKEN_CREDENTIAL_PROVIDER value that will be used by AdlsTokenCredentialProviders.defaultFactory() and other token credential provider classes to pass provider-specific properties.
static final String	ADLS_WRITE_BLOCK_SIZE
static final String	AZURE_KEYVAULT_KEY_WRAP_ALGORITHM
static final String	AZURE_KEYVAULT_URL

Constructor Summary

Constructors

Constructor	Description
AzureProperties()
AzureProperties(Map<String,String> properties)

Method Summary

Modifier and Type	Method	Description
Optional<Integer>	adlsReadBlockSize()
Optional<Long>	adlsWriteBlockSize()
void	applyClientConfiguration(String account, com.azure.storage.file.datalake.DataLakeFileSystemClientBuilder builder)	Applies configuration to the DataLakeFileSystemClientBuilder to provide the endpoint and credentials required to create an instance of the client.
Optional<String>	keyVaultUrl()
String	keyWrapAlgorithm()
Optional<VendedAdlsCredentialProvider>	vendedAdlsCredentialProvider()

Methods inherited from class java.lang.Object

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

Field Details

ADLS_SAS_TOKEN_PREFIX

public static final String ADLS_SAS_TOKEN_PREFIX

See Also:

• Constant Field Values

ADLS_SAS_TOKEN_EXPIRES_AT_MS_PREFIX

public static final String ADLS_SAS_TOKEN_EXPIRES_AT_MS_PREFIX

See Also:

• Constant Field Values

ADLS_CONNECTION_STRING_PREFIX

public static final String ADLS_CONNECTION_STRING_PREFIX

See Also:

• Constant Field Values

ADLS_READ_BLOCK_SIZE

public static final String ADLS_READ_BLOCK_SIZE

See Also:

• Constant Field Values

ADLS_WRITE_BLOCK_SIZE

public static final String ADLS_WRITE_BLOCK_SIZE

See Also:

• Constant Field Values

ADLS_SHARED_KEY_ACCOUNT_NAME

public static final String ADLS_SHARED_KEY_ACCOUNT_NAME

See Also:

• Constant Field Values

ADLS_SHARED_KEY_ACCOUNT_KEY

public static final String ADLS_SHARED_KEY_ACCOUNT_KEY

See Also:

• Constant Field Values

ADLS_TOKEN

public static final String ADLS_TOKEN

See Also:

• Constant Field Values

AZURE_KEYVAULT_URL

public static final String AZURE_KEYVAULT_URL

See Also:

• Constant Field Values

AZURE_KEYVAULT_KEY_WRAP_ALGORITHM

public static final String AZURE_KEYVAULT_KEY_WRAP_ALGORITHM

See Also:

• Constant Field Values

ADLS_TOKEN_CREDENTIAL_PROVIDER

public static final String ADLS_TOKEN_CREDENTIAL_PROVIDER

Configure the ADLS token credential provider used to get TokenCredential. A fully qualified concrete class with package that implements the AdlsTokenCredentialProvider interface is required.

The implementation class must have a no-arg constructor and will be initialized by calling the AdlsTokenCredentialProvider.initialize(Map) method with the catalog properties.

Example: adls.token-credential-provider=com.example.MyCustomTokenCredentialProvider

When set, the AdlsTokenCredentialProviders.from(Map) method will use this provider to get ADLS credentials instead of using the default.

See Also:

• Constant Field Values

ADLS_TOKEN_PROVIDER_PREFIX

public static final String ADLS_TOKEN_PROVIDER_PREFIX

Used by the configured ADLS_TOKEN_CREDENTIAL_PROVIDER value that will be used by AdlsTokenCredentialProviders.defaultFactory() and other token credential provider classes to pass provider-specific properties. Each property consists of a key name and an associated value.

See Also:

• Constant Field Values

ADLS_REFRESH_CREDENTIALS_ENDPOINT

public static final String ADLS_REFRESH_CREDENTIALS_ENDPOINT

When set, the VendedAdlsCredentialProvider will be used to fetch and refresh vended credentials from this endpoint.

See Also:

• Constant Field Values

ADLS_REFRESH_CREDENTIALS_ENABLED

public static final String ADLS_REFRESH_CREDENTIALS_ENABLED

Controls whether vended credentials should be refreshed or not. Defaults to true.

See Also:

• Constant Field Values

Constructor Details

AzureProperties

public AzureProperties()

AzureProperties

public AzureProperties(Map<String,String> properties)

Method Details

adlsReadBlockSize

public Optional<Integer> adlsReadBlockSize()

adlsWriteBlockSize

public Optional<Long> adlsWriteBlockSize()

vendedAdlsCredentialProvider

public Optional<VendedAdlsCredentialProvider> vendedAdlsCredentialProvider()

applyClientConfiguration

public void applyClientConfiguration(String account,
 com.azure.storage.file.datalake.DataLakeFileSystemClientBuilder builder)

Applies configuration to the DataLakeFileSystemClientBuilder to provide the endpoint and credentials required to create an instance of the client.

Default credentials are provided via the DefaultAzureCredential.

Parameters:

account - the service account key (e.g. a hostname or storage account key to get values)

builder - the builder instance

keyWrapAlgorithm

public String keyWrapAlgorithm()

keyVaultUrl

public Optional<String> keyVaultUrl()