MetastoreConf.ConfVars (kyuubi-relocated-hive-metastore-client 0.3.0 API)

java.lang.Object
- java.lang.Enum<MetastoreConf.ConfVars>
- - org.apache.kyuubi.shaded.hive.metastore.conf.MetastoreConf.ConfVars

All Implemented Interfaces:

Serializable, Comparable<MetastoreConf.ConfVars>

Enclosing class:

MetastoreConf
```
public static enum MetastoreConf.ConfVars
extends Enum<MetastoreConf.ConfVars>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CLIENT_CONNECT_RETRY_DELAY`
`CLIENT_CONNECTION_TIMEOUT`
`CLIENT_KERBEROS_PRINCIPAL`
`CLIENT_SOCKET_LIFETIME`
`CLIENT_SOCKET_TIMEOUT`
`DUMP_CONFIG_ON_CREATION`
`KERBEROS_PRINCIPAL`
`METASTORE_CLIENT_ADDITIONAL_HEADERS`
`METASTORE_CLIENT_AUTH_MODE`
`METASTORE_CLIENT_PLAIN_USERNAME`
`METASTORE_CLIENT_THRIFT_TRANSPORT_MODE`
`SSL_KEYSTORE_PASSWORD`
`SSL_TRUSTMANAGERFACTORY_ALGORITHM`
`SSL_TRUSTSTORE_PASSWORD`
`SSL_TRUSTSTORE_PATH`
`SSL_TRUSTSTORE_TYPE`
`THRIFT_CONNECTION_RETRIES`
`THRIFT_FAILURE_RETRIES`
`THRIFT_HTTP_PATH`
`THRIFT_METASTORE_CLIENT_MAX_MESSAGE_SIZE`
`THRIFT_SERVICE_DISCOVERY_MODE`
`THRIFT_TRANSPORT_MODE`
`THRIFT_URI_SELECTION`
`THRIFT_URIS`
`THRIFT_ZOOKEEPER_CLIENT_PORT`
`THRIFT_ZOOKEEPER_CONNECTION_BASESLEEPTIME`
`THRIFT_ZOOKEEPER_CONNECTION_MAX_RETRIES`
`THRIFT_ZOOKEEPER_CONNECTION_TIMEOUT`
`THRIFT_ZOOKEEPER_NAMESPACE`
`THRIFT_ZOOKEEPER_SESSION_TIMEOUT`
`TOKEN_SIGNATURE`
`URI_RESOLVER`
`USE_SSL`
`USE_THRIFT_COMPACT_PROTOCOL`
`USE_THRIFT_FRAMED_TRANSPORT`
`USE_THRIFT_SASL`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getDefaultVal()`
`String`	`getDescription()`
`String`	`getHiveName()` Use this method if you need to set a system property and are going to instantiate the configuration file via HiveConf.
`String`	`getVarname()` If you are calling this, you're probably doing it wrong.
`boolean`	`isCaseSensitive()`
`String`	`toString()` This is useful if you need the variable name for a LOG message or `System.setProperty(String, String)`, beware however that you should only use this with setProperty if you're going to create a configuration via `MetastoreConf.newMetastoreConf()`.
`void`	`validate(String value)`
`static MetastoreConf.ConfVars`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MetastoreConf.ConfVars[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - CLIENT_CONNECT_RETRY_DELAY
```
public static final MetastoreConf.ConfVars CLIENT_CONNECT_RETRY_DELAY
```
  - CLIENT_KERBEROS_PRINCIPAL
```
public static final MetastoreConf.ConfVars CLIENT_KERBEROS_PRINCIPAL
```
  - CLIENT_SOCKET_LIFETIME
```
public static final MetastoreConf.ConfVars CLIENT_SOCKET_LIFETIME
```
  - CLIENT_SOCKET_TIMEOUT
```
public static final MetastoreConf.ConfVars CLIENT_SOCKET_TIMEOUT
```
  - CLIENT_CONNECTION_TIMEOUT
```
public static final MetastoreConf.ConfVars CLIENT_CONNECTION_TIMEOUT
```
  - DUMP_CONFIG_ON_CREATION
```
public static final MetastoreConf.ConfVars DUMP_CONFIG_ON_CREATION
```
  - KERBEROS_PRINCIPAL
```
public static final MetastoreConf.ConfVars KERBEROS_PRINCIPAL
```
  - SSL_KEYSTORE_PASSWORD
```
public static final MetastoreConf.ConfVars SSL_KEYSTORE_PASSWORD
```
  - SSL_TRUSTSTORE_PATH
```
public static final MetastoreConf.ConfVars SSL_TRUSTSTORE_PATH
```
  - SSL_TRUSTSTORE_PASSWORD
```
public static final MetastoreConf.ConfVars SSL_TRUSTSTORE_PASSWORD
```
  - SSL_TRUSTSTORE_TYPE
```
public static final MetastoreConf.ConfVars SSL_TRUSTSTORE_TYPE
```
  - SSL_TRUSTMANAGERFACTORY_ALGORITHM
```
public static final MetastoreConf.ConfVars SSL_TRUSTMANAGERFACTORY_ALGORITHM
```
  - THRIFT_TRANSPORT_MODE
```
public static final MetastoreConf.ConfVars THRIFT_TRANSPORT_MODE
```
  - THRIFT_HTTP_PATH
```
public static final MetastoreConf.ConfVars THRIFT_HTTP_PATH
```
  - THRIFT_CONNECTION_RETRIES
```
public static final MetastoreConf.ConfVars THRIFT_CONNECTION_RETRIES
```
  - THRIFT_FAILURE_RETRIES
```
public static final MetastoreConf.ConfVars THRIFT_FAILURE_RETRIES
```
  - THRIFT_URIS
```
public static final MetastoreConf.ConfVars THRIFT_URIS
```
  - THRIFT_METASTORE_CLIENT_MAX_MESSAGE_SIZE
```
public static final MetastoreConf.ConfVars THRIFT_METASTORE_CLIENT_MAX_MESSAGE_SIZE
```
  - THRIFT_SERVICE_DISCOVERY_MODE
```
public static final MetastoreConf.ConfVars THRIFT_SERVICE_DISCOVERY_MODE
```
  - THRIFT_ZOOKEEPER_CLIENT_PORT
```
public static final MetastoreConf.ConfVars THRIFT_ZOOKEEPER_CLIENT_PORT
```
  - THRIFT_ZOOKEEPER_SESSION_TIMEOUT
```
public static final MetastoreConf.ConfVars THRIFT_ZOOKEEPER_SESSION_TIMEOUT
```
  - THRIFT_ZOOKEEPER_CONNECTION_TIMEOUT
```
public static final MetastoreConf.ConfVars THRIFT_ZOOKEEPER_CONNECTION_TIMEOUT
```
  - THRIFT_ZOOKEEPER_NAMESPACE
```
public static final MetastoreConf.ConfVars THRIFT_ZOOKEEPER_NAMESPACE
```
  - THRIFT_ZOOKEEPER_CONNECTION_MAX_RETRIES
```
public static final MetastoreConf.ConfVars THRIFT_ZOOKEEPER_CONNECTION_MAX_RETRIES
```
  - THRIFT_ZOOKEEPER_CONNECTION_BASESLEEPTIME
```
public static final MetastoreConf.ConfVars THRIFT_ZOOKEEPER_CONNECTION_BASESLEEPTIME
```
  - THRIFT_URI_SELECTION
```
public static final MetastoreConf.ConfVars THRIFT_URI_SELECTION
```
  - TOKEN_SIGNATURE
```
public static final MetastoreConf.ConfVars TOKEN_SIGNATURE
```
  - URI_RESOLVER
```
public static final MetastoreConf.ConfVars URI_RESOLVER
```
  - METASTORE_CLIENT_THRIFT_TRANSPORT_MODE
```
public static final MetastoreConf.ConfVars METASTORE_CLIENT_THRIFT_TRANSPORT_MODE
```
  - USE_SSL
```
public static final MetastoreConf.ConfVars USE_SSL
```
  - USE_THRIFT_SASL
```
public static final MetastoreConf.ConfVars USE_THRIFT_SASL
```
  - METASTORE_CLIENT_AUTH_MODE
```
public static final MetastoreConf.ConfVars METASTORE_CLIENT_AUTH_MODE
```
  - METASTORE_CLIENT_ADDITIONAL_HEADERS
```
public static final MetastoreConf.ConfVars METASTORE_CLIENT_ADDITIONAL_HEADERS
```
  - METASTORE_CLIENT_PLAIN_USERNAME
```
public static final MetastoreConf.ConfVars METASTORE_CLIENT_PLAIN_USERNAME
```
  - USE_THRIFT_FRAMED_TRANSPORT
```
public static final MetastoreConf.ConfVars USE_THRIFT_FRAMED_TRANSPORT
```
  - USE_THRIFT_COMPACT_PROTOCOL
```
public static final MetastoreConf.ConfVars USE_THRIFT_COMPACT_PROTOCOL
```
- Method Detail
  - values
```
public static MetastoreConf.ConfVars[] 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 (MetastoreConf.ConfVars c : MetastoreConf.ConfVars.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MetastoreConf.ConfVars 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
  - validate
```
public void validate(String value)
              throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
  - getVarname
```
public String getVarname()
```
    If you are calling this, you're probably doing it wrong. You shouldn't need to use the underlying variable name. Use one of the getVar methods instead. Only use this if you are 100% sure you know you're doing. The reason for this is that MetastoreConf goes to a lot of trouble to make sure it checks both Hive and Metastore values for config keys. If you call Configuration.get(String) you are undermining that.
    
    Returns:
    
    variable name
  - getHiveName
```
public String getHiveName()
```
    Use this method if you need to set a system property and are going to instantiate the configuration file via HiveConf. This is because HiveConf only looks for values it knows, so it will miss all of the metastore.* ones. Do not use this to explicitly set or get the underlying config value unless you are 100% sure you know what you're doing. The reason for this is that MetastoreConf goes to a lot of trouble to make sure it checks both Hive and Metastore values for config keys. If you call Configuration.get(String) you are undermining that.
    
    Returns:
    
    hive.* configuration key
  - getDefaultVal
```
public Object getDefaultVal()
```
  - getDescription
```
public String getDescription()
```
  - toString
```
public String toString()
```
    This is useful if you need the variable name for a LOG message or System.setProperty(String, String), beware however that you should only use this with setProperty if you're going to create a configuration via MetastoreConf.newMetastoreConf(). If you are going to create it with HiveConf, then use getHiveName().
    
    Overrides:
    
    toString in class Enum<MetastoreConf.ConfVars>
    
    Returns:
    
    metastore.* configuration key

Enum MetastoreConf.ConfVars

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CLIENT_CONNECT_RETRY_DELAY

CLIENT_KERBEROS_PRINCIPAL

CLIENT_SOCKET_LIFETIME

CLIENT_SOCKET_TIMEOUT

CLIENT_CONNECTION_TIMEOUT

DUMP_CONFIG_ON_CREATION

KERBEROS_PRINCIPAL

SSL_KEYSTORE_PASSWORD

SSL_TRUSTSTORE_PATH

SSL_TRUSTSTORE_PASSWORD

SSL_TRUSTSTORE_TYPE

SSL_TRUSTMANAGERFACTORY_ALGORITHM

THRIFT_TRANSPORT_MODE

THRIFT_HTTP_PATH

THRIFT_CONNECTION_RETRIES

THRIFT_FAILURE_RETRIES

THRIFT_URIS

THRIFT_METASTORE_CLIENT_MAX_MESSAGE_SIZE

THRIFT_SERVICE_DISCOVERY_MODE

THRIFT_ZOOKEEPER_CLIENT_PORT

THRIFT_ZOOKEEPER_SESSION_TIMEOUT

THRIFT_ZOOKEEPER_CONNECTION_TIMEOUT

THRIFT_ZOOKEEPER_NAMESPACE

THRIFT_ZOOKEEPER_CONNECTION_MAX_RETRIES

THRIFT_ZOOKEEPER_CONNECTION_BASESLEEPTIME

THRIFT_URI_SELECTION

TOKEN_SIGNATURE

URI_RESOLVER

METASTORE_CLIENT_THRIFT_TRANSPORT_MODE

USE_SSL

USE_THRIFT_SASL

METASTORE_CLIENT_AUTH_MODE

METASTORE_CLIENT_ADDITIONAL_HEADERS

METASTORE_CLIENT_PLAIN_USERNAME

USE_THRIFT_FRAMED_TRANSPORT

USE_THRIFT_COMPACT_PROTOCOL

Method Detail

values

valueOf

validate

isCaseSensitive

getVarname

getHiveName

getDefaultVal

getDescription

toString