Annotation Type Put

@Retention(RUNTIME) @Target(METHOD) public @interface Put
HTTP PUT method annotation describing the parameterized relative path to a REST endpoint for resource creation or update.

The required value can be either a relative path or an absolute path. When it's an absolute path, it must start with a protocol or a parameterized segment (Otherwise the parse cannot tell if it's absolute or relative).

Example 1: Relative path segments 

@Put("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/"
    + "virtualMachines/{vmName}")
VirtualMachine createOrUpdate(@PathParam("resourceGroupName") String rgName,
    @PathParam("vmName") String vmName,
    @PathParam("subscriptionId") String subscriptionId,
    @BodyParam("application/json") VirtualMachine vm);

Example 2: Absolute path segment 

@Put("{vaultBaseUrl}/secrets/{secretName}")
Secret createOrUpdate(@PathParam(value = "vaultBaseUrl", encoded = true) String vaultBaseUrl,
    @PathParam("secretName") String secretName,
    @BodyParam("application/json") Secret secret);

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Get the relative path of the annotated method's PUT URL.

  • Element Details

    • value

      String value
      Get the relative path of the annotated method's PUT URL.
      Returns:
      The relative path of the annotated method's PUT URL.