Package com.azure.android.core.rest.annotation

Annotation Type HeaderParam

  • @Retention(RUNTIME)
@Target(PARAMETER)
public @interface HeaderParam
    Replaces the header with the value of its target. The value specified here replaces headers specified statically in the Headers. If the parameter this annotation is attached to is a Map type, then this will be treated as a header collection. In that case each of the entries in the argument's map will be individual header values that use the value of this annotation as a prefix to their key/header name.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      The name of the variable in the endpoint uri template which will be replaced with the value of the parameter annotated with this annotation.

    • Element Detail

      • value

        java.lang.String value
        The name of the variable in the endpoint uri template which will be replaced with the value of the parameter annotated with this annotation.
        Returns:
        The name of the variable in the endpoint uri template which will be replaced with the value of the parameter annotated with this annotation.