HeadAttribute Class

Reference

Definition

Namespace:: Microsoft.Extensions.Http.AutoClient

Assembly:: Microsoft.Extensions.Http.AutoClient.dll

Package:: Microsoft.Extensions.Http.AutoClient v8.0.0-rc.2.23510.2

Source:: HeadAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines an API HEAD method.

public ref class HeadAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class HeadAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method)>]
type HeadAttribute = class
    inherit Attribute

Public NotInheritable Class HeadAttribute
Inherits Attribute

Inheritance: Object

Attribute
HeadAttribute

Attributes: AttributeUsageAttribute

Examples

[AutoClient("MyClient")]
interface IMyDependencyClient
{
    [Head("/api/users/{userId}")]
    Task<UserHead> HeadUserAsync(string userId, CancellationToken cancellationToken);
}

Remarks

Marks a method within an interface annotated with AutoClientAttribute as an API HEAD method.

The return type of an API method must be a Task<T>. If T is a String and the dependency returns "text/plain" content type, the result will be the raw content of the response. Otherwise, it will be deserialized from JSON. If T is of type HttpResponseMessage, the result will be the actual response message without further processing.

If you provide an extra parameter to the method, you should use it between curly braces in the URL to make it an URL parameter. For example: /api/users/{userId}.

Constructors

HeadAttribute(String)

Initializes a new instance of the HeadAttribute class.

Properties

Path	Gets the path of the request.
RequestName	Gets or sets the name to use for this request within telemetry.

Applies to

แชร์ผ่าน