Skip navigation links
A B C D E F G I L N O P Q R S T U V W Z 

A

accept(S, EmptyContext) - Method in interface io.spine.client.StateConsumer
 
ack(StreamObserver<Response>) - Static method in class io.spine.grpc.StreamObservers
A utility method which sends acknowledgement to the client via the responseObserver provided and completes the response.
actor() - Method in class io.spine.client.ActorRequestFactory
Obtains the ID of the user on behalf of whom the requests are created.
ActorRequestFactory - Class in io.spine.client
A factory for various requests fired from the client-side by an actor.
ActorRequestFactory(ActorRequestFactory.Builder) - Constructor for class io.spine.client.ActorRequestFactory
 
ActorRequestFactory.Builder - Class in io.spine.client
A builder for ActorRequestFactory.
all(EntityStateFilter, EntityStateFilter...) - Static method in class io.spine.client.CompositeEntityStateFilter
Creates a new conjunction composite filter.
all(EventFilter, EventFilter...) - Static method in class io.spine.client.CompositeEventFilter
Creates a new conjunction composite filter.
all(QueryFilter, QueryFilter...) - Static method in class io.spine.client.CompositeQueryFilter
Creates a new conjunction composite filter.
all(Filter, Filter...) - Static method in class io.spine.client.Filters
Creates a new conjunction composite filter.
all(Class<? extends EntityState>) - Method in class io.spine.client.QueryFactory
Creates a Query to read all states of a certain entity.
all() - Method in interface io.spine.client.QueryMixin
Tells if this query requests all instances of the target type.
allOf(Class<? extends Message>) - Method in class io.spine.client.TopicFactory
Creates a Topic for all events/entities of the specified type.
allWithMask(Class<? extends EntityState>, String...) - Method in class io.spine.client.QueryFactory
Creates a Query to read all entity states with the FieldMask applied to each of the results.
asGuest() - Method in class io.spine.client.Client
Creates a builder for posting guest requests.

B

build() - Method in class io.spine.client.ActorRequestFactory.Builder
Ensures that all the Builder parameters are set properly.
build() - Method in class io.spine.client.Client.Builder
Creates a new instance of the client.
build() - Method in class io.spine.client.QueryBuilder
Generates a new Query instance with current builder configuration.
build() - Method in class io.spine.client.TargetBuilder
 
build() - Method in class io.spine.client.TopicBuilder
Generates a new Topic instance with current builder configuration.
Builder() - Constructor for class io.spine.client.ActorRequestFactory.Builder
 
byId(Iterable<?>) - Method in class io.spine.client.FilteringRequest
Requests only passed IDs to be included into the result of the request.
byId(Message...) - Method in class io.spine.client.FilteringRequest
Requests only passed IDs to be included into the result of the request.
byId(Long...) - Method in class io.spine.client.FilteringRequest
Requests only passed IDs to be included into the result of the request.
byId(Integer...) - Method in class io.spine.client.FilteringRequest
Requests only passed IDs to be included into the result of the request.
byId(String...) - Method in class io.spine.client.FilteringRequest
Requests only passed IDs to be included into the result of the request.
byId(Iterable<?>) - Method in class io.spine.client.TargetBuilder
Sets the ID predicate to the targets of the request.
byId(Message...) - Method in class io.spine.client.TargetBuilder
Sets the ID predicate to the Query.
byId(String...) - Method in class io.spine.client.TargetBuilder
Sets the ID predicate to the Query.
byId(Integer...) - Method in class io.spine.client.TargetBuilder
Sets the ID predicate to the Query.
byId(Long...) - Method in class io.spine.client.TargetBuilder
Sets the ID predicate to the Query.
byIds(Class<? extends EntityState>, Set<?>) - Method in class io.spine.client.QueryFactory
Creates a Query to read certain entity states by IDs.
byIdsWithMask(Class<? extends EntityState>, Set<?>, String...) - Method in class io.spine.client.QueryFactory
Creates a Query to read certain entity states by IDs with the FieldMask applied to each of the results.

C

