Class: FilteringRequest

(abstract, protected) FilteringRequest(targetTypenon-null, clientnon-null, actorRequestFactorynon-null)

An abstract base for client requests that filter messages by certain criteria.

Constructor

(abstract, protected) new FilteringRequest(targetTypenon-null, clientnon-null, actorRequestFactorynon-null)

Parameters:
Name Type Description
targetType Class.<Message> the target type of the request
client Client the client which initiated the request
actorRequestFactory ActorRequestFactory the request factory
Source:

Classes

FilteringRequest

Methods

(protected) _builder() → {AbstractTargetBuilder.<Message>}

Returns the builder for messages that store request data.
Source:
Returns:
the builder instance
Type
AbstractTargetBuilder.<Message>

(abstract, protected) _newBuilderFn() → {_NewBuilderFn}

Returns the function with which the _builderInstance can be created.
Source:
Returns:
Type
_NewBuilderFn

(abstract, protected) _self() → {this}

Source:
Returns:
Type
this

byId(ids) → {this}

Adds filtering by IDs to the built request.
Parameters:
Name Type Description
ids Message | Number | String | Array.<Message> | Array.<Number> | Array.<String> the IDs of interest
Source:
Returns:
self for method chaining
Type
this

where(predicates) → {this}

Adds filtering by predicates to the built request. Filters specified in a list are considered to be joined using `AND` operator.
Parameters:
Name Type Description
predicates Filter | CompositeFilter | Array.<Filter> | Array.<CompositeFilter> the filters
Source:
Returns:
self for method chaining
Type
this

withMask(fieldPaths) → {this}

Applies a field mask to the request results. The names of the fields must be formatted according to the `google.protobuf.FieldMask` specification.
Parameters:
Name Type Description
fieldPaths String | Array.<String> the fields to include in the mask
Source:
Returns:
self for method chaining
Type
this