io.spine.client

Class FilteringRequest<M extends com.google.protobuf.Message,R extends com.google.protobuf.Message,A extends TargetBuilder<R,A>,B extends FilteringRequest<M,R,A,B>>

java.lang.Object

io.spine.client.ClientRequest

io.spine.client.FilteringRequest<M,R,A,B>

Type Parameters:

M - the type of the messages returned by the request

R - the type of the request to be posted

A - the type of the builder of the request

B - the type of this client request (which wraps over type <A> for return type covariance

Direct Known Subclasses:

QueryRequest, SubscribingRequest

public abstract class FilteringRequest<M extends com.google.protobuf.Message,R extends com.google.protobuf.Message,A extends TargetBuilder<R,A>,B extends FilteringRequest<M,R,A,B>>
extends ClientRequest

Abstract base for client requests that may filter messages by certain criteria.

This class warps around TargetBuilder for providing fluent API for client request composition and placement.

Method Summary

Modifier and Type	Method and Description
B	byId(java.lang.Integer... ids) Requests only passed IDs to be included into the result of the request.
B	byId(java.lang.Iterable<?> ids) Requests only passed IDs to be included into the result of the request.
B	byId(java.lang.Long... ids) Requests only passed IDs to be included into the result of the request.
B	byId(com.google.protobuf.Message... ids) Requests only passed IDs to be included into the result of the request.
B	byId(java.lang.String... ids) Requests only passed IDs to be included into the result of the request.
B	where(io.spine.client.CompositeFilter... filter) Deprecated. Please use the overloads from the descendants that rely on strongly-typed filters.
B	where(io.spine.client.Filter... filter) Deprecated. Please use the overloads from the descendants that rely on strongly-typed filters.
B	withMask(java.lang.Iterable<java.lang.String> fieldNames) Instructs to populate only fields with the passed names in the results of the request.
B	withMask(java.lang.String... fieldNames) Instructs to populate only fields with the passed names in the results of the request.

Methods inherited from class io.spine.client.ClientRequest

client, command, onServerError, onStreamingError, select, subscribeTo, subscribeToEvent, user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

byId

public B byId(java.lang.Iterable<?> ids)

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

The calling code must pass identifiers that are of the same type, which also matches the ID type of the requested messages.

If the passed iterable is empty, all records matching other criteria will be returned.

byId

public B byId(com.google.protobuf.Message... ids)

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

byId

public B byId(java.lang.Long... ids)

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

byId

public B byId(java.lang.Integer... ids)

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

byId

public B byId(java.lang.String... ids)

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

where

@Deprecated
public B where(io.spine.client.Filter... filter)

Deprecated. Please use the overloads from the descendants that rely on strongly-typed filters.

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

where

@Deprecated
public B where(io.spine.client.CompositeFilter... filter)

Deprecated. Please use the overloads from the descendants that rely on strongly-typed filters.

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

withMask

public B withMask(java.lang.Iterable<java.lang.String> fieldNames)

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

withMask

public B withMask(java.lang.String... fieldNames)

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