cancel(Subscription) - Method in class io.spine.client.Client
Deprecated.
cancel(Subscription) - Method in class io.spine.client.Subscriptions
Requests cancellation the passed subscription.
cancelAll() - Method in class io.spine.client.Subscriptions
Requests cancellation of all subscriptions.
Client - Class in io.spine.client
The gRPC-based gateway for backend services such as CommandService, QueryService, or SubscriptionService.
client() - Method in class io.spine.client.ClientRequest
Obtains the client instance that will perform the request.
Client.Builder - Class in io.spine.client
The builder for the client.
ClientRequest - Class in io.spine.client
Entry point for creating client requests.
close() - Method in class io.spine.client.Client
Closes the client by shutting down the gRPC connection.
command() - Method in class io.spine.client.ActorRequestFactory
Creates an instance of CommandFactory based on configuration of this ActorRequestFactory instance.
command(CommandMessage) - Method in class io.spine.client.ClientRequest
Creates a builder for customizing command request.
CommandFactory - Class in io.spine.client
A factory of Command instances.
CommandRequest - Class in io.spine.client
Allows to post a command optionally subscribing to events that are immediate results of handling this command.
CompositeEntityStateFilter - Class in io.spine.client
A subscription filter which aggregates one or more EntityState filters.
CompositeEventFilter - Class in io.spine.client
A composite subscription filter which can aggregate both event message and event context filters.
CompositeObserver<T> - Class in io.spine.grpc
A stream observer which delegates calls to multiple other observers with the same target type.
CompositeObserver(Iterable<StreamObserver<? super T>>) - Constructor for class io.spine.grpc.CompositeObserver
 
CompositeQueryFilter - Class in io.spine.client
A composite query filter which targets one or more entity columns.
ConnectionConstants - Class in io.spine.client
Constant values shared between the client and the server code.
connectTo(String, int) - Static method in class io.spine.client.Client
Creates a builder for a client connected to the specified address.
ConsumerErrorHandler<M extends com.google.protobuf.Message> - Interface in io.spine.client
Functional interface for handlers of errors caused by consumers of messages.
create(CommandMessage) - Method in class io.spine.client.CommandFactory
Creates a new Command with the given message.
create(CommandMessage, int) - Method in class io.spine.client.CommandFactory
Creates a new Command with the passed message and target entity version.
createCommandContext() - Method in class io.spine.client.ActorRequestFactory
Creates new CommandContext.

D

DEFAULT_CLIENT_SERVICE_PORT - Static variable in class io.spine.client.ConnectionConstants
The default port number on which a client server runs.
DEFAULT_GUEST_ID - Static variable in class io.spine.client.Client
Default ID for a guest user.
DEFAULT_SHUTDOWN_TIMEOUT - Static variable in class io.spine.client.Client
The default amount of time to wait when closing the client.
DelegatingObserver<T> - Class in io.spine.grpc
A stream observer which delegates calls to another observer of the same target type.
DelegatingObserver(StreamObserver<? super T>) - Constructor for class io.spine.grpc.DelegatingObserver
 

E

