Options Interface

Package:

com.azure.core.annotation

Maven Artifact:

com.azure:azure-core:1.58.0

Implements

Annotation

public interface Options
implements Annotation

HTTP OPTIONS method annotation describing the parameterized relative path to a REST endpoint for retrieving options.

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

@Options("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/"
     + "virtualMachines/{vmName}")
 ResponseBase<ResponseHeaders, ResponseBody> options(@PathParam("resourceGroupName") String rgName,
     @PathParam("vmName") String vmName,
     @PathParam("subscriptionId") String subscriptionId);

Example 2: Absolute path segment

@Options("{vaultBaseUrl}/secrets/{secretName}")
 ResponseBase<ResponseHeaders, ResponseBody> options(
     @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 OPTIONS URL.

Method Details

value

public abstract String value()

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

Returns:

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