Package org.cdlib.mrt.zk

Enum ZKKey

java.lang.Object
java.lang.Enum<ZKKey>
org.cdlib.mrt.zk.ZKKey
All Implemented Interfaces:
Serializable, Comparable<ZKKey>
public enum ZKKey extends Enum<ZKKey>
Defines relative pathnames to ZooKeeper nodes for a Batch or a Job.
See Also:

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ACCESS_TOKEN
    Access assembly token data
    BATCH_STATUS_REPORT
    JSON node summarizing a report sent to the depositor detaining completed and failed jobs for a batch.
    BATCH_SUBMISSION
    Read-only JSON node containing the parameters that initiated a submission.
    JOB_BID
    String node containing the batch id for the job
    JOB_CONFIGURATION
    Read-only JSON node containing the parameters for a specific job.
    JOB_IDENTIFIERS
    JSON node containing the primary id and local id for a job.
    JOB_INVENTORY
    inventory parameters
    JOB_METADATA
    JSON node containing the primary id and local id for a job.
    JOB_PRIORITY
    Integer node containing the priority assigned to the job.
    JOB_SPACE_NEEDED
    Long node containing the bytes of cloud storage to be used by the job.
    LOCK
    Empty Ephemeral node that indicates that a Batch or Job has been locked by a consumer daemon
    ROOT
    Root path for a QueueItem
    STATES
    Parent node of state-specific nodes for a Batch or for a Job.
    STATUS
    JSON node uses to store current state for a Job or a Batch

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    key()
     
    static ZKKey
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static ZKKey[]
    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 Details

    • ROOT

      public static final ZKKey ROOT
      Root path for a QueueItem

    • STATUS

      public static final ZKKey STATUS
      JSON node uses to store current state for a Job or a Batch 
       status: Pending
 last_modified: now

    • LOCK

      public static final ZKKey LOCK
      Empty Ephemeral node that indicates that a Batch or Job has been locked by a consumer daemon

    • STATES

      public static final ZKKey STATES
      Parent node of state-specific nodes for a Batch or for a Job. The state-specific nodes will contain nodes that reference job ids.

    • BATCH_SUBMISSION

      public static final ZKKey BATCH_SUBMISSION
      Read-only JSON node containing the parameters that initiated a submission.

    • BATCH_STATUS_REPORT

      public static final ZKKey BATCH_STATUS_REPORT
      JSON node summarizing a report sent to the depositor detaining completed and failed jobs for a batch.

    • JOB_CONFIGURATION

      public static final ZKKey JOB_CONFIGURATION
      Read-only JSON node containing the parameters for a specific job.

    • JOB_IDENTIFIERS

      public static final ZKKey JOB_IDENTIFIERS
      JSON node containing the primary id and local id for a job.

    • JOB_METADATA

      public static final ZKKey JOB_METADATA
      JSON node containing the primary id and local id for a job.

    • JOB_PRIORITY

      public static final ZKKey JOB_PRIORITY
      Integer node containing the priority assigned to the job.

    • JOB_SPACE_NEEDED

      public static final ZKKey JOB_SPACE_NEEDED
      Long node containing the bytes of cloud storage to be used by the job. This value should be set to 0 if the value is unknown.

    • JOB_BID

      public static final ZKKey JOB_BID
      String node containing the batch id for the job

    • JOB_INVENTORY

      public static final ZKKey JOB_INVENTORY
      inventory parameters

    • ACCESS_TOKEN

      public static final ZKKey ACCESS_TOKEN
      Access assembly token data

  • Method Details

    • values

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

    • valueOf

      public static ZKKey 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

    • key

      public String key()