LockConfiguration (hudi-common 1.0.0-beta2 API)

java.lang.Object
- org.apache.hudi.common.config.LockConfiguration

All Implemented Interfaces:

Serializable
```
public class LockConfiguration
extends Object
implements Serializable
```
Configuration for managing locks. Since this configuration needs to be shared with HiveMetaStore based lock, which is in a different package than other lock providers, we use this as a data transfer object in hoodie-common

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_LOCK_ACQUIRE_CLIENT_NUM_RETRIES` Deprecated.
`static String`	`DEFAULT_LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS`
`static String`	`DEFAULT_LOCK_ACQUIRE_MAX_RETRY_WAIT_TIME_IN_MILLIS` Deprecated.
`static String`	`DEFAULT_LOCK_ACQUIRE_NUM_RETRIES`
`static String`	`DEFAULT_LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS`
`static int`	`DEFAULT_LOCK_ACQUIRE_WAIT_TIMEOUT_MS`
`static int`	`DEFAULT_LOCK_HEARTBEAT_INTERVAL_MS`
`static int`	`DEFAULT_ZK_CONNECTION_TIMEOUT_MS`
`static int`	`DEFAULT_ZK_SESSION_TIMEOUT_MS`
`static String`	`FILESYSTEM_BASED_LOCK_PROPERTY_PREFIX`
`static String`	`FILESYSTEM_LOCK_EXPIRE_PROP_KEY`
`static String`	`FILESYSTEM_LOCK_PATH_PROP_KEY`
`static String`	`HIVE_DATABASE_NAME_PROP` Deprecated. Use `HIVE_DATABASE_NAME_PROP_KEY`
`static String`	`HIVE_DATABASE_NAME_PROP_KEY`
`static String`	`HIVE_METASTORE_LOCK_PROPERTY_PREFIX`
`static String`	`HIVE_METASTORE_URI_PROP` Deprecated. Use `HIVE_METASTORE_URI_PROP_KEY`
`static String`	`HIVE_METASTORE_URI_PROP_KEY`
`static String`	`HIVE_TABLE_NAME_PROP` Deprecated. Use `HIVE_TABLE_NAME_PROP_KEY`
`static String`	`HIVE_TABLE_NAME_PROP_KEY`
`static String`	`LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP` Deprecated. Use `LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP_KEY`
`static String`	`LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP_KEY`
`static String`	`LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP` Deprecated. Use `LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY`
`static String`	`LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY`
`static String`	`LOCK_ACQUIRE_NUM_RETRIES_PROP` Deprecated. Use `LOCK_ACQUIRE_NUM_RETRIES_PROP_KEY`
`static String`	`LOCK_ACQUIRE_NUM_RETRIES_PROP_KEY`
`static String`	`LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP` Deprecated. Use `LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP_KEY`
`static String`	`LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP_KEY`
`static String`	`LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP` Deprecated. Use `LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY`
`static String`	`LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY`
`static String`	`LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP` Deprecated. Use `LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP_KEY`
`static String`	`LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP_KEY`
`static String`	`LOCK_HEARTBEAT_INTERVAL_MS_KEY`
`static String`	`LOCK_PREFIX`
`static String`	`ZK_BASE_PATH_PROP` Deprecated. Use `ZK_BASE_PATH_PROP_KEY`
`static String`	`ZK_BASE_PATH_PROP_KEY`
`static String`	`ZK_CONNECT_URL_PROP` Deprecated. Use `ZK_CONNECT_URL_PROP_KEY`
`static String`	`ZK_CONNECT_URL_PROP_KEY`
`static String`	`ZK_CONNECTION_TIMEOUT_MS_PROP` Deprecated. Use `ZK_CONNECTION_TIMEOUT_MS_PROP_KEY`
`static String`	`ZK_CONNECTION_TIMEOUT_MS_PROP_KEY`
`static String`	`ZK_LOCK_KEY_PROP` Deprecated. Use `ZK_LOCK_KEY_PROP_KEY`
`static String`	`ZK_LOCK_KEY_PROP_KEY`
`static String`	`ZK_PORT_PROP` Deprecated. Use `ZK_PORT_PROP_KEY`
`static String`	`ZK_PORT_PROP_KEY`
`static String`	`ZK_SESSION_TIMEOUT_MS_PROP` Deprecated. Use `ZK_SESSION_TIMEOUT_MS_PROP_KEY`
`static String`	`ZK_SESSION_TIMEOUT_MS_PROP_KEY`
`static String`	`ZOOKEEPER_BASED_LOCK_PROPERTY_PREFIX`

Constructor Summary

Constructors
Constructor and Description

LockConfiguration(Properties props)

Constructors
Constructor and Description
`LockConfiguration(Properties props)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

