HttpResponse (Java Client Runtime for AutoRest 2.1.1 API)

java.lang.Object
- com.microsoft.rest.v2.http.HttpResponse

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

BufferedHttpResponse
```
public abstract class HttpResponse
extends Object
implements Closeable
```
This class contains all of the details necessary for reacting to a HTTP response from a HttpResponse.

Constructor Summary

Constructors
Constructor and Description

HttpResponse()

Constructors
Constructor and Description
`HttpResponse()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract io.reactivex.Flowable<ByteBuffer>`	`body()` Returns a stream of the response's body content.
`abstract io.reactivex.Single<byte[]>`	`bodyAsByteArray()` Get this response object's body as a byte[].
`abstract io.reactivex.Single<String>`	`bodyAsString()` Get this response object's body as a string.
`BufferedHttpResponse`	`buffer()` Buffers the HTTP response body into memory, allowing the content to be inspected and replayed.
`void`	`close()` Closes the stream providing this HttpResponse's content, if any.
`Object`	`deserializedBody()`
`Object`	`deserializedHeaders()`
`abstract HttpHeaders`	`headers()` Get all the headers on this HTTP response.
`abstract String`	`headerValue(String headerName)` Get the header value for the provided header name, or null if the provided header name does not appear in this HttpResponse's headers.
`boolean`	`isDecoded()` Returns a value indicating whether this HttpResponse has been decoded by a `DecodingPolicyFactory`.
`HttpRequest`	`request()`
`abstract int`	`statusCode()` Get this response object's HTTP status code.
`HttpResponse`	`withDeserializedBody(Object deserializedBody)` Sets the deserialized body on this HttpResponse.
`HttpResponse`	`withDeserializedHeaders(Object deserializedHeaders)` Set the deserialized headers on this HttpResponse.
`boolean`	`withIsDecoded(boolean isDecoded)` Sets the flag indicating whether this HttpResponse has been decoded by a `DecodingPolicyFactory`.
`HttpResponse`	`withRequest(HttpRequest request)` Sets the request on this HttpResponse.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpResponse
```
public HttpResponse()
```
- Method Detail
  - statusCode
```
public abstract int statusCode()
```
    Get this response object's HTTP status code.
    
    Returns:
    
    This response object's HTTP status code.
  - headerValue
```
public abstract String headerValue(String headerName)
```
    Get the header value for the provided header name, or null if the provided header name does not appear in this HttpResponse's headers.
    
    Parameters:
    
    headerName - The name of the header to lookup.
    
    Returns:
    
    The value of the header, or null if the header doesn't exist in this HttpResponse.
  - headers
```
public abstract HttpHeaders headers()
```
    Get all the headers on this HTTP response.
    
    Returns:
    
    All headers on this HTTP response.
  - body
```
public abstract io.reactivex.Flowable<ByteBuffer> body()
```
    Returns a stream of the response's body content. Emissions may occur on the Netty EventLoop threads which are shared across channels and should not be blocked. Blocking should be avoided as much as possible/practical in reactive programming but if you do use methods like blockingSubscribe or blockingGet on the stream then be sure to use subscribeOn and observeOn before the blocking call. For example:
```
 
   response.body()
     .map(bb -> bb.limit())
     .reduce((x,y) -> x + y)
     .subscribeOn(Schedulers.io())
     .observeOn(Schedulers.io())
     .blockingGet();
 
 
```
    The above code is a simplistic example and would probably run fine without the `subscribeOn` and `observeOn` but should be considered a template for more complex situations.
    Returns:
    
    The response's body as a stream of ByteBuffer.
  - bodyAsByteArray
```
public abstract io.reactivex.Single<byte[]> bodyAsByteArray()
```
    Get this response object's body as a byte[]. If this response object doesn't have a body, then null will be returned.
    
    Returns:
    
    This response object's body as a byte[]. If this response object doesn't have a body, then null will be returned.
  - bodyAsString
```
public abstract io.reactivex.Single<String> bodyAsString()
```
    Get this response object's body as a string. If this response object doesn't have a body, then null will be returned.
    
    Returns:
    
    This response object's body as a string. If this response object doesn't have a body, then null will be returned.
  - buffer
```
public BufferedHttpResponse buffer()
```
    Buffers the HTTP response body into memory, allowing the content to be inspected and replayed.
    
    Returns:
    
    This HTTP response, with body content buffered into memory.
  - close
```
public void close()
```
    Closes the stream providing this HttpResponse's content, if any.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - isDecoded
```
public boolean isDecoded()
```
    Returns a value indicating whether this HttpResponse has been decoded by a DecodingPolicyFactory.
    
    Returns:
    
    whether this HttpResponse has been decoded
  - withIsDecoded
```
public boolean withIsDecoded(boolean isDecoded)
```
    Sets the flag indicating whether this HttpResponse has been decoded by a DecodingPolicyFactory.
    
    Parameters:
    
    isDecoded - whether this HttpResponse has been decoded
    
    Returns:
    
    this HTTP repsonse
  - deserializedHeaders
```
public Object deserializedHeaders()
```
    Returns:
    
    the deserialized headers, if present. Otherwise, null.
  - withDeserializedHeaders
```
public HttpResponse withDeserializedHeaders(Object deserializedHeaders)
```
    Set the deserialized headers on this HttpResponse.
    
    Parameters:
    
    deserializedHeaders - the deserialized headers
    
    Returns:
    
    this HTTP repsonse
  - deserializedBody
```
public Object deserializedBody()
```
    Returns:
    
    the deserialized body, if present. Otherwise, null.
  - withDeserializedBody
```
public HttpResponse withDeserializedBody(Object deserializedBody)
```
    Sets the deserialized body on this HttpResponse.
    
    Parameters:
    
    deserializedBody - the deserialized body
    
    Returns:
    
    this HTTP response
  - request
```
public final HttpRequest request()
```
    Returns:
    
    The request which resulted in this HttpResponse.
  - withRequest
```
public final HttpResponse withRequest(HttpRequest request)
```
    Sets the request on this HttpResponse.
    
    Parameters:
    
    request - the request which resulted in this HttpResponse
    
    Returns:
    
    this HTTP response

/** 
* Copyright (c) Microsoft Corporation. All rights reserved. 
* Licensed under the MIT License. See License.txt in the project root for 
* license information. 
*/

Class HttpResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpResponse

Method Detail

statusCode

headerValue

headers

body

bodyAsByteArray

bodyAsString

buffer

close

isDecoded

withIsDecoded

deserializedHeaders

withDeserializedHeaders

deserializedBody

withDeserializedBody

request

withRequest