io.spine.client

Interface QueryMixin

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, io.spine.client.QueryOrBuilder

@GeneratedMixin
public interface QueryMixin
extends io.spine.client.QueryOrBuilder

Useful methods for Query.

Method Summary

Modifier and Type	Method and Description
default boolean	all() Tells if this query requests all instances of the target type.
default io.spine.client.TargetFilters	filters() Obtains target filters specified in the query.
default io.spine.client.ResponseFormat	responseFormat() Obtains the format for the response to the query.
default io.spine.type.TypeUrl	targetType() Obtains the URL of the query target type.

Methods inherited from interface io.spine.client.QueryOrBuilder

getContext, getContextOrBuilder, getFormat, getFormatOrBuilder, getId, getIdOrBuilder, getTarget, getTargetOrBuilder, hasContext, hasFormat, hasId, hasTarget

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

targetType

default io.spine.type.TypeUrl targetType()

Obtains the URL of the query target type.

Throws:

java.lang.IllegalStateException - if the Target type is unknown to the application.

filters

default io.spine.client.TargetFilters filters()

Obtains target filters specified in the query.

responseFormat

default io.spine.client.ResponseFormat responseFormat()

Obtains the format for the response to the query.

all

default boolean all()

Tells if this query requests all instances of the target type.