com.azure.core.annotation.Headers 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;

/**
 * Annotation to annotate list of static headers sent to a REST endpoint.
 *
 * Headers are comma separated strings, with each in the format of "header name: header value1,header value2".
 *
 * Examples:
 *
 * 
 *  * @Headers({"Content-Type: application/json; charset=utf-8", "accept-language: en-US"})
 * @Post("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/"
 *     + "hubs/{hubName}/images/getEntityTypeImageUploadUrl")
 * void getUploadUrlForEntityType(@PathParam("resourceGroupName") String resourceGroupName,
 *     @PathParam("hubName") String hubName,
 *     @PathParam("subscriptionId") String subscriptionId,
 *     @BodyParam("application/json") RequestBody parameters);
 * 
 * 
 */
@Retention(RUNTIME)
@Target(METHOD)
public @interface Headers {
    /**
     * List of static headers.
     *
     * @return List of static headers.
     */
    String[] value();
}