java.lang.Object
- akka.http.scaladsl.model.HttpEntity.Chunked

All Implemented Interfaces:

HttpEntity, HttpEntity.Chunked, RequestEntity, ResponseEntity, HttpEntity, RequestEntity, ResponseEntity, java.io.Serializable, scala.Equals, scala.Product

Enclosing interface:

HttpEntity
```
public static final class HttpEntity.Chunked
extends java.lang.Object
implements HttpEntity.Chunked, RequestEntity, scala.Product, java.io.Serializable
```
The model for the entity of a chunked HTTP message (with Transfer-Encoding: chunked).

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface akka.http.javadsl.model.HttpEntity
  HttpEntity.Chunked, HttpEntity.ChunkStreamPart, HttpEntity.CloseDelimited, HttpEntity.Default, HttpEntity.DiscardedEntity, HttpEntity.IndefiniteLength, HttpEntity.Strict
- Nested classes/interfaces inherited from interface akka.http.scaladsl.model.HttpEntity
  HttpEntity.Chunk, HttpEntity.Chunk$, HttpEntity.Chunked, HttpEntity.Chunked$, HttpEntity.ChunkStreamPart, HttpEntity.ChunkStreamPart$, HttpEntity.CloseDelimited, HttpEntity.CloseDelimited$, HttpEntity.Default, HttpEntity.Default$, HttpEntity.DiscardedEntity, HttpEntity.HttpEntityScalaDSLSugar, HttpEntity.HttpEntityScalaDSLSugar$, HttpEntity.IndefiniteLength, HttpEntity.IndefiniteLength$, HttpEntity.LastChunk, HttpEntity.LastChunk$, HttpEntity.Strict, HttpEntity.Strict$, HttpEntity.WithoutKnownLength

Constructor Summary

Constructors
Constructor Description

Chunked(ContentType contentType, akka.stream.scaladsl.Source<HttpEntity.ChunkStreamPart,java.lang.Object> chunks)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`akka.stream.scaladsl.Source<HttpEntity.ChunkStreamPart,java.lang.Object>`	`chunks()`
`scala.Option<java.lang.Object>`	`contentLengthOption()`	Some(content length) if a length is defined for this entity, None otherwise.
`ContentType`	`contentType()`	The `ContentType` associated with this entity.
`akka.stream.scaladsl.Source<akka.util.ByteString,java.lang.Object>`	`dataBytes()`	A stream of the data of this entity.
`akka.stream.javadsl.Source<HttpEntity.ChunkStreamPart,java.lang.Object>`	`getChunks()`	Java API
`boolean`	`isChunked()`	Returns if this entity is a subtype of HttpEntityChunked.
`boolean`	`isKnownEmpty()`	Returns if this entity is known to be empty.
`java.lang.String`	`productPrefix()`
`java.lang.String`	`toString()`
`HttpEntity.Chunked`	`transformDataBytes(akka.stream.scaladsl.Flow<akka.util.ByteString,akka.util.ByteString,java.lang.Object> transformer)`	Returns a copy of the given entity with the ByteString chunks of this entity transformed by the given transformer.
`HttpEntity.Chunked`	`withContentType(ContentType contentType)`	Creates a copy of this HttpEntity with the `contentType` overridden with the given one.
`HttpEntity.Chunked`	`withoutSizeLimit()`	Lift the size limit from this entity by returning a new entity instance which skips the size verification.
`HttpEntity.Chunked`	`withSizeLimit(long maxBytes)`	Apply the given size limit to this entity by returning a new entity instance which automatically verifies that the data stream encapsulated by this instance produces at most `maxBytes` data bytes.

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

Methods inherited from interface scala.Equals
canEqual, equals

Methods inherited from interface akka.http.scaladsl.model.HttpEntity
completionStageCovariant, discardBytes, discardBytes, getContentLengthOption, getContentType, getDataBytes, isCloseDelimited, isDefault, isIndefiniteLength, isStrict, toStrict, toStrict, toStrict, toStrict, toStrict, toStrict, transformDataBytes, withContentType

Methods inherited from interface scala.Product
productArity, productElement, productElementName, productElementNames, productIterator

- Constructor Detail
  - Chunked
```
public Chunked(ContentType contentType,
               akka.stream.scaladsl.Source<HttpEntity.ChunkStreamPart,java.lang.Object> chunks)
```
- Method Detail
  - contentType
```
public ContentType contentType()
```
    Description copied from interface: HttpEntity
    
    The ContentType associated with this entity.
    
    Specified by:
    
    contentType in interface HttpEntity
    
    Returns:
    
    (undocumented)
  - chunks
```
public akka.stream.scaladsl.Source<HttpEntity.ChunkStreamPart,java.lang.Object> chunks()
```
  - isKnownEmpty
```
public boolean isKnownEmpty()
```
    Description copied from interface: HttpEntity
    
    Returns if this entity is known to be empty. Open-ended entity types like HttpEntityChunked and HttpCloseDelimited will always return false here.
    
    Specified by:
    
    isKnownEmpty in interface HttpEntity
    
    Specified by:
    
    isKnownEmpty in interface HttpEntity
    
    Returns:
    
    (undocumented)
  - contentLengthOption
```
public scala.Option<java.lang.Object> contentLengthOption()
```
    Description copied from interface: HttpEntity
    
    Some(content length) if a length is defined for this entity, None otherwise. A length is only defined for Strict and Default entity types.
    In many cases it's dangerous to rely on the (non-)existence of a content-length. HTTP intermediaries like (transparent) proxies are allowed to change the transfer-encoding which can result in the entity being delivered as another type as expected.
    
    Specified by:
    
    contentLengthOption in interface HttpEntity
    
    Returns:
    
    (undocumented)
  - isChunked
