client/io.spine.client/SubscriptionRequest

SubscriptionRequest

public final class SubscriptionRequest<S extends EntityState> extends SubscribingRequest<M, C, W, B>

Allows to subscribe to updates of entity states using filtering conditions.

Parameters

<S>

the type of entity state to subscribe

Functions

chain

protected Optional<StreamObserver<SubscriptionUpdate>> chain()

Returns an observer of raw SubscriptionUpdates, which will be called in addition to notifying the consumers.

whenNoLongerMatching

public SubscriptionRequest<S> whenNoLongerMatching<I>(Class<I> idType, Consumer<I> consumer)

Adds a consumer observing the entities which previously matched the subscription criteria, but stopped to do so.

where

public SubscriptionRequest<S> where(Array<CompositeEntityStateFilter> filter)

public SubscriptionRequest<S> where(Array<EntityStateFilter> filter)

Configures the request to return results matching all the passed filters.

Inherited functions

byId

public B byId(Array<Message> ids)

public B byId(Array<Integer> ids)

public B byId(Iterable<? extends Object> ids)

public B byId(Array<Long> ids)

public B byId(Array<String> ids)

Requests only passed IDs to be included into the result of the request.

client

protected final Client client()

Obtains the client instance that will perform the request.

command

public CommandRequest command(CommandMessage c)

Creates a builder for customizing command request.

observe

public B observe(Consumer<M> consumer)

Subscribes the passed consumer to receive messages of the subscribed type.

onConsumingError

public B onConsumingError(ConsumerErrorHandler<M> handler)

Assigns a handler for an error that may occur in the code of one of the consumers.

onServerError

public ClientRequest onServerError(ServerErrorHandler handler)

Assigns a handler for an error occurred on the server-side (such as validation error) in response to posting a request.

onStreamingError

public ClientRequest onStreamingError(ErrorHandler handler)

Assigns a handler for errors occurred when delivering messages from the server.

public B onStreamingError(ErrorHandler handler)

Assigns a handler for the error reported to onError of the StreamObserver responsible for delivering messages to the consumers.

post

public Subscription post()

Creates and posts the subscription request to the server.

select

public QueryRequest<S> select<S extends EntityState>(Class<S> type)

Creates a builder for constructing a query for messages of the specified type.

subscribeTo

public SubscriptionRequest<S> subscribeTo<S extends EntityState>(Class<S> type)

Creates a builder for customizing subscription for the passed entity state type.

subscribeToEvent

public EventSubscriptionRequest<E> subscribeToEvent<E extends EventMessage>(Class<E> type)

Creates a builder for customizing subscription for the passed event type.

user

protected final UserId user()

Obtains the ID of the user of the request.

where

@Deprecated()

public B ~~where~~(Array<CompositeFilter> filter)

@Deprecated()

public B ~~where~~(Array<Filter> filter)

Configures the request to return results matching all the passed filters.

withMask

public B withMask(Iterable<String> fieldNames)

public B withMask(Array<String> fieldNames)

Instructs to populate only fields with the passed names in the results of the request.