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

Class RetrieveThings.Builder

  • Enclosing class:
    RetrieveThings
    @NotThreadSafe
public static final class RetrieveThings.Builder
extends java.lang.Object
    Builder to facilitate creation of RetrieveThings instances. Multiple calls to one of this class' methods will overwrite before set values.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      RetrieveThings build()
      Builds an instance of RetrieveThings based on the provided values.
      RetrieveThings.Builder dittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Sets the optional command headers.
      RetrieveThings.Builder namespace​(java.lang.String namespace)
      Sets namespace for this command.
      RetrieveThings.Builder selectedFields​(java.util.Optional<org.eclipse.ditto.json.JsonFieldSelector> selectedFields)
      Sets the JSON fields which should be shown in the JSON document which is returned due to a HTTP request.
      RetrieveThings.Builder selectedFields​(org.eclipse.ditto.json.JsonFieldSelector selectedFields)
      Sets the JSON fields which should be shown in the JSON document which is returned due to a HTTP request.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • dittoHeaders

        public RetrieveThings.Builder dittoHeaders​(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
        Sets the optional command headers.
        Parameters:
        dittoHeaders - the command headers.
        Returns:
        this builder to allow method chaining.

      • selectedFields

        public RetrieveThings.Builder selectedFields​(@Nullable
                                             org.eclipse.ditto.json.JsonFieldSelector selectedFields)
        Sets the JSON fields which should be shown in the JSON document which is returned due to a HTTP request.
        Parameters:
        selectedFields - the selected JSON fields to be shown in the resulting JSON document.
        Returns:
        this builder to allow method chaining.

      • selectedFields

        public RetrieveThings.Builder selectedFields​(java.util.Optional<org.eclipse.ditto.json.JsonFieldSelector> selectedFields)
        Sets the JSON fields which should be shown in the JSON document which is returned due to a HTTP request.
        Parameters:
        selectedFields - the selected JSON fields to be shown in the resulting JSON document.
        Returns:
        this builder to allow method chaining.

      • namespace

        public RetrieveThings.Builder namespace​(@Nullable
                                        java.lang.String namespace)
        Sets namespace for this command.
        Parameters:
        namespace - the namespace used for this command
        Returns:
        this builder to allow method chaining.

      • build

        public RetrieveThings build()
        Builds an instance of RetrieveThings based on the provided values.
        Returns:
        a new instance of RetrieveThings.