HttpRequestMessage<T> Interface

  • Reference
Package:
com.microsoft.azure.functions
Maven Artifact:
com.microsoft.azure.functions:azure-functions-java-library:1.3.1

Type Parameters

T

The type of the body content that is expected to be received as part of this HTTP request.

public interface HttpRequestMessage

An HttpRequestMessage instance is provided to Azure functions that use HttpTrigger. For an example of how to use the http functionality of Azure Functions, refer to the example in the HttpTrigger

Method Summary

Modifier and Type Method and Description
abstract Builder createResponseBuilder(HttpStatus status)

Returns a HttpResponseMessage.Builder instance to build a HttpResponseMessage with standard HTTP status code and no response body.
abstract Builder createResponseBuilder(HttpStatusType status)

Returns a HttpResponseMessage.Builder instance to build a HttpResponseMessage with custome HTTP status code and no response body.
abstract T getBody()

Returns any body content that was included with this HTTP request.
abstract java.util.Map<java.lang.String,java.lang.String> getHeaders()

Returns a map of headers that were contained within this HTTP request.
abstract HttpMethod getHttpMethod()

Returns the HTTP method name as Enum
abstract java.util.Map<java.lang.String,java.lang.String> getQueryParameters()

Returns a map of query parameters that were included with this HTTP request.
abstract java.net.URI getUri()

Returns the URI that was called that resulted in this HTTP request being submitted.

Method Details

createResponseBuilder

public abstract HttpResponseMessage.Builder createResponseBuilder(HttpStatus status)

Returns a HttpResponseMessage.Builder instance to build a HttpResponseMessage with standard HTTP status code and no response body.

Parameters:

status - The HTTP status code to return to the caller of the function.

Returns:

An HttpResponseMessage.Builder instance containing the provided status and empty body.

createResponseBuilder

public abstract HttpResponseMessage.Builder createResponseBuilder(HttpStatusType status)

Returns a HttpResponseMessage.Builder instance to build a HttpResponseMessage with custome HTTP status code and no response body.

Parameters:

status - The HTTP status code to return to the caller of the function.

Returns:

An HttpResponseMessage.Builder instance containing the provided status and empty body.

getBody

public abstract T getBody()

Returns any body content that was included with this HTTP request.

Returns:

any body content that was included with this HTTP request.

getHeaders

public abstract Map getHeaders()

Returns a map of headers that were contained within this HTTP request.

Returns:

a map of headers that were contained within this HTTP request.

getHttpMethod

public abstract HttpMethod getHttpMethod()

Returns the HTTP method name as Enum

Returns:

type of HttpMethod

getQueryParameters

public abstract Map getQueryParameters()

Returns a map of query parameters that were included with this HTTP request.

Returns:

a map of query parameters that were included with this HTTP request.

getUri

public abstract URI getUri()

Returns the URI that was called that resulted in this HTTP request being submitted.

Returns:

the URI that was called that resulted in this HTTP request being submitted.

Applies to