Package org.apache.hadoop.yarn.server.timelineservice.storage.entity

Enum Class EntityColumnFamily

java.lang.Object
java.lang.Enum<EntityColumnFamily>
org.apache.hadoop.yarn.server.timelineservice.storage.entity.EntityColumnFamily
All Implemented Interfaces:
Serializable, Comparable<EntityColumnFamily>, Constable, ColumnFamily<EntityTable>
public enum EntityColumnFamily extends Enum<EntityColumnFamily> implements ColumnFamily<EntityTable>
Represents the entity table column families.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CONFIGS
    Configurations are in a separate column family for two reasons: a) the size of the config values can be very large and b) we expect that config values are often separately accessed from other metrics and info columns.
    INFO
    Info column family houses known columns, specifically ones included in columnfamily filters.
    METRICS
    Metrics have a separate column family, because they have a separate TTL.

  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    getBytes()
    Keep a local copy if you need to avoid overhead of repeated cloning.
    static EntityColumnFamily
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static EntityColumnFamily[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • INFO

      public static final EntityColumnFamily INFO
      Info column family houses known columns, specifically ones included in columnfamily filters.

    • CONFIGS

      public static final EntityColumnFamily CONFIGS
      Configurations are in a separate column family for two reasons: a) the size of the config values can be very large and b) we expect that config values are often separately accessed from other metrics and info columns.

    • METRICS

      public static final EntityColumnFamily METRICS
      Metrics have a separate column family, because they have a separate TTL.

  • Method Details

    • values

      public static EntityColumnFamily[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static EntityColumnFamily valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getBytes

      public byte[] getBytes()
      Description copied from interface: ColumnFamily
      Keep a local copy if you need to avoid overhead of repeated cloning.
      Specified by:
      getBytes in interface ColumnFamily<EntityTable>
      Returns:
      a clone of the byte representation of the column family.