Package org.apache.iceberg.gcp

Class GCPProperties

java.lang.Object

org.apache.iceberg.gcp.GCPProperties

All Implemented Interfaces:

Serializable

public class GCPProperties
extends Object
implements Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GCS_ANALYTICS_CORE_ENABLED	Controls whether analytics core library is enabled or not.
static final String	GCS_CHANNEL_READ_CHUNK_SIZE
static final String	GCS_CHANNEL_WRITE_CHUNK_SIZE
static final String	GCS_CLIENT_LIB_TOKEN
static final String	GCS_DECRYPTION_KEY
static final String	GCS_DELETE_BATCH_SIZE	Configure the batch size used when deleting multiple files from a given GCS bucket
static final int	GCS_DELETE_BATCH_SIZE_DEFAULT	Max possible batch size for deletion.
static final String	GCS_ENCRYPTION_KEY
static final String	GCS_IMPERSONATE_DELEGATES
static final String	GCS_IMPERSONATE_LIFETIME_SECONDS
static final int	GCS_IMPERSONATE_LIFETIME_SECONDS_DEFAULT
static final String	GCS_IMPERSONATE_SCOPES
static final String	GCS_IMPERSONATE_SERVICE_ACCOUNT
static final String	GCS_NO_AUTH
static final String	GCS_OAUTH2_REFRESH_CREDENTIALS_ENABLED	Controls whether vended credentials should be refreshed or not.
static final String	GCS_OAUTH2_REFRESH_CREDENTIALS_ENDPOINT
static final String	GCS_OAUTH2_TOKEN
static final String	GCS_OAUTH2_TOKEN_EXPIRES_AT
static final String	GCS_PROJECT_ID
static final String	GCS_SERVICE_HOST
static final String	GCS_USER_PROJECT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<Integer>	channelReadChunkSize()
Optional<Integer>	channelWriteChunkSize()
Optional<String>	clientLibToken()
Optional<String>	decryptionKey()
int	deleteBatchSize()
Optional<String>	encryptionKey()
List<String>	impersonateDelegates()
int	impersonateLifetimeSeconds()
List<String>	impersonateScopes()
Optional<String>	impersonateServiceAccount()
boolean	isGcsAnalyticsCoreEnabled()
boolean	noAuth()
boolean	oauth2RefreshCredentialsEnabled()
Optional<String>	oauth2RefreshCredentialsEndpoint()
Optional<String>	oauth2Token()
Optional<Date>	oauth2TokenExpiresAt()
Optional<String>	projectId()
Map<String,String>	properties()
Optional<String>	serviceHost()
Optional<String>	userProject()

Methods inherited from class java.lang.Object

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

Field Details

GCS_PROJECT_ID

public static final String GCS_PROJECT_ID

See Also:

• Constant Field Values

GCS_CLIENT_LIB_TOKEN

public static final String GCS_CLIENT_LIB_TOKEN

See Also:

• Constant Field Values

GCS_SERVICE_HOST

public static final String GCS_SERVICE_HOST

See Also:

• Constant Field Values

GCS_DECRYPTION_KEY

public static final String GCS_DECRYPTION_KEY

See Also:

• Constant Field Values

GCS_ENCRYPTION_KEY

public static final String GCS_ENCRYPTION_KEY

See Also:

• Constant Field Values

GCS_USER_PROJECT

public static final String GCS_USER_PROJECT

See Also:

• Constant Field Values

GCS_CHANNEL_READ_CHUNK_SIZE

public static final String GCS_CHANNEL_READ_CHUNK_SIZE

See Also:

• Constant Field Values

GCS_CHANNEL_WRITE_CHUNK_SIZE

public static final String GCS_CHANNEL_WRITE_CHUNK_SIZE

See Also:

• Constant Field Values

GCS_OAUTH2_TOKEN

public static final String GCS_OAUTH2_TOKEN

See Also:

• Constant Field Values

GCS_OAUTH2_TOKEN_EXPIRES_AT

public static final String GCS_OAUTH2_TOKEN_EXPIRES_AT

See Also:

• Constant Field Values

GCS_NO_AUTH

public static final String GCS_NO_AUTH

See Also:

• Constant Field Values

GCS_OAUTH2_REFRESH_CREDENTIALS_ENDPOINT

public static final String GCS_OAUTH2_REFRESH_CREDENTIALS_ENDPOINT

See Also:

• Constant Field Values

GCS_IMPERSONATE_SERVICE_ACCOUNT

public static final String GCS_IMPERSONATE_SERVICE_ACCOUNT

See Also:

• Constant Field Values

GCS_IMPERSONATE_LIFETIME_SECONDS

public static final String GCS_IMPERSONATE_LIFETIME_SECONDS

See Also:

• Constant Field Values

GCS_IMPERSONATE_DELEGATES

public static final String GCS_IMPERSONATE_DELEGATES

See Also:

• Constant Field Values

GCS_IMPERSONATE_SCOPES

public static final String GCS_IMPERSONATE_SCOPES

See Also:

• Constant Field Values

GCS_IMPERSONATE_LIFETIME_SECONDS_DEFAULT

public static final int GCS_IMPERSONATE_LIFETIME_SECONDS_DEFAULT

See Also:

• Constant Field Values

GCS_OAUTH2_REFRESH_CREDENTIALS_ENABLED

public static final String GCS_OAUTH2_REFRESH_CREDENTIALS_ENABLED

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

See Also:

• Constant Field Values

GCS_DELETE_BATCH_SIZE

public static final String GCS_DELETE_BATCH_SIZE

Configure the batch size used when deleting multiple files from a given GCS bucket

See Also:

• Constant Field Values

GCS_ANALYTICS_CORE_ENABLED

public static final String GCS_ANALYTICS_CORE_ENABLED

Controls whether analytics core library is enabled or not. Defaults to false.

See Also:

• Constant Field Values

GCS_DELETE_BATCH_SIZE_DEFAULT

public static final int GCS_DELETE_BATCH_SIZE_DEFAULT

Max possible batch size for deletion. Currently, a max of 100 keys is advised, so we default to a number below that. https://cloud.google.com/storage/docs/batch

See Also:

• Constant Field Values

Constructor Details

GCPProperties

public GCPProperties()

GCPProperties

public GCPProperties(Map<String,String> properties)

Method Details

channelReadChunkSize

public Optional<Integer> channelReadChunkSize()

channelWriteChunkSize

public Optional<Integer> channelWriteChunkSize()

clientLibToken

public Optional<String> clientLibToken()

decryptionKey

public Optional<String> decryptionKey()

encryptionKey

public Optional<String> encryptionKey()

projectId

public Optional<String> projectId()

serviceHost

public Optional<String> serviceHost()

userProject

public Optional<String> userProject()

oauth2Token

public Optional<String> oauth2Token()

noAuth

public boolean noAuth()

oauth2TokenExpiresAt

public Optional<Date> oauth2TokenExpiresAt()

impersonateServiceAccount

public Optional<String> impersonateServiceAccount()

impersonateLifetimeSeconds

public int impersonateLifetimeSeconds()

impersonateDelegates

public List<String> impersonateDelegates()

impersonateScopes

public List<String> impersonateScopes()

deleteBatchSize

public int deleteBatchSize()

oauth2RefreshCredentialsEndpoint

public Optional<String> oauth2RefreshCredentialsEndpoint()

oauth2RefreshCredentialsEnabled

public boolean oauth2RefreshCredentialsEnabled()

properties

public Map<String,String> properties()

isGcsAnalyticsCoreEnabled

public boolean isGcsAnalyticsCoreEnabled()