typedrest-reactive/net.typedrest.endpoints.reactive/StreamingCollectionEndpoint

StreamingCollectionEndpoint

interface StreamingCollectionEndpoint<TEntity : Any> : GenericStreamingCollectionEndpoint<TEntity, ElementEndpoint<TEntity>>

Endpoint for a collection of TEntitys observable as an append-only stream.

Use GenericStreamingCollectionEndpoint instead if you wish to customize the element endpoint type.

Type Parameters

TEntity

The type of entity the endpoint represents.

Inheritors

StreamingCollectionEndpointImpl

Properties

createAllAllowed

abstract val createAllAllowed: Boolean?

abstract val createAllowed: Boolean?

abstract val errorHandler: ErrorHandler

abstract val httpClient: OkHttpClient

abstract val linkExtractor: LinkExtractor

pollingInterval

abstract var pollingInterval: Duration

Interval in which requests are sent to the server. The server may update this interval via the Retry-After response header.

abstract val readAllAllowed: Boolean?

readRangeAllowed

abstract val readRangeAllowed: Boolean?

abstract val serializers: List<Serializer>

abstract val setAllAllowed: Boolean?

abstract val uri: URI

Functions

abstract fun create(entity: TEntity): ElementEndpoint<TEntity>?

abstract fun createAll(entities: Iterable<TEntity>)

abstract operator fun get(entity: TEntity): ElementEndpoint<TEntity>

abstract operator fun get(id: String): ElementEndpoint<TEntity>

abstract fun getLinks(rel: String): List<Pair<URI, String?>>

abstract fun getObservable(startIndex: Long = 0): Observable<TEntity>

Provides an observable stream of elements.

abstract fun link(rel: String): URI

abstract fun linkTemplate(rel: String, variables: Map<String, Any>): URI

abstract fun readAll(): List<TEntity>

abstract fun readRange(from: Long?, to: Long?): PartialResponse<TEntity>

abstract fun setAll(entities: Iterable<TEntity>)