EncryptionKey (ORC Core 1.6.5 API)
Date: 2020-10-01

org.apache.orc

## Interface EncryptionKey

- All Superinterfaces:
    Comparable<EncryptionKey>
  All Known Implementing Classes:
    ReaderEncryptionKey, WriterEncryptionKey

      public interface EncryptionKey
      extends Comparable<EncryptionKey>

  Information about a key used for column encryption in an ORC file.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `EncryptionAlgorithm` | `getAlgorithm()` The encryption algorithm for this key.
    `EncryptionVariant[]` | `getEncryptionRoots()` The columns that are encrypted with this key.
    `String` | `getKeyName()` The name of the key.
    `int` | `getKeyVersion()` The version of the key.
    `boolean` | `isAvailable()` Is the key available to this user?

    - ### Methods inherited from interface java.lang.Comparable

      `compareTo`

- - ### Method Detail

    - #### getKeyName

          String getKeyName()

      The name of the key.
      Returns:
        the name

    - #### getKeyVersion

          int getKeyVersion()

      The version of the key.
      Returns:
        the version, which for most KeyProviders start at 0.

    - #### getAlgorithm

          EncryptionAlgorithm getAlgorithm()

      The encryption algorithm for this key.
      Returns:
        the encryption algorithm

    - #### getEncryptionRoots

          EncryptionVariant[] getEncryptionRoots()

      The columns that are encrypted with this key.
      Returns:
        the list of columns

    - #### isAvailable

          boolean isAvailable()

      Is the key available to this user?
      Returns:
        true if the key is available

Copyright © 2013–2020 The Apache Software Foundation. All rights reserved.