BodyParam Interface

Package:

com.azure.core.annotation

Maven Artifact:

com.azure:azure-core:1.58.0

Implements

Annotation

public interface BodyParam
implements Annotation

Annotation to annotate a parameter to send to a REST endpoint as HTTP Request content.

If the parameter type extends InputStream, this payload is streamed to server through "application/octet-stream". Otherwise, the body is serialized first and sent as "application/json" or "application/xml", based on the serializer.

Example 1: Put JSON

@Put("subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/"
     + "virtualMachines/{vmName}")
 VirtualMachine createOrUpdate(@PathParam("resourceGroupName") String rgName,
     @PathParam("vmName") String vmName,
     @PathParam("subscriptionId") String subscriptionId,
     @BodyParam("application/json") VirtualMachine vm);

Example 2: Stream

@Post("formdata/stream/uploadfile")
 void uploadFileViaBody(@BodyParam("application/octet-stream") FileInputStream fileContent);

Method Summary

Modifier and Type	Method and Description
abstract String	value() Gets the Content-Type for the body.

Method Details

value

public abstract String value()

Gets the Content-Type for the body.

Returns:

The Content-Type for the body.