either(EntityStateFilter, EntityStateFilter...) - Static method in class io.spine.client.CompositeEntityStateFilter
Creates a new disjunction composite filter.
either(EventFilter, EventFilter...) - Static method in class io.spine.client.CompositeEventFilter
Creates a new disjunction composite filter.
either(QueryFilter, QueryFilter...) - Static method in class io.spine.client.CompositeQueryFilter
Creates a new disjunction composite filter.
either(Filter, Filter...) - Static method in class io.spine.client.Filters
Creates a new disjunction composite filter.
EntityStateFilter - Class in io.spine.client
A subscription filter which targets an EntityState.
eq(EntityStateField, Object) - Static method in class io.spine.client.EntityStateFilter
Creates a new equality filter.
eq(EventMessageField, Object) - Static method in class io.spine.client.EventFilter
Creates a new equality filter which targets a field in the event message.
eq(EventContextField, Object) - Static method in class io.spine.client.EventFilter
Creates a new equality filter which targets a field in the event context.
eq(String, Object) - Static method in class io.spine.client.Filters
Creates a new equality Filter.
eq(EntityColumn, Object) - Static method in class io.spine.client.Filters
Creates a new equality Filter.
eq(EntityStateField, Object) - Static method in class io.spine.client.Filters
Creates a new equality Filter.
eq(EventMessageField, Object) - Static method in class io.spine.client.Filters
Creates a new equality Filter.
eq(EventContextField, Object) - Static method in class io.spine.client.Filters
Creates a new equality Filter.
eq(EntityColumn, Object) - Static method in class io.spine.client.QueryFilter
Creates a new equality filter.
ErrorHandler - Interface in io.spine.client
Functional interface for error handlers.
EventConsumer<E extends io.spine.base.EventMessage> - Interface in io.spine.client
Represents an operation which accepts an event message and its context.
EventFilter - Class in io.spine.client
A subscription filter which targets an Event.
EventObserver<E extends io.spine.base.EventMessage> - Interface in io.spine.client
Adapts gRPC streaming API to EventConsumer by passing the received Event to the BiConsumer.accept(Object, Object) method.
EventSubscriptionRequest<E extends io.spine.base.EventMessage> - Class in io.spine.client
Allows to subscribe to events using filtering conditions.

F

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>> - Class in io.spine.client
Abstract base for client requests that may filter messages by certain criteria.
Filters - Class in io.spine.client
A factory of Filter instances.
filters() - Method in interface io.spine.client.QueryMixin
Obtains target filters specified in the query.
forTenant(TenantId) - Method in class io.spine.client.Client.Builder
Assigns the tenant for the client connection to be built.
from(Consumer<E>) - Static method in interface io.spine.client.EventConsumer
Converts the passed consumer of the event message to EventConsumer.
from(Consumer<S>) - Static method in interface io.spine.client.StateConsumer
 
from(Topic) - Static method in class io.spine.client.Subscriptions
Creates a new subscription with the given Topic and a random ID.
fromContext(ActorContext) - Static method in class io.spine.client.ActorRequestFactory
Creates an instance by the passed ActorContext.
fromStreamError(Throwable) - Static method in class io.spine.grpc.StreamObservers
Extracts a system error from the Throwable received on a client-side as a result of a failed gRPC call to server-side routines.

G

ge(EntityStateField, Object) - Static method in class io.spine.client.EntityStateFilter
Creates a new "greater than or equals" filter.
ge(EventMessageField, Object) - Static method in class io.spine.client.EventFilter
Creates a new "greater than or equals" filter which targets a field in the event message.
ge(EventContextField, Object) - Static method in class io.spine.client.EventFilter
Creates a new "greater than or equals" filter which targets a field in the event context.
ge(String, Object) - Static method in class io.spine.client.Filters
Creates a new "greater or equal" Filter.
ge(EntityColumn, Object) - Static method in class io.spine.client.Filters
Creates a new "greater or equal" Filter.
ge(EntityStateField, Object) - Static method in class io.spine.client.Filters
Creates a new "greater or equal" Filter.
ge(EventMessageField, Object) - Static method in class io.spine.client.Filters
Creates a new "greater or equal" Filter.
ge(EventContextField, Object) - Static method in class io.spine.client.Filters
Creates a new "greater or equal" Filter.
ge(EntityColumn, Object) - Static method in class io.spine.client.QueryFilter
Creates a new "greater than or equals" filter.
generateId() - Static method in class io.spine.client.Subscriptions
Generates a new subscription identifier.
getActor() - Method in class io.spine.client.ActorRequestFactory.Builder
 
