Package org.eclipse.ditto.things.model.signals.commands.query

Class RetrieveThing

java.lang.Object
org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveThing>
org.eclipse.ditto.things.model.signals.commands.query.RetrieveThing
All Implemented Interfaces:
org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.entity.type.WithEntityType, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveThing>, org.eclipse.ditto.base.model.headers.WithDittoHeaders, org.eclipse.ditto.base.model.headers.WithManifest, 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>, org.eclipse.ditto.base.model.signals.commands.Command<RetrieveThing>, org.eclipse.ditto.base.model.signals.commands.WithSelectedFields, org.eclipse.ditto.base.model.signals.Signal<RetrieveThing>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<RetrieveThing>, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, org.eclipse.ditto.base.model.signals.WithType, ThingQueryCommand<RetrieveThing>, ThingCommand<RetrieveThing>, WithThingId
@Immutable public final class RetrieveThing extends org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveThing> implements ThingQueryCommand<RetrieveThing>
Command which retrieves one Thing based on the passed in Thing ID.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RetrieveThing.Builder
    A mutable builder with a fluent API for an immutable RetrieveThing.

    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 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 Object>

    Nested classes/interfaces inherited from interface org.eclipse.ditto.things.model.signals.commands.ThingCommand

    ThingCommand.JsonFields

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    Name of the "Retrieve Thing" command.
    static final String
    TYPE
    Type of this command.

    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.things.model.signals.commands.ThingCommand

    RESOURCE_TYPE, TYPE_PREFIX

    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

    Modifier and Type
    Method
    Description
    protected void
    appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
     
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object obj)
     
    static RetrieveThing
    fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new RetrieveThing from a JSON string.
    static RetrieveThing
    fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Creates a new RetrieveThing from a JSON object.
    static RetrieveThing.Builder
    getBuilder(ThingId thingId, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Returns a builder with a fluent API for an immutable RetrieveThing instance.
    ThingId
    getEntityId()
     
    org.eclipse.ditto.json.JsonPointer
    getResourcePath()
     
    Optional<org.eclipse.ditto.json.JsonFieldSelector>
    getSelectedFields()
     
    Optional<Long>
    getSnapshotRevision()
    Returns the requested revision of the Thing's persistence snapshot.
    int
    hashCode()
     
    static RetrieveThing
    of(ThingId thingId, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
    Returns a Command for retrieving the Thing with the given ID.
    RetrieveThing
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     
    String
    toString()
     

    Methods inherited from class org.eclipse.ditto.base.model.signals.commands.AbstractCommand

    getDittoHeaders, getManifest, getType, toJson

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

    getImplementedSchemaVersion, 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.base.model.signals.Signal

    getName

    Methods inherited from interface org.eclipse.ditto.things.model.signals.commands.ThingCommand

    getEntityType, getResourceType, getTypePrefix

    Methods inherited from interface org.eclipse.ditto.things.model.signals.commands.query.ThingQueryCommand

    getCategory

    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.WithType

    getType

  • Field Details

  • Method Details

    • of

      public static RetrieveThing of(ThingId thingId, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a Command for retrieving the Thing with the given ID.
      Parameters:
      thingId - the ID of a single Thing to be retrieved by this command.
      dittoHeaders - the headers of the command.
      Returns:
      a Command for retrieving the Thing with the thingId as its ID which is readable from the passed authorization context.
      Throws:
      NullPointerException - if dittoHeaders is null.

    • getBuilder

      public static RetrieveThing.Builder getBuilder(ThingId thingId, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Returns a builder with a fluent API for an immutable RetrieveThing instance.
      Parameters:
      thingId - the ID of a single Thing to be retrieved by this command.
      dittoHeaders - the headers of the command.
      Returns:
      the builder.
      Throws:
      NullPointerException - if dittoHeaders is null.

    • fromJson

      public static RetrieveThing fromJson(String jsonString, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new RetrieveThing from a JSON string.
      Parameters:
      jsonString - the JSON string of which the command is to be created.
      dittoHeaders - the headers of the command.
      Returns:
      the command.
      Throws:
      NullPointerException - if jsonString is null.
      IllegalArgumentException - if jsonString is empty.
      org.eclipse.ditto.json.JsonParseException - if the passed in jsonString was not in the expected format.

    • fromJson

      public static RetrieveThing fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Creates a new RetrieveThing from a JSON object.
      Parameters:
      jsonObject - the JSON object of which the command is to be created.
      dittoHeaders - the headers of the command.
      Returns:
      the command.
      Throws:
      NullPointerException - if jsonObject is null.
      org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.

    • getSelectedFields

      public Optional<org.eclipse.ditto.json.JsonFieldSelector> getSelectedFields()
      Specified by:
      getSelectedFields in interface org.eclipse.ditto.base.model.signals.commands.WithSelectedFields

    • getEntityId

      public ThingId getEntityId()
      Specified by:
      getEntityId in interface org.eclipse.ditto.base.model.entity.id.WithEntityId
      Specified by:
      getEntityId in interface WithThingId

    • getResourcePath

      public org.eclipse.ditto.json.JsonPointer getResourcePath()
      Specified by:
      getResourcePath in interface org.eclipse.ditto.base.model.signals.WithResource

    • appendPayload

      protected void appendPayload(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.base.model.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)
      Specified by:
      appendPayload in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveThing>

    • setDittoHeaders

      public RetrieveThing setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.signals.commands.Command<RetrieveThing>
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<RetrieveThing>
      Specified by:
      setDittoHeaders in interface ThingCommand<RetrieveThing>
      Specified by:
      setDittoHeaders in interface ThingQueryCommand<RetrieveThing>

    • getSnapshotRevision

      @Nonnull public Optional<Long> getSnapshotRevision()
      Returns the requested revision of the Thing's persistence snapshot.
      Returns:
      the revision or an empty Optional.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveThing>

    • equals

      public boolean equals(@Nullable Object obj)
      Overrides:
      equals in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveThing>

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveThing>

    • toString

      public String toString()
      Overrides:
      toString in class org.eclipse.ditto.base.model.signals.commands.AbstractCommand<RetrieveThing>