com.oracle.bmc.hdfs

Enum BmcProperties

java.lang.Object

java.lang.Enum<BmcProperties>

com.oracle.bmc.hdfs.BmcProperties

All Implemented Interfaces:

Serializable, Comparable<BmcProperties>

public enum BmcProperties
extends Enum<BmcProperties>

Enum to encapsulate all of the configuration options available to users.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APACHE_CONNECTION_CLOSING_STRATEGY (string, optional) Connection Closing Strategy for the Apache Connection.
APACHE_MAX_CONNECTION_POOL_SIZE (int, optional) The maximum number of connections that will be pooled in the connection pool used by the Apache Client to create connections with the service.
BLOCK_SIZE_IN_MB (long, optional) HDFS file block size, in mebibytes.
CONNECTION_TIMEOUT_MILLIS (int, optional) The max time to wait for a connection, in millis.
FILESYSTEM_CACHING_ENABLED (boolean, optional) Whether BmcFilesystem caching is enabled.
FILESYSTEM_CACHING_EXPIRE_AFTER_ACCESS_SECONDS (int, optional) Whether cached BmcFilesystem items should be expired if a certain number of seconds has passed since the last access, regardless of whether it was a read or a write.
FILESYSTEM_CACHING_EXPIRE_AFTER_WRITE_SECONDS (int, optional) Whether cached BmcFilesystem items should be expired if a certain number of seconds has passed since the last write access.
FILESYSTEM_CACHING_INITIAL_CAPACITY (int, optional) Initial capacity of cached BmcFilesystem items.
FILESYSTEM_CACHING_MAXIMUM_SIZE (int, optional) Maximum number of cached BmcFilesystem items.
FINGERPRINT (string, required) The fingerprint used for authentication.
HOST_NAME (string, required) Object Store endpoint name (http://server.path.com) .
HTTP_PROXY_PASSWORD (string, optional) The password to use with the associated HTTP_PROXY_USERNAME.
HTTP_PROXY_URI (string, optional) The HTTP proxy URI if using a proxy to connect to Object Storage Service.
HTTP_PROXY_USERNAME (string, optional) The username to use for the configured HTTP proxy via HTTP_PROXY_URI.
IN_MEMORY_READ_BUFFER (boolean, optional) Flag to enable reading all files to memory first (instead streaming from Object Store), to allow faster seeking.
IN_MEMORY_WRITE_BUFFER (boolean, optional) Flag to enable writing all files to memory (instead of a temp file) before uploading to Object Store.
JERSEY_CLIENT_DEFAULT_CONNECTOR_ENABLED (boolean, optional) Flag to enable Jersey default HttpUrlConnector for sending requests using jersey client.
JERSEY_CLIENT_LOGGING_ENABLED (boolean, optional) Flag to enable jersey client logging.
JERSEY_CLIENT_LOGGING_LEVEL (string, optional) Log Level for jersey client logger.
JERSEY_CLIENT_LOGGING_VERBOSITY (string, optional) Verbosity for jersey client logger.
MD5_NUM_THREADS (int, optional) The number of threads to use for parallel MD5 calculation.
MULTIPART_ALLOW_OVERWRITE (boolean, optional) Flag to enable overwrites while using Multipart Uploads.
MULTIPART_ALLOWED (boolean, optional) Flag for whether or not multi-part uploads are allowed at all.
MULTIPART_IN_MEMORY_WRITE_BUFFER_ENABLED (boolean, optional) Flag to enable pseudo-streaming to OCI via Multipart Uploads backed by a circular buffer.
MULTIPART_IN_MEMORY_WRITE_TASK_TIMEOUT_SECONDS (int, optional) The amount of time in seconds to block waiting for a slot in the multipart upload executor.
MULTIPART_MIN_PART_SIZE_IN_MB Deprecated. use MULTIPART_PART_SIZE_IN_MB instead
MULTIPART_MIN_SIZE_OF_OBJECT_IN_MB (int, optional) The minimum size, in mebibytes, an object must be before its eligible for multi-part uploads.
MULTIPART_NUM_UPLOAD_THREADS (int, optional) The number of threads to use for parallel multi-part uploads.
MULTIPART_PART_SIZE_IN_MB (int, optional) The part size, in mebibytes that each part should be uploaded as.
NUM_READ_AHEAD_THREADS (int, optional) The number of threads to use for parallel GET operations when reading ahead.
OBJECT_AUTO_CLOSE_INPUT_STREAM (boolean, optional) Flag to enable/disable auto-close of object streams on full read.
OBJECT_METADATA_CACHING_ENABLED (boolean, optional) Flag to enable object metadata caching.
OBJECT_METADATA_CACHING_SPEC (string, optional) Controls object metadata caching and eviction.
OBJECT_PARQUET_CACHING_ENABLED (boolean, optional) Flag to enable parquet caching.
OBJECT_PARQUET_CACHING_SPEC (string, optional) Controls object parquet caching and eviction.
OBJECT_PAYLOAD_CACHING_CONSISTENCY_POLICY_CLASS (string, optional) The consistency policy to use for the object payload cache.
OBJECT_PAYLOAD_CACHING_DIRECTORY (string, optional) The directory for the object payload cache.
OBJECT_PAYLOAD_CACHING_ENABLED (boolean, optional) Whether payload caching on disk is enabled.
OBJECT_PAYLOAD_CACHING_EXPIRE_AFTER_ACCESS_SECONDS (int, optional) Whether cached items should be expired if a certain number of seconds has passed since the last access, regardless of whether it was a read or a write.
OBJECT_PAYLOAD_CACHING_EXPIRE_AFTER_WRITE_SECONDS (int, optional) Whether cached items should be expired if a certain number of seconds has passed since the last write access.
OBJECT_PAYLOAD_CACHING_INITIAL_CAPACITY (int, optional) Initial capacity of cached items.
OBJECT_PAYLOAD_CACHING_MAXIMUM_SIZE (int, optional) Maximum number of cached items.
OBJECT_PAYLOAD_CACHING_MAXIMUM_WEIGHT_IN_BYTES (long, optional) Maximum weight of the cache in bytes.
OBJECT_PAYLOAD_CACHING_RECORD_STATS_ENABLED (boolean, optional) Whether to record cache statistics.
OBJECT_PAYLOAD_CACHING_RECORD_STATS_TIME_INTERVAL_IN_SECONDS (long, optional) The time interval (in seconds) between successive logging of cache statistics.
OBJECT_STORE_AUTHENTICATOR_CLASS (string, optional) Fully qualified class name of a custom implementation of BasicAuthenticationDetailsProvider.
OBJECT_STORE_CLIENT_CLASS (string, optional) Fully qualified class name of a custom implementation of ObjectStorage.
OCI_DELEGATION_TOKEN_FILEPATH (String, optional) File path that has the delegation token.
PASS_PHRASE (string, optional) Pass phrase to use for the PEM file if it's encrypted.
PEM_FILE_PATH (string, required) Path to the PEM file used for authentication.
READ_AHEAD (boolean, optional) Flag to enable read ahead.
READ_AHEAD_BLOCK_COUNT (int, optional) Number of blocks to read if READ_AHEAD is enabled.
READ_AHEAD_BLOCK_SIZE (int, optional) Size in bytes of the blocks to read if READ_AHEAD is enabled.
READ_STREAM_CLASS (string, optional) The custom stream class for reading.
READ_TIMEOUT_MILLIS (int, optional) The max time to wait for data, in millis.
REALM_SPECIFIC_ENDPOINT_TEMPLATES_ENABLED (boolean, optional) Flag to enable/disable the use of realm-specific endpoint templates, if defined.
RECURSIVE_DIR_LISTING_FETCH_SIZE (int, optional) Whenever listFiles with recursive being true is invoked on a dir, a listing API is called on OSS that gets all the files in a flat manner.
REGION_CODE_OR_ID (string, optional) The region code or region identifier used to establish Object Storage endpoint name.
RENAME_DIRECTORY_NUM_THREADS (int, optional) The number of threads to use for parallel rename operations when renaming the directory.
RETRY_TIMEOUT_IN_SECONDS (long, optional) The timeout to use for exponential delay retries for retryable service errors.
RETRY_TIMEOUT_RESET_THRESHOLD_IN_SECONDS (long, optional) The max sleep for delays in between retries for retryable service errors.
TENANT_ID (string, required) The tenant ID used for authentication.
USER_ID (string, required) The user ID used for authentication.
WRITE_STREAM_CLASS (string, optional) The custom stream class for writing.

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue()
String	getPropertyName()
static BmcProperties	valueOf(String name) Returns the enum constant of this type with the specified name.
static BmcProperties[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BLOCK_SIZE_IN_MB

public static final BmcProperties BLOCK_SIZE_IN_MB

(long, optional) HDFS file block size, in mebibytes. See BmcConstants.BLOCK_SIZE_IN_MB_KEY for config key name. Default is 32.

http://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html#Data_Blocks

IN_MEMORY_WRITE_BUFFER

public static final BmcProperties IN_MEMORY_WRITE_BUFFER

(boolean, optional) Flag to enable writing all files to memory (instead of a temp file) before uploading to Object Store. See BmcConstants.IN_MEMORY_WRITE_BUFFER_KEY for config key name. Default is false. Cannot be enabled at the same time as MULTIPART_IN_MEMORY_WRITE_BUFFER_ENABLED.

IN_MEMORY_READ_BUFFER

public static final BmcProperties IN_MEMORY_READ_BUFFER

(boolean, optional) Flag to enable reading all files to memory first (instead streaming from Object Store), to allow faster seeking. See BmcConstants.IN_MEMORY_READ_BUFFER_KEY for config key name. Default is false. Incompatible with READ_AHEAD.

OBJECT_STORE_CLIENT_CLASS

public static final BmcProperties OBJECT_STORE_CLIENT_CLASS

(string, optional) Fully qualified class name of a custom implementation of ObjectStorage. See BmcConstants.OBJECT_STORE_CLIENT_CLASS_KEY for config key name.

OBJECT_STORE_AUTHENTICATOR_CLASS

public static final BmcProperties OBJECT_STORE_AUTHENTICATOR_CLASS

(string, optional) Fully qualified class name of a custom implementation of BasicAuthenticationDetailsProvider. See BmcConstants.OBJECT_STORE_AUTHENTICATOR_CLASS_KEY for config key name.

HOST_NAME

public static final BmcProperties HOST_NAME

(string, required) Object Store endpoint name (http://server.path.com) . Note, if a custom client class is used, then this field is not required. See BmcConstants.HOST_NAME_KEY for config key name.

TENANT_ID

public static final BmcProperties TENANT_ID

(string, required) The tenant ID used for authentication. Note, if a custom authenticator class is used, then this field is not required. See BmcConstants.TENANT_ID_KEY for config key name.

USER_ID

public static final BmcProperties USER_ID

(string, required) The user ID used for authentication. Note, if a custom authenticator class is used, then this field is not required. See BmcConstants.USER_ID_KEY for config key name.

FINGERPRINT

public static final BmcProperties FINGERPRINT

(string, required) The fingerprint used for authentication. Note, if a custom authenticator class is used, then this field is not required. See BmcConstants.FINGERPRINT_KEY for config key name.

PEM_FILE_PATH

public static final BmcProperties PEM_FILE_PATH

(string, required) Path to the PEM file used for authentication. The path is for the local filesystem. Note, if a authenticator client class is used, then this field is not required. See BmcConstants.PEM_FILE_PATH_KEY for config key name.

PASS_PHRASE

public static final BmcProperties PASS_PHRASE

(string, optional) Pass phrase to use for the PEM file if it's encrypted. See BmcConstants.PASS_PHRASE_KEY for config key name.

REGION_CODE_OR_ID

public static final BmcProperties REGION_CODE_OR_ID

(string, optional) The region code or region identifier used to establish Object Storage endpoint name. Note, if "fs.oci.client.hostname property" is set, then this field is not required. See BmcConstants.REGION_CODE_OR_ID_KEY for config key name.

CONNECTION_TIMEOUT_MILLIS

public static final BmcProperties CONNECTION_TIMEOUT_MILLIS

(int, optional) The max time to wait for a connection, in millis. See BmcConstants.CONNECTION_TIMEOUT_MILLIS_KEY for config key name. Defaults to Java SDK timeout, see ClientConfiguration.

READ_TIMEOUT_MILLIS

public static final BmcProperties READ_TIMEOUT_MILLIS

(int, optional) The max time to wait for data, in millis. See BmcConstants.READ_TIMEOUT_MILLIS_KEY for config key name. Defaults to Java SDK timeout, see ClientConfiguration.

MULTIPART_ALLOWED

public static final BmcProperties MULTIPART_ALLOWED

(boolean, optional) Flag for whether or not multi-part uploads are allowed at all. See BmcConstants.MULTIPART_ALLOWED_KEY for config key name. Default true.

MULTIPART_NUM_UPLOAD_THREADS

public static final BmcProperties MULTIPART_NUM_UPLOAD_THREADS

(int, optional) The number of threads to use for parallel multi-part uploads. Note, any value less than or equal to 0 is interpreted as using the default Java SDK value. A value of 1 means do not use parallel uploads (you can still use multi-part if the "allowed" property is true, but each part will be uploaded serially. This will be one thread per upload). Otherwise, this represents the total number of threads shared amongst all requests (not per request). See BmcConstants.MULTIPART_NUM_UPLOAD_THREADS_KEY for config key name.

MD5_NUM_THREADS

public static final BmcProperties MD5_NUM_THREADS

(int, optional) The number of threads to use for parallel MD5 calculation. Note, any value less than or equal to 0 is interpreted as using a default value.A value of 1 means do not use parallel calculation (each hash will be calculated serially in a single thread). See BmcConstants.MD5_NUM_THREADS_KEY for config key name.

MULTIPART_MIN_SIZE_OF_OBJECT_IN_MB

public static final BmcProperties MULTIPART_MIN_SIZE_OF_OBJECT_IN_MB

(int, optional) The minimum size, in mebibytes, an object must be before its eligible for multi-part uploads. Note, any value less than or equal to 0 is interpreted as using the default Java SDK value. See BmcConstants.MULTIPART_MIN_SIZE_OF_OBJECT_IN_MB_KEY for config key name.

MULTIPART_MIN_PART_SIZE_IN_MB

@Deprecated
public static final BmcProperties MULTIPART_MIN_PART_SIZE_IN_MB

Deprecated. use MULTIPART_PART_SIZE_IN_MB instead

(int, optional) The minimum size, in mebibytes, each part should be uploaded as. Note, any value less than or equal to 0 is interpreted as using the default Java SDK value. See BmcConstants.MULTIPART_MIN_PART_SIZE_IN_MB_KEY for config key name.

MULTIPART_PART_SIZE_IN_MB

public static final BmcProperties MULTIPART_PART_SIZE_IN_MB

(int, optional) The part size, in mebibytes that each part should be uploaded as. Note, any value less than or equal to 0 is interpreted as using the default Java SDK value of 128MiB. See BmcConstants.MULTIPART_PART_SIZE_IN_MB_KEY for config key name.

HTTP_PROXY_URI

public static final BmcProperties HTTP_PROXY_URI

(string, optional) The HTTP proxy URI if using a proxy to connect to Object Storage Service. If configured, then an ObjectStorageClient will be configured to use the ApacheConnector provider add-on in order to configure the proxy for the client. Note: This buffers all requests (uploads) and can impact memory utiliziation. See BmcConstants.HTTP_PROXY_URI_KEY for the config key name.

HTTP_PROXY_USERNAME

public static final BmcProperties HTTP_PROXY_USERNAME

(string, optional) The username to use for the configured HTTP proxy via HTTP_PROXY_URI. See BmcConstants.HTTP_PROXY_USERNAME_KEY for the config key name.

HTTP_PROXY_PASSWORD

public static final BmcProperties HTTP_PROXY_PASSWORD

(string, optional) The password to use with the associated HTTP_PROXY_USERNAME. See BmcConstants.HTTP_PROXY_PASSWORD_KEY for the config key name.

RETRY_TIMEOUT_IN_SECONDS

public static final BmcProperties RETRY_TIMEOUT_IN_SECONDS

(long, optional) The timeout to use for exponential delay retries for retryable service errors. This value is ignored if OBJECT_STORE_CLIENT_CLASS is specified. See BmcConstants.RETRY_TIMEOUT_IN_SECONDS_KEY for config key name. Default is 30.

RETRY_TIMEOUT_RESET_THRESHOLD_IN_SECONDS

public static final BmcProperties RETRY_TIMEOUT_RESET_THRESHOLD_IN_SECONDS

(long, optional) The max sleep for delays in between retries for retryable service errors. If the exponential delay crosses this threshold, then the delay time is reset to initial delay. This value is ignored if OBJECT_STORE_CLIENT_CLASS is specified. See BmcConstants.RETRY_TIMEOUT_RESET_THRESHOLD_IN_SECONDS_KEY for config key name. Default is 0.

OBJECT_METADATA_CACHING_ENABLED

public static final BmcProperties OBJECT_METADATA_CACHING_ENABLED

(boolean, optional) Flag to enable object metadata caching. See BmcConstants.OBJECT_METADATA_CACHING_ENABLED_KEY for config key name. Default is false. Note: If this is enabled, the OCI HDFS Connector will cache object metadata, and queries will not necessarily reflect the actual data in Object Storage.

OBJECT_METADATA_CACHING_SPEC

public static final BmcProperties OBJECT_METADATA_CACHING_SPEC

(string, optional) Controls object metadata caching and eviction. See Guava's CacheBuilderSpec for details. See https://guava.dev/releases/22.0/api/docs/com/google/common/cache/CacheBuilderSpec.html See BmcConstants.OBJECT_METADATA_CACHING_SPEC_KEY for config key name. Default is "maximumSize=1024,expireAfterWrite=5m", which caches up to 1024 HEAD object responses for up to 5 minutes. To cache values for an infinite amount of time, do not list any setting for "expireAfterWrite", "expireAfterAccess", or "refreshAfterWrite". For example, "maximumSize=1024" will cache up to 1024 HEAD object responses for an unlimited amount of time, and only re-requesting them if they had to be evicted because of the maximum cache size.

JERSEY_CLIENT_LOGGING_ENABLED

public static final BmcProperties JERSEY_CLIENT_LOGGING_ENABLED

(boolean, optional) Flag to enable jersey client logging. See BmcConstants.JERSEY_CLIENT_LOGGING_ENABLED_KEY for config key name. Default is false. Note: If this is enabled, the OCI HDFS Connector will enable the JerseyClientLoggingConfigurator in the underlying java sdk and logs jersey client calls

JERSEY_CLIENT_LOGGING_LEVEL

public static final BmcProperties JERSEY_CLIENT_LOGGING_LEVEL

(string, optional) Log Level for jersey client logger. See BmcConstants.JERSEY_CLIENT_LOGGING_LEVEL_KEY for config key name. Default is Warning. Note: The log level can only be set if jersey client logging flag is enabled

JERSEY_CLIENT_LOGGING_VERBOSITY

public static final BmcProperties JERSEY_CLIENT_LOGGING_VERBOSITY

(string, optional) Verbosity for jersey client logger. See BmcConstants.JERSEY_CLIENT_LOGGING_VERBOSITY_KEY for config key name. Default is false. Note: The verbosity can only be set if jersey client logging flag is enabled

READ_AHEAD

public static final BmcProperties READ_AHEAD

(boolean, optional) Flag to enable read ahead. This reads bigger blocks from Object Storage, resulting in fewer requests. See BmcConstants.READ_AHEAD_KEY for config key name. Default is false. Incompatible with IN_MEMORY_READ_.

READ_AHEAD_BLOCK_SIZE

public static final BmcProperties READ_AHEAD_BLOCK_SIZE

(int, optional) Size in bytes of the blocks to read if READ_AHEAD is enabled. See BmcConstants.READ_AHEAD_BLOCK_SIZE_KEY for config key name. Default is 6 MiB.

READ_AHEAD_BLOCK_COUNT

public static final BmcProperties READ_AHEAD_BLOCK_COUNT

(int, optional) Number of blocks to read if READ_AHEAD is enabled. See BmcConstants.READ_AHEAD_BLOCK_COUNT_KEY for config key name. Default is 1.

NUM_READ_AHEAD_THREADS

public static final BmcProperties NUM_READ_AHEAD_THREADS

(int, optional) The number of threads to use for parallel GET operations when reading ahead. See BmcConstants.NUM_READ_AHEAD_THREADS_KEY for config key name. Note, any value smaller than 0 is interpreted as using the default value. Default is 16.

OBJECT_PARQUET_CACHING_ENABLED

public static final BmcProperties OBJECT_PARQUET_CACHING_ENABLED

(boolean, optional) Flag to enable parquet caching. See BmcConstants.OBJECT_PARQUET_CACHING_ENABLED_KEY for config key name. Default is false. Requires READ_AHEAD to be enabled. Note: If this is enabled, the OCI HDFS Connector will cache object parquet data, and queries will not necessarily reflect the actual data in Object Storage.

OBJECT_PARQUET_CACHING_SPEC

public static final BmcProperties OBJECT_PARQUET_CACHING_SPEC

(string, optional) Controls object parquet caching and eviction. See Guava's CacheBuilderSpec for details. See https://guava.dev/releases/22.0/api/docs/com/google/common/cache/CacheBuilderSpec.html See BmcConstants.OBJECT_PARQUET_CACHING_SPEC_KEY for config key name. Default is "maximumSize=10240,expireAfterWrite=15m", which caches up to 10240 parquet objects for up to 15 minutes. To cache values for an infinite amount of time, do not list any setting for "expireAfterWrite", "expireAfterAccess", or "refreshAfterWrite". For example, "maximumSize=1024" will cache up to 1024 parquet objects for an unlimited amount of time, and only re-requesting them if they had to be evicted because of the maximum cache size.

APACHE_CONNECTION_CLOSING_STRATEGY

public static final BmcProperties APACHE_CONNECTION_CLOSING_STRATEGY

(string, optional) Connection Closing Strategy for the Apache Connection. Values supported : IMMEDIATE - for ApacheConnectionClosingStrategy.ImmediateClosingStrategy and GRACEFUL - for ApacheConnectionClosingStrategy.GracefulClosingStrategy If the property is absent then default value of IMMEDIATE will be used. Note: When using ApacheConnectionClosingStrategy.GracefulClosingStrategy, streams returned from response are read till the end of the stream when closing the stream. This can introduce additional time when closing the stream with partial read, depending on how large the remaining stream is. Use ApacheConnectionClosingStrategy.ImmediateClosingStrategy for large files with partial reads instead for faster close. ApacheConnectionClosingStrategy.ImmediateClosingStrategy on the other hand takes longer when using partial read for smaller stream size (less than 1MB). Please consider your use-case and change accordingly. This property is only applicable when using the Apache Connector for sending requests to the service.

OBJECT_PAYLOAD_CACHING_ENABLED

public static final BmcProperties OBJECT_PAYLOAD_CACHING_ENABLED

(boolean, optional) Whether payload caching on disk is enabled. Default is false.

OBJECT_PAYLOAD_CACHING_MAXIMUM_WEIGHT_IN_BYTES

public static final BmcProperties OBJECT_PAYLOAD_CACHING_MAXIMUM_WEIGHT_IN_BYTES

(long, optional) Maximum weight of the cache in bytes. The default size is 4 GiB. Cannot be combined with OBJECT_PAYLOAD_CACHING_MAXIMUM_SIZE.

OBJECT_PAYLOAD_CACHING_MAXIMUM_SIZE

public static final BmcProperties OBJECT_PAYLOAD_CACHING_MAXIMUM_SIZE

(int, optional) Maximum number of cached items. The default is unset. Cannot be combined with OBJECT_PAYLOAD_CACHING_MAXIMUM_WEIGHT_IN_BYTES.

OBJECT_PAYLOAD_CACHING_INITIAL_CAPACITY

public static final BmcProperties OBJECT_PAYLOAD_CACHING_INITIAL_CAPACITY

(int, optional) Initial capacity of cached items. The default is 1024.

OBJECT_PAYLOAD_CACHING_RECORD_STATS_ENABLED

public static final BmcProperties OBJECT_PAYLOAD_CACHING_RECORD_STATS_ENABLED

(boolean, optional) Whether to record cache statistics. The default is false.

OBJECT_PAYLOAD_CACHING_RECORD_STATS_TIME_INTERVAL_IN_SECONDS

public static final BmcProperties OBJECT_PAYLOAD_CACHING_RECORD_STATS_TIME_INTERVAL_IN_SECONDS

(long, optional) The time interval (in seconds) between successive logging of cache statistics. The default is 60 seconds.

OBJECT_PAYLOAD_CACHING_EXPIRE_AFTER_ACCESS_SECONDS

public static final BmcProperties OBJECT_PAYLOAD_CACHING_EXPIRE_AFTER_ACCESS_SECONDS

(int, optional) Whether cached items should be expired if a certain number of seconds has passed since the last access, regardless of whether it was a read or a write. The default is unset, which means this expiration strategy is not used. Cannot be combined with OBJECT_PAYLOAD_CACHING_EXPIRE_AFTER_WRITE_SECONDS.

OBJECT_PAYLOAD_CACHING_EXPIRE_AFTER_WRITE_SECONDS

public static final BmcProperties OBJECT_PAYLOAD_CACHING_EXPIRE_AFTER_WRITE_SECONDS

(int, optional) Whether cached items should be expired if a certain number of seconds has passed since the last write access. The default is 600 (10 minutes). Cannot be combined with OBJECT_PAYLOAD_CACHING_EXPIRE_AFTER_WRITE_SECONDS.

OBJECT_PAYLOAD_CACHING_CONSISTENCY_POLICY_CLASS

public static final BmcProperties OBJECT_PAYLOAD_CACHING_CONSISTENCY_POLICY_CLASS

(string, optional) The consistency policy to use for the object payload cache. The default is "com.oracle.bmc.hdfs.caching.StrongConsistencyPolicy", which checks if the object was updated on the server. If you know your data does not change, you can set it to "com.oracle.bmc.hdfs.caching.NoOpConsistencyPolicy".

OBJECT_PAYLOAD_CACHING_DIRECTORY

public static final BmcProperties OBJECT_PAYLOAD_CACHING_DIRECTORY

(string, optional) The directory for the object payload cache. The default is the value of the "java.io.tmpdir" property.

JERSEY_CLIENT_DEFAULT_CONNECTOR_ENABLED

public static final BmcProperties JERSEY_CLIENT_DEFAULT_CONNECTOR_ENABLED

(boolean, optional) Flag to enable Jersey default HttpUrlConnector for sending requests using jersey client. See BmcConstants.JERSEY_CLIENT_DEFAULT_CONNECTOR_ENABLED_KEY for config key name. Default is false. Note: If the SDK default ApacheConnector is to be utilised for sending requests, please don't change this value

APACHE_MAX_CONNECTION_POOL_SIZE

public static final BmcProperties APACHE_MAX_CONNECTION_POOL_SIZE

(int, optional) The maximum number of connections that will be pooled in the connection pool used by the Apache Client to create connections with the service. Note, any value smaller than 0 is interpreted as using the default Java SDK value. See ApacheConnectorProperties.

RENAME_DIRECTORY_NUM_THREADS

public static final BmcProperties RENAME_DIRECTORY_NUM_THREADS

(int, optional) The number of threads to use for parallel rename operations when renaming the directory. Note, any value smaller than 0 is interpreted as using the default value. Default is 1. See ApacheConnectorProperties.

MULTIPART_IN_MEMORY_WRITE_BUFFER_ENABLED

public static final BmcProperties MULTIPART_IN_MEMORY_WRITE_BUFFER_ENABLED

(boolean, optional) Flag to enable pseudo-streaming to OCI via Multipart Uploads backed by a circular buffer. See BmcConstants.MULTIPART_IN_MEMORY_WRITE_BUFFER_ENABLED_KEY for config key name. Default is false. Cannot be enabled at the same time as IN_MEMORY_WRITE_BUFFER. If enabled, requires MULTIPART_NUM_UPLOAD_THREADS to be set.

MULTIPART_IN_MEMORY_WRITE_TASK_TIMEOUT_SECONDS

public static final BmcProperties MULTIPART_IN_MEMORY_WRITE_TASK_TIMEOUT_SECONDS

(int, optional) The amount of time in seconds to block waiting for a slot in the multipart upload executor. See BmcConstants.MULTIPART_IN_MEMORY_WRITE_TASK_TIMEOUT_SECONDS_KEY for config key name. Default is 900.

MULTIPART_ALLOW_OVERWRITE

public static final BmcProperties MULTIPART_ALLOW_OVERWRITE

(boolean, optional) Flag to enable overwrites while using Multipart Uploads. See BmcConstants.MULTIPART_ALLOW_OVERWRITE_KEY for config key name. Default is false.

OBJECT_AUTO_CLOSE_INPUT_STREAM

public static final BmcProperties OBJECT_AUTO_CLOSE_INPUT_STREAM

(boolean, optional) Flag to enable/disable auto-close of object streams on full read. The default is true.

REALM_SPECIFIC_ENDPOINT_TEMPLATES_ENABLED

public static final BmcProperties REALM_SPECIFIC_ENDPOINT_TEMPLATES_ENABLED

(boolean, optional) Flag to enable/disable the use of realm-specific endpoint templates, if defined. Default is false. See BmcConstants.REALM_SPECIFIC_ENDPOINT_TEMPLATES_ENABLED_KEY for config key name If enabled, requires REGION_CODE_OR_ID to be set. Note, this field will be overridden by "fs.oci.client.hostname property" if set.

READ_STREAM_CLASS

public static final BmcProperties READ_STREAM_CLASS

(string, optional) The custom stream class for reading. Fully qualified class name of a custom implementation of AbstractBmcCustomFSInputStream. See BmcConstants.READ_STREAM_CLASS_KEY for config key name.

WRITE_STREAM_CLASS

public static final BmcProperties WRITE_STREAM_CLASS

(string, optional) The custom stream class for writing. Fully qualified class name of a custom implementation of AbstractBmcCustomOutputStream. See BmcConstants.WRITE_STREAM_CLASS_KEY for config key name.

FILESYSTEM_CACHING_ENABLED

public static final BmcProperties FILESYSTEM_CACHING_ENABLED

(boolean, optional) Whether BmcFilesystem caching is enabled. Default is false. This setting cannot be overridden per namespace and bucket.

FILESYSTEM_CACHING_MAXIMUM_SIZE

public static final BmcProperties FILESYSTEM_CACHING_MAXIMUM_SIZE

(int, optional) Maximum number of cached BmcFilesystem items. The default is 1024. This setting cannot be overridden per namespace and bucket.

FILESYSTEM_CACHING_INITIAL_CAPACITY

public static final BmcProperties FILESYSTEM_CACHING_INITIAL_CAPACITY

(int, optional) Initial capacity of cached BmcFilesystem items. The default is 1024. This setting cannot be overridden per namespace and bucket.

FILESYSTEM_CACHING_EXPIRE_AFTER_ACCESS_SECONDS

public static final BmcProperties FILESYSTEM_CACHING_EXPIRE_AFTER_ACCESS_SECONDS

(int, optional) Whether cached BmcFilesystem items should be expired if a certain number of seconds has passed since the last access, regardless of whether it was a read or a write. The default is unset, which means this expiration strategy is not used. Cannot be combined with FILESYSTEM_CACHING_EXPIRE_AFTER_WRITE_SECONDS. This setting cannot be overridden per namespace and bucket.

FILESYSTEM_CACHING_EXPIRE_AFTER_WRITE_SECONDS

public static final BmcProperties FILESYSTEM_CACHING_EXPIRE_AFTER_WRITE_SECONDS

(int, optional) Whether cached BmcFilesystem items should be expired if a certain number of seconds has passed since the last write access. The default is 30 minutes. Cannot be combined with FILESYSTEM_CACHING_EXPIRE_AFTER_ACCESS_SECONDS. This setting cannot be overridden per namespace and bucket.

OCI_DELEGATION_TOKEN_FILEPATH

public static final BmcProperties OCI_DELEGATION_TOKEN_FILEPATH

(String, optional) File path that has the delegation token. Default value is null

RECURSIVE_DIR_LISTING_FETCH_SIZE

public static final BmcProperties RECURSIVE_DIR_LISTING_FETCH_SIZE

(int, optional) Whenever listFiles with recursive being true is invoked on a dir, a listing API is called on OSS that gets all the files in a flat manner. This property determines what is the max number of files to be listed in one call to OSS Service (essentially the page size of the OSS listing API). See BmcConstants.RECURSIVE_DIR_LISTING_FETCH_SIZE_KEY for config key name.

Method Detail

values

public static BmcProperties[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BmcProperties c : BmcProperties.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BmcProperties valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getPropertyName

public String getPropertyName()

getDefaultValue

public Object getDefaultValue()