getTenantId() - Method in class io.spine.client.ActorRequestFactory.Builder
Obtains the ID of the tenant in a multi-tenant application to which the actor belongs.
getZoneId() - Method in class io.spine.client.ActorRequestFactory.Builder
Obtains the zone ID set in the builder.
getZoneOffset() - Method in class io.spine.client.ActorRequestFactory.Builder
Obtains the zone offset set in the builder.
gt(EntityStateField, Object) - Static method in class io.spine.client.EntityStateFilter
Creates a new "greater than" filter.
gt(EventMessageField, Object) - Static method in class io.spine.client.EventFilter
Creates a new "greater than" filter which targets a field in the event message.
gt(EventContextField, Object) - Static method in class io.spine.client.EventFilter
Creates a new "greater than" filter which targets a field in the event context.
gt(String, Object) - Static method in class io.spine.client.Filters
Creates a new "greater than" Filter.
gt(EntityColumn, Object) - Static method in class io.spine.client.Filters
Creates a new "greater than" Filter.
gt(EntityStateField, Object) - Static method in class io.spine.client.Filters
Creates a new "greater than" Filter.
gt(EventMessageField, Object) - Static method in class io.spine.client.Filters
Creates a new "greater than" Filter.
gt(EventContextField, Object) - Static method in class io.spine.client.Filters
Creates a new "greater than" Filter.
gt(EntityColumn, Object) - Static method in class io.spine.client.QueryFilter
Creates a new "greater than" filter.

I

inProcess(String) - Static method in class io.spine.client.Client
Creates a client which will be connected to the in-process server with the passed name.
io.spine.client - package io.spine.client
This package provides classes and interfaces for performing client requests like posting commands, running queries, or creating subscriptions.
io.spine.grpc - package io.spine.grpc
This package contains classes and interfaces related to gRPC.
isEmpty() - Method in class io.spine.client.Subscriptions
Verifies if there are any active subscriptions.
isOpen() - Method in class io.spine.client.Client
Verifies if the client connection is open.

L

le(EntityStateField, Object) - Static method in class io.spine.client.EntityStateFilter
Creates a new "less than or equals" filter.
le(EventMessageField, Object) - Static method in class io.spine.client.EventFilter
Creates a new "less than or equals" filter which targets a field in the event message.
le(EventContextField, Object) - Static method in class io.spine.client.EventFilter
Creates a new "less than or equals" filter which targets a field in the event context.
le(String, Object) - Static method in class io.spine.client.Filters
Creates a new "less or equal" Filter.
le(EntityColumn, Object) - Static method in class io.spine.client.Filters
Creates a new "less or equal" Filter.
le(EntityStateField, Object) - Static method in class io.spine.client.Filters
Creates a new "less or equal" Filter.
le(EventMessageField, Object) - Static method in class io.spine.client.Filters
Creates a new "less or equal" Filter.
le(EventContextField, Object) - Static method in class io.spine.client.Filters
Creates a new "less or equal" Filter.
le(EntityColumn, Object) - Static method in class io.spine.client.QueryFilter
Creates a new "less than or equals" filter.
limit(int) - Method in class io.spine.client.QueryBuilder
Limits the number of results returned by the query.
limit(int) - Method in class io.spine.client.QueryRequest
Limits the number of results returned by the query.
logError(FluentLogger, String, Class<? extends Message>) - Static method in interface io.spine.client.ConsumerErrorHandler
Obtains the handler which logs the fact of the error using the severe level of the passed logger.
logError(FluentLogger, String, Class<? extends Message>) - Static method in interface io.spine.client.ErrorHandler
Obtains the handler which logs the fact of the error using the severe level of the passed logger.
lt(EntityStateField, Object) - Static method in class io.spine.client.EntityStateFilter
Creates a new "less than" filter.
lt(EventMessageField, Object) - Static method in class io.spine.client.EventFilter
Creates a new "less than" filter which targets a field in the event message.
lt(EventContextField, Object) - Static method in class io.spine.client.EventFilter
Creates a new "less than" filter which targets a field in the event context.
lt(String, Object) - Static method in class io.spine.client.Filters
Creates a new "less than" Filter.
lt(EntityColumn, Object) - Static method in class io.spine.client.Filters
Creates a new "less than" Filter.
lt(EntityStateField, Object) - Static method in class io.spine.client.Filters
Creates a new "less than" Filter.
lt(EventMessageField, Object) - Static method in class io.spine.client.Filters
Creates a new "less than" Filter.
lt(EventContextField, Object) - Static method in class io.spine.client.Filters
Creates a new "less than" Filter.
lt(EntityColumn, Object) - Static method in class io.spine.client.QueryFilter
Creates a new "less than" filter.