TypedProperties getConfig()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TypedProperties`	`getConfig()`

- Field Detail
  - LOCK_PREFIX
```
public static final String LOCK_PREFIX
```
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY
```
public static final String LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS
```
public static final String DEFAULT_LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS
```
  - LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP_KEY
```
public static final String LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY
```
public static final String LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS
```
public static final String DEFAULT_LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS
```
  - LOCK_ACQUIRE_NUM_RETRIES_PROP_KEY
```
public static final String LOCK_ACQUIRE_NUM_RETRIES_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCK_ACQUIRE_NUM_RETRIES
```
public static final String DEFAULT_LOCK_ACQUIRE_NUM_RETRIES
```
  - LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP_KEY
```
public static final String LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP_KEY
```
public static final String LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCK_ACQUIRE_WAIT_TIMEOUT_MS
```
public static final int DEFAULT_LOCK_ACQUIRE_WAIT_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - LOCK_HEARTBEAT_INTERVAL_MS_KEY
```
public static final String LOCK_HEARTBEAT_INTERVAL_MS_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCK_HEARTBEAT_INTERVAL_MS
```
public static final int DEFAULT_LOCK_HEARTBEAT_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - FILESYSTEM_BASED_LOCK_PROPERTY_PREFIX
```
public static final String FILESYSTEM_BASED_LOCK_PROPERTY_PREFIX
```
    See Also:
    
    Constant Field Values
  - FILESYSTEM_LOCK_PATH_PROP_KEY
```
public static final String FILESYSTEM_LOCK_PATH_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - FILESYSTEM_LOCK_EXPIRE_PROP_KEY
```
public static final String FILESYSTEM_LOCK_EXPIRE_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - HIVE_METASTORE_LOCK_PROPERTY_PREFIX
```
public static final String HIVE_METASTORE_LOCK_PROPERTY_PREFIX
```
    See Also:
    
    Constant Field Values
  - HIVE_DATABASE_NAME_PROP_KEY
```
public static final String HIVE_DATABASE_NAME_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - HIVE_TABLE_NAME_PROP_KEY
```
public static final String HIVE_TABLE_NAME_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - HIVE_METASTORE_URI_PROP_KEY
```
public static final String HIVE_METASTORE_URI_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - ZOOKEEPER_BASED_LOCK_PROPERTY_PREFIX
```
public static final String ZOOKEEPER_BASED_LOCK_PROPERTY_PREFIX
```
    See Also:
    
    Constant Field Values
  - ZK_BASE_PATH_PROP_KEY
```
public static final String ZK_BASE_PATH_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - ZK_SESSION_TIMEOUT_MS_PROP_KEY
```
public static final String ZK_SESSION_TIMEOUT_MS_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ZK_SESSION_TIMEOUT_MS
```
public static final int DEFAULT_ZK_SESSION_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - ZK_CONNECTION_TIMEOUT_MS_PROP_KEY
```
public static final String ZK_CONNECTION_TIMEOUT_MS_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ZK_CONNECTION_TIMEOUT_MS
```
public static final int DEFAULT_ZK_CONNECTION_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - ZK_CONNECT_URL_PROP_KEY
```
public static final String ZK_CONNECT_URL_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - ZK_PORT_PROP_KEY
```
public static final String ZK_PORT_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - ZK_LOCK_KEY_PROP_KEY
```
public static final String ZK_LOCK_KEY_PROP_KEY
```
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP
```
@Deprecated
public static final String LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP
```
    Deprecated. Use LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP
```
@Deprecated
public static final String LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP
```
    Deprecated. Use LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCK_ACQUIRE_MAX_RETRY_WAIT_TIME_IN_MILLIS
```
@Deprecated
public static final String DEFAULT_LOCK_ACQUIRE_MAX_RETRY_WAIT_TIME_IN_MILLIS
```
    Deprecated.
  - LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP
```
@Deprecated
public static final String LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP
```
    Deprecated. Use LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_NUM_RETRIES_PROP
```
@Deprecated
public static final String LOCK_ACQUIRE_NUM_RETRIES_PROP
```
    Deprecated. Use LOCK_ACQUIRE_NUM_RETRIES_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP
```
@Deprecated
public static final String LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP
```
    Deprecated. Use LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOCK_ACQUIRE_CLIENT_NUM_RETRIES
```
@Deprecated
public static final String DEFAULT_LOCK_ACQUIRE_CLIENT_NUM_RETRIES
```
    Deprecated.
  - LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP
```
@Deprecated
public static final String LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP
```
    Deprecated. Use LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - HIVE_DATABASE_NAME_PROP
