Package com.github.ambry.rest

Class RestUtils.InternalKeys

  • Enclosing class:
    RestUtils
    public static final class RestUtils.InternalKeys
extends java.lang.Object
    Ambry specific keys used internally in a RestRequest.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String KEEP_ALIVE_ON_ERROR_HINT
      To be set if the operation knows the keep-alive behavior it prefers on error.
      static java.lang.String REQUEST_PATH
      The key for the RequestPath that represents the parsed path of an incoming request.
      static java.lang.String SEND_FAILURE_REASON
      To be set to true if failures reason should be attached to frontend responses.
      static java.lang.String SEND_TRACKING_INFO
      To be set to true if tracking info should be attached to frontend responses.
      static java.lang.String SEND_USER_METADATA_AS_RESPONSE_BODY
      Set to true (assumed false if absent) if the user metadata needs to be sent as the body of the response.
      static java.lang.String SIGNED_ID_METADATA_KEY
      The key for the metadata Map<String, String> to include in a signed ID.
      static java.lang.String TARGET_ACCOUNT_KEY
      The key for the target Account indicated by the request.
      static java.lang.String TARGET_CONTAINER_KEY
      The key for the target Container indicated by the request.

    • Constructor Summary

      Constructors 
      Constructor Description
      InternalKeys()  

    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • TARGET_ACCOUNT_KEY

        public static final java.lang.String TARGET_ACCOUNT_KEY
        The key for the target Account indicated by the request.
        See Also:
        Constant Field Values

      • TARGET_CONTAINER_KEY

        public static final java.lang.String TARGET_CONTAINER_KEY
        The key for the target Container indicated by the request.
        See Also:
        Constant Field Values

      • SIGNED_ID_METADATA_KEY

        public static final java.lang.String SIGNED_ID_METADATA_KEY
        The key for the metadata Map<String, String> to include in a signed ID. This argument should be non-null to indicate that a signed ID should be created and returned to the requester on a POST request.
        See Also:
        Constant Field Values

      • KEEP_ALIVE_ON_ERROR_HINT

        public static final java.lang.String KEEP_ALIVE_ON_ERROR_HINT
        To be set if the operation knows the keep-alive behavior it prefers on error. Valid values are boolean. Not authoritative, only a hint
        See Also:
        Constant Field Values

      • SEND_TRACKING_INFO

        public static final java.lang.String SEND_TRACKING_INFO
        To be set to true if tracking info should be attached to frontend responses.
        See Also:
        Constant Field Values

      • SEND_USER_METADATA_AS_RESPONSE_BODY

        public static final java.lang.String SEND_USER_METADATA_AS_RESPONSE_BODY
        Set to true (assumed false if absent) if the user metadata needs to be sent as the body of the response.
        See Also:
        Constant Field Values

      • REQUEST_PATH

        public static final java.lang.String REQUEST_PATH
        The key for the RequestPath that represents the parsed path of an incoming request.
        See Also:
        Constant Field Values

      • SEND_FAILURE_REASON

        public static final java.lang.String SEND_FAILURE_REASON
        To be set to true if failures reason should be attached to frontend responses.
        See Also:
        Constant Field Values

    • Constructor Detail

      • InternalKeys

        public InternalKeys()