Delete Interface

Implements

public interface Delete
implements Annotation

HTTP DELETE method annotation describing the parameterized relative path to a REST endpoint for resource deletion.

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

@Delete("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/"
     + "virtualMachines/{vmName}")
 void delete(@PathParam("resourceGroupName") String rgName,
     @PathParam("vmName") String vmName,
     @PathParam("subscriptionId") String subscriptionId);

Example 2: Absolute path segment

@Delete("{vaultBaseUrl}/secrets/{secretName}")
 void delete(@PathParam(value = "vaultBaseUrl", encoded = true) String vaultBaseUrl,
     @PathParam("secretName") String secretName);

Method Summary

Modifier and Type Method and Description
abstract String value()

Get the relative path of the annotated method's DELETE URL.

Method Details

value

public abstract String value()

Get the relative path of the annotated method's DELETE URL.

Returns:

The relative path of the annotated method's DELETE URL.

Applies to