org.apache.pekko.http.scaladsl.model

Interface UniversalEntity

All Superinterfaces:

BodyPartEntity, HttpEntity, RequestEntity, ResponseEntity, UniversalEntity

public interface UniversalEntity
extends UniversalEntity, RequestEntity, BodyPartEntity

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pekko.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

Method Summary

Modifier and Type	Method and Description
long	contentLength()
scala.Option<java.lang.Object>	contentLengthOption() Some(content length) if a length is defined for this entity, None otherwise.
UniversalEntity	withContentType(ContentType contentType) Creates a copy of this HttpEntity with the contentType overridden with the given one.
UniversalEntity	withoutSizeLimit() See HttpEntity.withoutSizeLimit()
UniversalEntity	withSizeLimit(long maxBytes) See HttpEntity.withSizeLimit(long).

Methods inherited from interface org.apache.pekko.http.scaladsl.model.RequestEntity

transformDataBytes

Methods inherited from interface org.apache.pekko.http.scaladsl.model.HttpEntity

completionStageCovariant, contentType, dataBytes, discardBytes, discardBytes, getContentLengthOption, getContentType, getDataBytes, isChunked, isCloseDelimited, isDefault, isIndefiniteLength, isKnownEmpty, isStrict, toStrict, toStrict, toStrict, toStrict, toStrict, toStrict, transformDataBytes, withContentType

Method Detail

contentLength

long contentLength()

contentLengthOption

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.

Returns:

(undocumented)

withContentType

UniversalEntity withContentType(ContentType contentType)

Description copied from interface: HttpEntity

Creates a copy of this HttpEntity with the contentType overridden with the given one.

Parameters:

contentType - (undocumented)

Returns:

(undocumented)

withSizeLimit

UniversalEntity withSizeLimit(long maxBytes)

See HttpEntity.withSizeLimit(long).

Specified by:

withSizeLimit in interface HttpEntity

Parameters:

maxBytes - (undocumented)

Returns:

(undocumented)

withoutSizeLimit

UniversalEntity withoutSizeLimit()

See HttpEntity.withoutSizeLimit()

Specified by:

withoutSizeLimit in interface HttpEntity

Returns:

(undocumented)