BufferedHttpResponse (Java Client Runtime for AutoRest 2.1.1 API)

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

All Implemented Interfaces:

Closeable, AutoCloseable
```
public final class BufferedHttpResponse
extends HttpResponse
```
HTTP response which will buffer the response's body when/if it is read.

Constructor Summary

Constructors
Constructor and Description

BufferedHttpResponse(HttpResponse innerHttpResponse)
Creates a buffered HTTP response.

Constructors
Constructor and Description
`BufferedHttpResponse(HttpResponse innerHttpResponse)` Creates a buffered HTTP response.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.reactivex.Flowable<ByteBuffer>`	`body()` Returns a stream of the response's body content.
`io.reactivex.Single<byte[]>`	`bodyAsByteArray()` Get this response object's body as a byte[].
`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.
`Object`	`deserializedBody()`
`Object`	`deserializedHeaders()`
`HttpHeaders`	`headers()` Get all the headers on this HTTP response.
`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`.
`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`.

Methods inherited from class com.microsoft.rest.v2.http.HttpResponse
close, request, withRequest

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

- Constructor Detail
  - BufferedHttpResponse
```
public BufferedHttpResponse(HttpResponse innerHttpResponse)
```
    Creates a buffered HTTP response.
    
    Parameters:
    
    innerHttpResponse - The HTTP response to buffer.
- Method Detail
  - statusCode
```
public int statusCode()
```
    Description copied from class: HttpResponse
    
    Get this response object's HTTP status code.
    
    Specified by:
    
    statusCode in class HttpResponse
    
    Returns:
    
    This response object's HTTP status code.
  - headerValue
```
public String headerValue(String headerName)
```
    Description copied from class: HttpResponse
    
    Get the header value for the provided header name, or null if the provided header name does not appear in this HttpResponse's headers.
    
    Specified by:
    
    headerValue in class HttpResponse
    
    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 HttpHeaders headers()
```
    Description copied from class: HttpResponse
    
    Get all the headers on this HTTP response.
    
    Specified by:
    
    headers in class HttpResponse
    
    Returns:
    
    All headers on this HTTP response.
  - bodyAsByteArray
```
public io.reactivex.Single<byte[]> bodyAsByteArray()
```
    Description copied from class: HttpResponse
    
    Get this response object's body as a byte[]. If this response object doesn't have a body, then null will be returned.
    
    Specified by:
    
    bodyAsByteArray in class HttpResponse
    
    Returns:
    
    This response object's body as a byte[]. If this response object doesn't have a body, then null will be returned.
  - body
```
public io.reactivex.Flowable<ByteBuffer> body()
```
    Description copied from class: HttpResponse
    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.
    Specified by:
    
    body in class HttpResponse
    
    Returns:
    
    The response's body as a stream of ByteBuffer.
  - bodyAsString
```
public io.reactivex.Single<String> bodyAsString()
```
    Description copied from class: HttpResponse
    
    Get this response object's body as a string. If this response object doesn't have a body, then null will be returned.
    
    Specified by:
    
    bodyAsString in class HttpResponse
    
    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()
```
    Description copied from class: HttpResponse
    
    Buffers the HTTP response body into memory, allowing the content to be inspected and replayed.
    
    Overrides:
    
    buffer in class HttpResponse
    
    Returns:
    
    This HTTP response, with body content buffered into memory.
  - isDecoded
```
public boolean isDecoded()
```
    Description copied from class: HttpResponse
    
    Returns a value indicating whether this HttpResponse has been decoded by a DecodingPolicyFactory.
    
    Overrides:
    
    isDecoded in class HttpResponse
    
    Returns:
    
    whether this HttpResponse has been decoded
  - withIsDecoded
```
public boolean withIsDecoded(boolean isDecoded)
```
    Description copied from class: HttpResponse
    
    Sets the flag indicating whether this HttpResponse has been decoded by a DecodingPolicyFactory.
    
    Overrides:
    
    withIsDecoded in class HttpResponse
    
    Parameters:
    
    isDecoded - whether this HttpResponse has been decoded
    
    Returns:
    
    this HTTP repsonse
  - deserializedHeaders
```
public Object deserializedHeaders()
```
    Overrides:
    
    deserializedHeaders in class HttpResponse
    
    Returns:
    
    the deserialized headers, if present. Otherwise, null.
  - withDeserializedHeaders
```
public HttpResponse withDeserializedHeaders(Object deserializedHeaders)
```
    Description copied from class: HttpResponse
    
    Set the deserialized headers on this HttpResponse.
    
    Overrides:
    
    withDeserializedHeaders in class HttpResponse
    
    Parameters:
    
    deserializedHeaders - the deserialized headers
    
    Returns:
    
    this HTTP repsonse
  - deserializedBody
```
public Object deserializedBody()
```
    Overrides:
    
    deserializedBody in class HttpResponse
    
    Returns:
    
    the deserialized body, if present. Otherwise, null.
  - withDeserializedBody
```
public HttpResponse withDeserializedBody(Object deserializedBody)
```
    Description copied from class: HttpResponse
    
    Sets the deserialized body on this HttpResponse.
    
    Overrides:
    
    withDeserializedBody in class HttpResponse
    
    Parameters:
    
    deserializedBody - the deserialized body
    
    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 BufferedHttpResponse

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.rest.v2.http.HttpResponse

Methods inherited from class java.lang.Object

Constructor Detail

BufferedHttpResponse

Method Detail

statusCode

headerValue

headers

bodyAsByteArray

body

bodyAsString

buffer

isDecoded

withIsDecoded

deserializedHeaders

withDeserializedHeaders

deserializedBody

withDeserializedBody