All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.azure.core.annotation.Options Maven / Gradle / Ivy

There is a newer version: 1.54.1
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.core.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 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);
 * 
* */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Options { /** * Get the relative path of the annotated method's OPTIONS URL. * * @return The relative path of the annotated method's OPTIONS URL. */ String value(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy