RequestBody (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.sync.RequestBody

```
public class RequestBody
extends Object
```
Represents the body of an HTTP request. Must be provided for operations that have a streaming input. Offers various convenience factory methods from common sources of data (File, String, byte[], etc). Body contents are made reproducible where possible to facilitate automatic retries.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`InputStream`	`asStream()`
`static RequestBody`	`empty()`	Creates a `RequestBody` with no content.
`long`	`getContentLength()`
`static RequestBody`	`of(byte[] bytes)`	Creates a `RequestBody` from a byte array.
`static RequestBody`	`of(File file)`	Create a `RequestBody` using the full contents of the specified file.
`static RequestBody`	`of(InputStream inputStream, long contentLength)`	Creates a `RequestBody` from an input stream.
`static RequestBody`	`of(String contents)`	Creates a `RequestBody` from a string.
`static RequestBody`	`of(ByteBuffer byteBuffer)`	Creates a `RequestBody` from a `ByteBuffer`.
`static RequestBody`	`of(Path path)`	Create a `RequestBody` using the full contents of the specified file.

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

- Method Detail
  - asStream
```
public InputStream asStream()
```
    Returns:
    
    RequestBody as an InputStream.
  - getContentLength
```
public long getContentLength()
```
    Returns:
    
    Content length of RequestBody.
  - of
```
public static RequestBody of(Path path)
```
    Create a RequestBody using the full contents of the specified file.
    
    Parameters:
    
    path - File to send to the service.
    
    Returns:
    
    RequestBody instance.
  - of
```
public static RequestBody of(File file)
```
    Create a RequestBody using the full contents of the specified file.
    
    Parameters:
    
    file - File to send to the service.
    
    Returns:
    
    RequestBody instance.
  - of
```
public static RequestBody of(InputStream inputStream,
                             long contentLength)
```
    Creates a RequestBody from an input stream. "Content-Length" must be provided so that the SDK does not have to make two passes of the data.
    This stream will be consumed and closed by the SDK. It should NOT be re-used after making an API call with it. It should also not be read outside of the SDK (by another thread) as it will change the state of the InputStream and could tamper with the sending of the request.
    
    Parameters:
    
    inputStream - Input stream to send to the service.
    
    contentLength - Content length of data in input stream.
    
    Returns:
    
    RequestBody instance.
  - of
```
public static RequestBody of(String contents)
```
    Creates a RequestBody from a string. String is sent as UTF-8 encoded bytes.
    
    Parameters:
    
    contents - String to send to the service.
    
    Returns:
    
    RequestBody instance.
  - of
```
public static RequestBody of(byte[] bytes)
```
    Creates a RequestBody from a byte array. The contents of the byte array are copied so modifications to the original byte array are not reflected in the RequestBody.
    
    Parameters:
    
    bytes - The bytes to send to the service.
    
    Returns:
    
    RequestBody instance.
  - of
```
public static RequestBody of(ByteBuffer byteBuffer)
```
    Creates a RequestBody from a ByteBuffer. Buffer contents are copied so any modifications made to the original ByteBuffer are not reflected in the RequestBody.
    
    Parameters:
    
    byteBuffer - ByteBuffer to send to the service.
    
    Returns:
    
    RequestBody instance.
  - empty
```
public static RequestBody empty()
```
    Creates a RequestBody with no content.
    
    Returns:
    
    RequestBody instance.

Class RequestBody

Method Summary

Methods inherited from class java.lang.Object

Method Detail

asStream

getContentLength

of

of

of

of

of

of

empty