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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-core Show documentation

This package contains core types for Azure Java clients.

There is a newer version: 1.54.1

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.core.annotation;

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

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * HTTP HEAD method annotation describing the parameterized relative path to a REST endpoint.
 *
 * 
 * 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
 * 
 *
 * 
 *  * @Head("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/"
 *     + "virtualMachines/{vmName}")
 * boolean checkNameAvailability(@PathParam("resourceGroupName") String rgName,
 *     @PathParam("vmName") String vmName,
 *     @PathParam("subscriptionId") String subscriptionId);
 * 
 * 
 *
 * 
 * Example 2: Absolute path segment
 * 
 *
 * 
 *  * @Head("{storageAccountId}")
 * boolean checkNameAvailability(@PathParam("storageAccountId") String storageAccountId);
 * 
 * 
 */
@Retention(RUNTIME)
@Target(METHOD)
public @interface Head {
    /**
     * Get the relative path of the annotated method's HEAD URL.
     *
     * @return The relative path of the annotated method's HEAD URL.
     */
    String value();
}