N

newBuilder() - Static method in class io.spine.client.ActorRequestFactory
Creates a builder for a new request factory.
newId(String) - Static method in class io.spine.client.Subscriptions
Wraps a given String as a subscription identifier.
noOpObserver() - Static method in class io.spine.grpc.StreamObservers
Creates a observer which does nothing upon the invocation of its callback methods.

O

observe(Class<E>, Consumer<E>) - Method in class io.spine.client.CommandRequest
Adds the passed consumer to the subscribers of the event of the passed type.
observe(Class<E>, EventConsumer<E>) - Method in class io.spine.client.CommandRequest
Adds the passed event consumer to the subscribers of the event of the passed type.
observe(EventConsumer<E>) - Method in class io.spine.client.EventSubscriptionRequest
 
observe(Consumer<M>) - Method in class io.spine.client.SubscribingRequest
Subscribes the passed consumer to receive messages of the subscribed type.
ofEvent() - Method in interface io.spine.client.SubscriptionMixin
Tells if the subscription target is events.
onBehalfOf(UserId) - Method in class io.spine.client.Client
Creates a builder for requests on behalf of the passed user.
onCompleted() - Method in class io.spine.grpc.CompositeObserver
 
onCompleted() - Method in class io.spine.grpc.DelegatingObserver
 
onConsumingError(ConsumerErrorHandler<EventMessage>) - Method in class io.spine.client.CommandRequest
Assigns a handler for errors occurred in consumers of events.
onConsumingError(ConsumerErrorHandler<M>) - Method in class io.spine.client.SubscribingRequest
Assigns a handler for an error that may occur in the code of one of the consumers.
onError(Throwable) - Method in class io.spine.grpc.CompositeObserver
 
onError(Throwable) - Method in class io.spine.grpc.DelegatingObserver
 
onNext(Event) - Method in interface io.spine.client.EventObserver
 
onNext(T) - Method in class io.spine.grpc.CompositeObserver
 
onNext(T) - Method in class io.spine.grpc.DelegatingObserver
 
onServerError(ServerErrorHandler) - Method in class io.spine.client.Client.Builder
Assigns a default handler for an error occurred on the server-side (such as validation error) in response to a message posted by the client.
onServerError(ServerErrorHandler) - Method in class io.spine.client.ClientRequest
Assigns a handler for an error occurred on the server-side (such as validation error) in response to posting a request.
onServerError(ServerErrorHandler) - Method in class io.spine.client.CommandRequest
Assigns a handler for an error occurred on the server-side (such as validation error) in response to posting a command.
onStreamingError(ErrorHandler) - Method in class io.spine.client.Client.Builder
Assigns a default handler for streaming errors for the asynchronous requests initiated by the client.
onStreamingError(ErrorHandler) - Method in class io.spine.client.ClientRequest
Assigns a handler for errors occurred when delivering messages from the server.
onStreamingError(ErrorHandler) - Method in class io.spine.client.CommandRequest
Assigns a handler for errors occurred when delivering events.
onStreamingError(ErrorHandler) - Method in class io.spine.client.SubscribingRequest
Assigns a handler for the error reported to StreamObserver.onError(Throwable) of the StreamObserver responsible for delivering messages to the consumers.
orderBy(String, OrderBy.Direction) - Method in class io.spine.client.QueryBuilder
Sets the sorting order by the target column and order direction.
orderBy(String, OrderBy.Direction) - Method in class io.spine.client.QueryRequest
Deprecated.
Please use the alternative which relies on strongly-typed columns instead.
orderBy(EntityColumn, OrderBy.Direction) - Method in class io.spine.client.QueryRequest
Sets the sorting order by the target column and order direction.

P

