Package com.github.ambry.protocol

Enum GetOption

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<GetOption>
    public enum GetOption
extends java.lang.Enum<GetOption>
    The list of options for the Get request.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Include_All
      Indicates that the blob should be returned regardless of whether it is deleted or expired
      Include_Deleted_Blobs
      Indicates that the blob should be returned even if it is deleted
      Include_Expired_Blobs
      Indicates that the blob should be returned even if it is expired
      None
      This is the default.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static GetOption valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static GetOption[] 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 Detail

      • None

        public static final GetOption None
        This is the default. This returns all blobs that are not expired and not deleted

      • Include_Expired_Blobs

        public static final GetOption Include_Expired_Blobs
        Indicates that the blob should be returned even if it is expired

      • Include_Deleted_Blobs

        public static final GetOption Include_Deleted_Blobs
        Indicates that the blob should be returned even if it is deleted

      • Include_All

        public static final GetOption Include_All
        Indicates that the blob should be returned regardless of whether it is deleted or expired

    • Method Detail

      • values

        public static GetOption[] 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 (GetOption c : GetOption.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static GetOption valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null