```
public boolean isChunked()
```
    Description copied from interface: HttpEntity
    
    Returns if this entity is a subtype of HttpEntityChunked.
    
    Specified by:
    
    isChunked in interface HttpEntity
    
    Specified by:
    
    isChunked in interface HttpEntity
  - dataBytes
```
public akka.stream.scaladsl.Source<akka.util.ByteString,java.lang.Object> dataBytes()
```
    Description copied from interface: HttpEntity
    
    A stream of the data of this entity.
    
    Specified by:
    
    dataBytes in interface HttpEntity
    
    Returns:
    
    (undocumented)
  - withSizeLimit
```
public HttpEntity.Chunked withSizeLimit(long maxBytes)
```
    Description copied from interface: HttpEntity
    
    Apply the given size limit to this entity by returning a new entity instance which automatically verifies that the data stream encapsulated by this instance produces at most `maxBytes` data bytes. In case this verification fails the respective stream will be terminated with an `EntityStreamException` either directly at materialization time (if the Content-Length is known) or whenever more data bytes than allowed have been read. When called on `Strict` entities the method will return the entity itself if the length is within the bound, otherwise a `Default` entity with a single element data stream. This allows for potential refinement of the entity size limit at a later point (before materialization of the data stream). By default all message entities produced by the HTTP layer automatically carry the limit that is defined in the application's `max-content-length` config setting. If the entity is transformed in a way that changes the Content-Length and then another limit is applied then this new limit will be evaluated against the new Content-Length. If the entity is transformed in a way that changes the Content-Length and no new limit is applied then the previous limit will be applied against the previous Content-Length.
    
    Specified by:
    
    withSizeLimit in interface HttpEntity
    
    Specified by:
    
    withSizeLimit in interface HttpEntity
    
    Specified by:
    
    withSizeLimit in interface RequestEntity
    
    Specified by:
    
    withSizeLimit in interface ResponseEntity
    
    Parameters:
    
    maxBytes - (undocumented)
    
    Returns:
    
    (undocumented)
  - withoutSizeLimit
```
public HttpEntity.Chunked withoutSizeLimit()
```
    Description copied from interface: HttpEntity
    
    Lift the size limit from this entity by returning a new entity instance which skips the size verification. By default all message entities produced by the HTTP layer automatically carry the limit that is defined in the application's `max-content-length` config setting. It is recommended to always keep an upper limit on accepted entities to avoid potential attackers flooding you with too large requests/responses, so use this method with caution. See [[withSizeLimit]] for more details.
    
    Specified by:
    
    withoutSizeLimit in interface HttpEntity
    
    Specified by:
    
    withoutSizeLimit in interface HttpEntity
    
    Specified by:
    
    withoutSizeLimit in interface RequestEntity
    
    Specified by:
    
    withoutSizeLimit in interface ResponseEntity
    
    Returns:
    
    (undocumented)
  - transformDataBytes
```
public HttpEntity.Chunked transformDataBytes(akka.stream.scaladsl.Flow<akka.util.ByteString,akka.util.ByteString,java.lang.Object> transformer)
```
    Description copied from interface: HttpEntity
    
    Returns a copy of the given entity with the ByteString chunks of this entity transformed by the given transformer. For a Chunked entity, the chunks will be transformed one by one keeping the chunk metadata (but may introduce an extra chunk before the LastChunk if transformer.onTermination returns additional data).
    This method may only throw an exception if the transformer function throws an exception while creating the transformer. Any other errors are reported through the new entity data stream.
    
    Specified by:
    
    transformDataBytes in interface HttpEntity
    
    Specified by:
    
    transformDataBytes in interface RequestEntity
    
    Specified by:
    
    transformDataBytes in interface ResponseEntity
    
    Parameters:
    
    transformer - (undocumented)
    
    Returns:
    
    (undocumented)
  - withContentType
```
public HttpEntity.Chunked withContentType(ContentType contentType)
```
    Description copied from interface: HttpEntity
    
    Creates a copy of this HttpEntity with the contentType overridden with the given one.
    
    Specified by:
    
    withContentType in interface HttpEntity
    
    Specified by:
    
    withContentType in interface RequestEntity
    
    Specified by:
    
    withContentType in interface ResponseEntity
    
    Parameters:
    
    contentType - (undocumented)
    
    Returns:
    
    (undocumented)
  - productPrefix
```
public java.lang.String productPrefix()
```
    Specified by:
    
    productPrefix in interface scala.Product
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getChunks
```
public akka.stream.javadsl.Source<HttpEntity.ChunkStreamPart,java.lang.Object> getChunks()
```
    Java API
    
    Specified by:
    
    getChunks in interface HttpEntity.Chunked

Class HttpEntity.Chunked

Nested Class Summary

Nested classes/interfaces inherited from interface akka.http.javadsl.model.HttpEntity

Nested classes/interfaces inherited from interface akka.http.scaladsl.model.HttpEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface scala.Equals

Methods inherited from interface akka.http.scaladsl.model.HttpEntity

Methods inherited from interface scala.Product

Constructor Detail

Chunked

Method Detail

contentType

chunks

isKnownEmpty

contentLengthOption

isChunked

dataBytes

withSizeLimit

withoutSizeLimit

transformDataBytes

withContentType

productPrefix

toString

getChunks