post() - Method in class io.spine.client.CommandRequest
Subscribes the consumers to events to receive events resulting from the command as they happen, then sends the command to the server.
post() - Method in class io.spine.client.SubscribingRequest
Creates and posts the subscription request to the server.
postAndForget() - Method in class io.spine.client.CommandRequest
Posts the command without subscribing to events that may be generated during the command handling.

Q

query() - Method in class io.spine.client.ActorRequestFactory
Creates an instance of QueryFactory based on configuration of this ActorRequestFactory instance.
QueryBuilder - Class in io.spine.client
A builder for the Query instances.
QueryFactory - Class in io.spine.client
A factory of Query instances.
QueryFilter - Class in io.spine.client
A query filter which targets a column of an entity.
QueryMixin - Interface in io.spine.client
Useful methods for Query.
QueryRequest<S extends io.spine.base.EntityState> - Class in io.spine.client
Allows to create a post a query for messages of the given type.

R

responseFormat() - Method in interface io.spine.client.QueryMixin
Obtains the format for the response to the query.
run() - Method in class io.spine.client.QueryRequest
Obtains results of the query.

S

select(Class<S>) - Method in class io.spine.client.ClientRequest
Creates a builder for constructing a query for messages of the specified type.
select(Class<? extends EntityState>) - Method in class io.spine.client.QueryFactory
Creates a new instance of QueryBuilder for the further Query construction.
select(Class<? extends Message>) - Method in class io.spine.client.TopicFactory
Creates a new instance of TopicBuilder for further Topic construction.
ServerErrorHandler - Interface in io.spine.client
A handler for an error occurred when posting a message for asynchronous processing at the server side.
setActor(UserId) - Method in class io.spine.client.ActorRequestFactory.Builder
Sets the ID for the user generating commands.
setTenantId(TenantId) - Method in class io.spine.client.ActorRequestFactory.Builder
Sets the ID of a tenant in a multi-tenant application to which the actor belongs.
setZoneId(ZoneId) - Method in class io.spine.client.ActorRequestFactory.Builder
Sets the ID of the time zone in which the user works.
setZoneOffset(ZoneOffset) - Method in class io.spine.client.ActorRequestFactory.Builder
Sets the offset of the time zone in which the user works.
shutdown() - Method in class io.spine.client.Client
shutdownTimeout(long, TimeUnit) - Method in class io.spine.client.Client.Builder
Sets the timeout for the shutdown operation of the client.
shutdownTimout(long, TimeUnit) - Method in class io.spine.client.Client.Builder
StateConsumer<S extends io.spine.base.EntityState> - Interface in io.spine.client
Represents an operation that accepts a state of an entity.
StreamObservers - Class in io.spine.grpc
A utility class for the routines related to gRPC StreamObserver instances.
subscribeTo(Class<S>) - Method in class io.spine.client.ClientRequest
Creates a builder for customizing subscription for the passed entity state type.
subscribeToEvent(Class<E>) - Method in class io.spine.client.ClientRequest
Creates a builder for customizing subscription for the passed event type.
SubscribingRequest<M extends com.google.protobuf.Message,C extends io.spine.base.MessageContext,W extends com.google.protobuf.Message,B extends SubscribingRequest<M,C,W,B>> - Class in io.spine.client
Abstract base for client requests that subscribe to messages.
SubscriptionMixin - Interface in io.spine.client
Useful methods for Subscription.
SubscriptionRequest<S extends io.spine.base.EntityState> - Class in io.spine.client
Allows to subscribe to updates of entity states using filtering conditions.
subscriptions() - Method in class io.spine.client.Client
Obtains subscriptions created by this client.
Subscriptions - Class in io.spine.client
Maintains the list of the active subscriptions created by the Client.
switchTimeZone(ZoneOffset, ZoneId) - Method in class io.spine.client.ActorRequestFactory
Creates a copy of this factory placed at a new time zone with the passed offset and ID.
switchTimeZone(ZoneId) - Method in class io.spine.client.ActorRequestFactory
Creates a copy of this factory placed at a new time zone with the passed ID.

T

