com.microsoft.azure.functions

Interface HttpResponseMessage

public interface HttpResponseMessage

An HttpResponseMessage instance is returned by Azure Functions methods that are triggered by an HttpTrigger.

Since:

1.0.0

See Also:

HttpTrigger, HttpRequestMessage

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpResponseMessage.Builder A builder to create an instance of HttpResponseMessage

Method Summary

Modifier and Type	Method and Description
Object	getBody() Returns the body of the HTTP response.
String	getHeader(String key) Returns a header value for the given key.
HttpStatusType	getStatus() Returns the HTTP status code set on the HttpResponseMessage instance.
default int	getStatusCode() Returns the HTTP status code set on the HttpResponseMessage instance.

Method Detail

getStatus

HttpStatusType getStatus()

Returns the HTTP status code set on the HttpResponseMessage instance.

Returns:

the status code set on the HttpResponseMessage instance.

getStatusCode

default int getStatusCode()

Returns the HTTP status code set on the HttpResponseMessage instance.

Returns:

the status code set on the HttpResponseMessage instance.

getHeader

String getHeader(String key)

Returns a header value for the given key.

Parameters:

key - The key for which the header value is sought.

Returns:

Returns the value if the key has previously been added, or null if it has not.

getBody

Object getBody()

Returns the body of the HTTP response.

Returns:

the body of the HTTP response.