com.azure.core.annotation

Package:

com.azure.core.annotation

Maven Artifact:

com.azure:azure-core:1.55.2

This package contains annotations for client-side methods that map to REST APIs in the Azure SDK.

These annotations are used to define the HTTP method (GET, POST, PUT, DELETE, etc.) and the relative path for the REST endpoint. They also provide a way to specify path parameters, query parameters, and the request body.

Here are some of the key annotations included in this package:

• Get: Annotation for HTTP GET method.
• Put: Annotation for HTTP PUT method.
• QueryParam: Annotation for query parameters to be appended to a REST API Request URI.

Interfaces

BodyParam	Annotation to annotate a parameter to send to a REST endpoint as HTTP Request content.
Delete	HTTP DELETE method annotation describing the parameterized relative path to a REST endpoint for resource deletion.
ExpectedResponses	Annotation to annotate list of HTTP status codes that are expected in response from a REST endpoint.
Fluent	Annotation given to all classes that are expected to provide a fluent API to end users.
FormParam	Annotation for form parameters to be sent to a REST API Request URI.
Generated	Annotation given to all methods that are generated by AutoRest.
Get	HTTP GET method annotation describing the parameterized relative path to a REST endpoint for resource retrieval.
Head	HTTP HEAD method annotation describing the parameterized relative path to a REST endpoint.
HeaderCollection	Annotation on a deserialized header type that indicates that the property should be treated as a header collection with the provided prefix.
HeaderParam	Replaces the header with the value of its target.
Headers	Annotation to annotate list of static headers sent to a REST endpoint.
Host	Annotation for parameterized host name targeting a REST service.
HostParam	Annotation to annotate replacement of parameterized segments in a dynamic Host.
Immutable	Annotation given to all immutable classes.
JsonFlatten	Annotation used for flattening properties separated by '.'.
Options	HTTP OPTIONS method annotation describing the parameterized relative path to a REST endpoint for retrieving options.
Patch	HTTP PATCH method annotation describing the parameterized relative path to a REST endpoint for resource update.
PathParam	Annotation to annotate replacement for a named path segment in REST endpoint URL.
Post	HTTP POST method annotation describing the parameterized relative path to a REST endpoint for an action.
Put	HTTP PUT method annotation describing the parameterized relative path to a REST endpoint for resource creation or update.
QueryParam	Annotation for query parameters to be appended to a REST API Request URI.
ResumeOperation	Deprecated This interface is no longer used, or respected, in code.
ReturnValueWireType	Annotation for the type that will be used to deserialize the return value of a REST API response.
ServiceClient	Annotation given to all service client classes.
ServiceClientBuilder	Annotation given to all service client builder classes.
ServiceInterface	Annotation to give the service interfaces a name that correlates to the service that is usable in a programmatic way.
ServiceMethod	Annotation given to all service client methods that perform network operations.
UnexpectedResponseExceptionType	The exception type that is thrown or returned when one of the status codes is returned from a REST API.
UnexpectedResponseExceptionTypes	The Repeatable container annotation for UnexpectedResponseExceptionType.

Enums

ReturnType	Enumeration of return types used with ServiceMethod annotation to indicate if a method is expected to return a single item or a collection
ServiceClientProtocol	Enumeration of protocols available for setting the protocol() property of ServiceClientBuilder annotation.