TargetBuilder<T extends com.google.protobuf.Message,B extends TargetBuilder<T,B>> - Class in io.spine.client
An abstract base for builders that create Message instances which have a Target and a FieldMask as attributes.
targetType() - Method in interface io.spine.client.QueryMixin
Obtains the URL of the query target type.
targetType() - Method in interface io.spine.client.SubscriptionMixin
Obtains the URL of the target type.
tenant() - Method in class io.spine.client.Client
Obtains the tenant of this client connection in a multitenant application, and empty Optional in a single-tenant one.
tenantId() - Method in class io.spine.client.ActorRequestFactory
Obtains the ID of the tenant to which the actor belongs or null for single-tenant execution context.
test(Event) - Method in class io.spine.client.EventFilter
 
topic() - Method in class io.spine.client.ActorRequestFactory
Creates an instance of TopicFactory based on configuration of this ActorRequestFactory instance.
TopicBuilder - Class in io.spine.client
A builder for the Topic instances.
TopicFactory - Class in io.spine.client
A factory of Topic instances.
toShortString() - Method in interface io.spine.client.SubscriptionMixin
Obtains a short printable form of subscription.
toShortString(Subscription) - Static method in class io.spine.client.Subscriptions
Deprecated.
toString() - Method in class io.spine.client.TargetBuilder
 

U

user() - Method in class io.spine.client.ClientRequest
Obtains the ID of the user of the request.
usingChannel(ManagedChannel) - Static method in class io.spine.client.Client
Creates a builder for a client which will use the passed channel for the communication with the backend services.

V

value() - Method in class io.spine.client.CompositeQueryFilter
 

W

where(EventFilter...) - Method in class io.spine.client.EventSubscriptionRequest
Configures the request to return results matching all the passed filters.
where(CompositeEventFilter...) - Method in class io.spine.client.EventSubscriptionRequest
Configures the request to return results matching all the passed filters.
where(Filter...) - Method in class io.spine.client.FilteringRequest
Deprecated.
Please use the overloads from the descendants that rely on strongly-typed filters.
where(CompositeFilter...) - Method in class io.spine.client.FilteringRequest
Deprecated.
Please use the overloads from the descendants that rely on strongly-typed filters.
where(QueryFilter...) - Method in class io.spine.client.QueryRequest
Configures the request to return results matching all the passed filters.
where(CompositeQueryFilter...) - Method in class io.spine.client.QueryRequest
Configures the request to return results matching all the passed filters.
where(EntityStateFilter...) - Method in class io.spine.client.SubscriptionRequest
Configures the request to return results matching all the passed filters.
where(CompositeEntityStateFilter...) - Method in class io.spine.client.SubscriptionRequest
Configures the request to return results matching all the passed filters.
where(Filter...) - Method in class io.spine.client.TargetBuilder
Sets the predicates for the Query.
where(CompositeFilter...) - Method in class io.spine.client.TargetBuilder
Sets the predicates for the Query.
withGuestId(UserId) - Method in class io.spine.client.Client.Builder
Assigns the ID of the user for performing requests on behalf of non-logged in user.
withGuestId(String) - Method in class io.spine.client.Client.Builder
Assigns the ID of the user for performing requests on behalf of non-logged in user.
withMask(Iterable<String>) - Method in class io.spine.client.FilteringRequest
Instructs to populate only fields with the passed names in the results of the request.
withMask(String...) - Method in class io.spine.client.FilteringRequest
Instructs to populate only fields with the passed names in the results of the request.
withMask(Iterable<String>) - Method in class io.spine.client.TargetBuilder
Sets the entity fields to retrieve.
withMask(String...) - Method in class io.spine.client.TargetBuilder
Sets the entity fields to retrieve.

Z

zoneId() - Method in class io.spine.client.ActorRequestFactory
Obtains the ID of the time zone in which the actor works.
zoneOffset() - Method in class io.spine.client.ActorRequestFactory
Obtains the offset of the time zone in which the actor works.
A B C D E F G I L N O P Q R S T U V W Z 
Skip navigation links