Package org.jclouds.rest.annotations

Annotation Type Headers

  • @Target({TYPE,METHOD})
@Retention(RUNTIME)
public @interface Headers
    Designates that a header will be added to the request. This header will contain the specified value, expanding any variables annotated with PathParam.
    See Also:
    PathParam

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String[] keys  
      String[] values
      can be defined literally, or with enclosed variables (ex.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean[] urlEncode
      Indicates whether a header should be URL encoded.

    • Element Detail

      • keys

        String[] keys
        See Also:
        HttpHeaders

      • values

        String[] values
        can be defined literally, or with enclosed variables (ex. {variable})

        The inputs to these variables are taken from method parameters annotated with {@code

        See Also:
        PathParam

      • urlEncode

        boolean[] urlEncode
        Indicates whether a header should be URL encoded. Optional for backwards compatibility. The default behavior is that the header is not URL encoded.
        Default:
        {}