```
@Deprecated
public static final String HIVE_DATABASE_NAME_PROP
```
    Deprecated. Use HIVE_DATABASE_NAME_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - HIVE_TABLE_NAME_PROP
```
@Deprecated
public static final String HIVE_TABLE_NAME_PROP
```
    Deprecated. Use HIVE_TABLE_NAME_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - HIVE_METASTORE_URI_PROP
```
@Deprecated
public static final String HIVE_METASTORE_URI_PROP
```
    Deprecated. Use HIVE_METASTORE_URI_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - ZK_BASE_PATH_PROP
```
@Deprecated
public static final String ZK_BASE_PATH_PROP
```
    Deprecated. Use ZK_BASE_PATH_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - ZK_SESSION_TIMEOUT_MS_PROP
```
@Deprecated
public static final String ZK_SESSION_TIMEOUT_MS_PROP
```
    Deprecated. Use ZK_SESSION_TIMEOUT_MS_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - ZK_CONNECTION_TIMEOUT_MS_PROP
```
@Deprecated
public static final String ZK_CONNECTION_TIMEOUT_MS_PROP
```
    Deprecated. Use ZK_CONNECTION_TIMEOUT_MS_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - ZK_CONNECT_URL_PROP
```
@Deprecated
public static final String ZK_CONNECT_URL_PROP
```
    Deprecated. Use ZK_CONNECT_URL_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - ZK_PORT_PROP
```
@Deprecated
public static final String ZK_PORT_PROP
```
    Deprecated. Use ZK_PORT_PROP_KEY
    
    See Also:
    
    Constant Field Values
  - ZK_LOCK_KEY_PROP
```
@Deprecated
public static final String ZK_LOCK_KEY_PROP
```
    Deprecated. Use ZK_LOCK_KEY_PROP_KEY
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LockConfiguration
```
public LockConfiguration(Properties props)
```
- Method Detail
  - getConfig
```
public TypedProperties getConfig()
```

Class LockConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCK_PREFIX

LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY

DEFAULT_LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS

LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP_KEY

LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP_KEY

DEFAULT_LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS

LOCK_ACQUIRE_NUM_RETRIES_PROP_KEY

DEFAULT_LOCK_ACQUIRE_NUM_RETRIES

LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP_KEY

LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP_KEY

DEFAULT_LOCK_ACQUIRE_WAIT_TIMEOUT_MS

LOCK_HEARTBEAT_INTERVAL_MS_KEY

DEFAULT_LOCK_HEARTBEAT_INTERVAL_MS

FILESYSTEM_BASED_LOCK_PROPERTY_PREFIX

FILESYSTEM_LOCK_PATH_PROP_KEY

FILESYSTEM_LOCK_EXPIRE_PROP_KEY

HIVE_METASTORE_LOCK_PROPERTY_PREFIX

HIVE_DATABASE_NAME_PROP_KEY

HIVE_TABLE_NAME_PROP_KEY

HIVE_METASTORE_URI_PROP_KEY

ZOOKEEPER_BASED_LOCK_PROPERTY_PREFIX

ZK_BASE_PATH_PROP_KEY

ZK_SESSION_TIMEOUT_MS_PROP_KEY

DEFAULT_ZK_SESSION_TIMEOUT_MS

ZK_CONNECTION_TIMEOUT_MS_PROP_KEY

DEFAULT_ZK_CONNECTION_TIMEOUT_MS

ZK_CONNECT_URL_PROP_KEY

ZK_PORT_PROP_KEY

ZK_LOCK_KEY_PROP_KEY

LOCK_ACQUIRE_RETRY_WAIT_TIME_IN_MILLIS_PROP

LOCK_ACQUIRE_RETRY_MAX_WAIT_TIME_IN_MILLIS_PROP

DEFAULT_LOCK_ACQUIRE_MAX_RETRY_WAIT_TIME_IN_MILLIS

LOCK_ACQUIRE_CLIENT_RETRY_WAIT_TIME_IN_MILLIS_PROP

LOCK_ACQUIRE_NUM_RETRIES_PROP

LOCK_ACQUIRE_CLIENT_NUM_RETRIES_PROP

DEFAULT_LOCK_ACQUIRE_CLIENT_NUM_RETRIES

LOCK_ACQUIRE_WAIT_TIMEOUT_MS_PROP

HIVE_DATABASE_NAME_PROP

HIVE_TABLE_NAME_PROP

HIVE_METASTORE_URI_PROP

ZK_BASE_PATH_PROP

ZK_SESSION_TIMEOUT_MS_PROP

ZK_CONNECTION_TIMEOUT_MS_PROP

ZK_CONNECT_URL_PROP

ZK_PORT_PROP

ZK_LOCK_KEY_PROP

Constructor Detail

LockConfiguration

Method Detail

getConfig