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

Annotation Type PathParam

  • @Retention(RUNTIME)
@Target(PARAMETER)
public @interface PathParam
    Annotation to annotate replacement for a named path segment in REST endpoint URL.

    • 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.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean encoded
      A value true for this argument indicates that value of value() is already encoded hence engine should not encode it, by default value will be encoded.

    • 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.

      • encoded

        boolean encoded
        A value true for this argument indicates that value of value() is already encoded hence engine should not encode it, by default value will be encoded.
        Returns:
        Whether or not this path parameter is already encoded.
        Default:
        false