Package org.eclipse.ditto.client.live.commands.query

Interface RetrieveThingsLiveCommand

  • All Superinterfaces:
    org.eclipse.ditto.base.model.signals.commands.Command<RetrieveThingsLiveCommand>, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveThingsLiveCommand>, org.eclipse.ditto.base.model.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,​org.eclipse.ditto.json.JsonField>, LiveCommand<RetrieveThingsLiveCommand,​RetrieveThingsLiveCommandAnswerBuilder>, org.eclipse.ditto.base.model.signals.Signal<RetrieveThingsLiveCommand>, org.eclipse.ditto.base.model.headers.WithDittoHeaders, org.eclipse.ditto.base.model.headers.WithManifest, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.commands.WithNamespace, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.commands.WithSelectedFields, org.eclipse.ditto.base.model.signals.WithType
    public interface RetrieveThingsLiveCommand
extends LiveCommand<RetrieveThingsLiveCommand,​RetrieveThingsLiveCommandAnswerBuilder>, org.eclipse.ditto.base.model.signals.commands.WithNamespace, org.eclipse.ditto.base.model.signals.commands.WithSelectedFields
    RetrieveThings live command giving access to the command and all of its special accessors. Also the entry point for creating a RetrieveThingsLiveCommandAnswerBuilder capable of answering incoming commands.
    Since:
    2.0.0

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.eclipse.ditto.base.model.signals.commands.Command

        org.eclipse.ditto.base.model.signals.commands.Command.Category, org.eclipse.ditto.base.model.signals.commands.Command.JsonFields

      • Nested classes/interfaces inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

        org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelector, org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelectorAndPredicate<T extends java.lang.Object>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPointer<J extends org.eclipse.ditto.json.JsonValue>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate<J extends org.eclipse.ditto.json.JsonValue,​T extends java.lang.Object>

    • Field Summary

      • Fields inherited from interface org.eclipse.ditto.base.model.signals.commands.Command

        TYPE_QUALIFIER

      • Fields inherited from interface org.eclipse.ditto.base.model.signals.Signal

        CHANNEL_LIVE, CHANNEL_TWIN

      • Fields inherited from interface org.eclipse.ditto.base.model.signals.WithType

        MESSAGES_COMMAND_RESPONSES_PREFIX, MESSAGES_COMMANDS_PREFIX, POLICY_ANNOUNCEMENT_PREFIX, THINGS_COMMAND_RESPONSES_PREFIX, THINGS_COMMANDS_PREFIX, THINGS_EVENTS_PREFIX

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<org.eclipse.ditto.things.model.ThingId> getEntityIds()
      Returns the identifiers of the Things to be retrieved.

      • Methods inherited from interface org.eclipse.ditto.base.model.signals.commands.Command

        getCategory, getImplementedSchemaVersion, getTypePrefix, setDittoHeaders, toJson, toJson

      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

        getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJsonString

      • Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate

        toJson, toJsonString, toJsonString

      • Methods inherited from interface org.eclipse.ditto.client.live.commands.base.LiveCommand

        answer

      • Methods inherited from interface org.eclipse.ditto.base.model.signals.Signal

        getName

      • Methods inherited from interface org.eclipse.ditto.base.model.headers.WithDittoHeaders

        getDittoHeaders

      • Methods inherited from interface org.eclipse.ditto.base.model.headers.WithManifest

        getManifest

      • Methods inherited from interface org.eclipse.ditto.base.model.signals.commands.WithNamespace

        getNamespace

      • Methods inherited from interface org.eclipse.ditto.base.model.signals.WithResource

        getResourcePath, getResourceType

      • Methods inherited from interface org.eclipse.ditto.base.model.signals.commands.WithSelectedFields

        getSelectedFields

      • Methods inherited from interface org.eclipse.ditto.base.model.signals.WithType

        getType

    • Method Detail

      • getEntityIds

        @Nonnull
java.util.List<org.eclipse.ditto.things.model.ThingId> getEntityIds()
        Returns the identifiers of the Things to be retrieved.
        Returns:
        the identifiers