Package org.eclipse.ditto.signals.commands.things.modify

Class ModifyFeatureDesiredPropertiesResponse

    • Nested Class Summary

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

        org.eclipse.ditto.signals.commands.base.CommandResponse.JsonFields

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

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String TYPE
      Type of this response.

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

        TYPE_QUALIFIER

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void appendPayload​(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> thePredicate)  
      protected boolean canEqual​(Object other)  
      static ModifyFeatureDesiredPropertiesResponse created​(org.eclipse.ditto.model.things.ThingId thingId, CharSequence featureId, org.eclipse.ditto.model.things.FeatureProperties desiredProperties, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Returns a new ModifyFeatureDesiredPropertiesResponse for created desired properties of a Feature.
      boolean equals​(Object o)  
      static ModifyFeatureDesiredPropertiesResponse fromJson​(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Creates a response to a ModifyFeatureDesiredProperties command from a JSON string.
      static ModifyFeatureDesiredPropertiesResponse fromJson​(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Creates a response to a ModifyFeatureDesiredProperties command from a JSON object.
      Optional<org.eclipse.ditto.model.things.FeatureProperties> getDesiredPropertiesCreated()
      Returns the created desired properties.
      Optional<org.eclipse.ditto.json.JsonValue> getEntity​(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)  
      String getFeatureId()
      Returns the ID of the Feature whose desired properties were modified.
      org.eclipse.ditto.json.JsonPointer getResourcePath()  
      org.eclipse.ditto.model.base.json.JsonSchemaVersion[] getSupportedSchemaVersions()
      ModifyFeatureDesiredPropertiesResponse is only available in JsonSchemaVersion V_2.
      org.eclipse.ditto.model.things.ThingId getThingEntityId()  
      int hashCode()  
      static ModifyFeatureDesiredPropertiesResponse modified​(org.eclipse.ditto.model.things.ThingId thingId, CharSequence featureId, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
      Returns a new ModifyFeatureDesiredPropertiesResponse for modified desired properties of a Feature.
      ModifyFeatureDesiredPropertiesResponse setDittoHeaders​(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)  
      String toString()  

      • Methods inherited from class org.eclipse.ditto.signals.commands.base.AbstractCommandResponse

        getDittoHeaders, getManifest, getStatusCode, getType, toJson

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

        getImplementedSchemaVersion, getResponseType, getStatusCode, getStatusCodeValue, isOfExpectedResponseType, toJson, toJson

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

        getLatestSchemaVersion, implementsSchemaVersion, implementsSchemaVersion, toJsonString

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

        toJson, toJsonString, toJsonString

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

        getName

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

        getDittoHeaders

      • Methods inherited from interface org.eclipse.ditto.signals.base.WithId

        getId

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

        getManifest

      • Methods inherited from interface org.eclipse.ditto.signals.base.WithOptionalEntity

        getEntity

      • Methods inherited from interface org.eclipse.ditto.model.things.WithThingId

        getThingId

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

        getType

    • Method Detail

      • created

        public static ModifyFeatureDesiredPropertiesResponse created​(org.eclipse.ditto.model.things.ThingId thingId,
                                                             CharSequence featureId,
                                                             org.eclipse.ditto.model.things.FeatureProperties desiredProperties,
                                                             org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Returns a new ModifyFeatureDesiredPropertiesResponse for created desired properties of a Feature. This corresponds to the HTTP status code HttpStatusCode.CREATED.
        Parameters:
        thingId - the Thing ID of the created desired properties.
        featureId - the Feature's ID whose desired properties were created.
        desiredProperties - the created desired properties.
        dittoHeaders - the headers of the ThingCommand which caused the new response.
        Returns:
        a command response for created desired properties.
        Throws:
        NullPointerException - if any argument is null.

      • modified

        public static ModifyFeatureDesiredPropertiesResponse modified​(org.eclipse.ditto.model.things.ThingId thingId,
                                                              CharSequence featureId,
                                                              org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Returns a new ModifyFeatureDesiredPropertiesResponse for modified desired properties of a Feature. This corresponds to the HTTP status code HttpStatusCode.NO_CONTENT.
        Parameters:
        thingId - the Thing ID of the modified desired properties.
        featureId - the Feature's ID whose desired properties were modified.
        dittoHeaders - the headers of the ThingCommand which caused the new response.
        Returns:
        a command response for modified desired properties.
        Throws:
        NullPointerException - if dittoHeaders is null.

      • fromJson

        public static ModifyFeatureDesiredPropertiesResponse fromJson​(String jsonString,
                                                              org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Creates a response to a ModifyFeatureDesiredProperties command from a JSON string.
        Parameters:
        jsonString - the JSON string of which the response is to be created.
        dittoHeaders - the headers of the preceding command.
        Returns:
        the response.
        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 ModifyFeatureDesiredPropertiesResponse fromJson​(org.eclipse.ditto.json.JsonObject jsonObject,
                                                              org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
        Creates a response to a ModifyFeatureDesiredProperties command from a JSON object.
        Parameters:
        jsonObject - the JSON object of which the response is to be created.
        dittoHeaders - the headers of the preceding command.
        Returns:
        the response.
        Throws:
        NullPointerException - if jsonObject is null.
        org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected format.

      • getThingEntityId

        public org.eclipse.ditto.model.things.ThingId getThingEntityId()
        Specified by:
        getThingEntityId in interface org.eclipse.ditto.model.things.WithThingId

      • getFeatureId

        public String getFeatureId()
        Returns the ID of the Feature whose desired properties were modified.
        Returns:
        the ID.

      • getDesiredPropertiesCreated

        public Optional<org.eclipse.ditto.model.things.FeatureProperties> getDesiredPropertiesCreated()
        Returns the created desired properties.
        Returns:
        the created desired properties.

      • getEntity

        public Optional<org.eclipse.ditto.json.JsonValue> getEntity​(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
        Specified by:
        getEntity in interface org.eclipse.ditto.signals.base.WithOptionalEntity

      • getSupportedSchemaVersions

        public org.eclipse.ditto.model.base.json.JsonSchemaVersion[] getSupportedSchemaVersions()
        ModifyFeatureDesiredPropertiesResponse is only available in JsonSchemaVersion V_2.
        Specified by:
        getSupportedSchemaVersions in interface org.eclipse.ditto.model.base.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>
        Returns:
        the supported JsonSchemaVersions.

      • getResourcePath

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

      • appendPayload

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