com.microsoft.azure.sdk.iot.service.digitaltwin.serialization.DigitalTwinMetadata Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of iot-service-client Show documentation

The Microsoft Azure IoT Service SDK for Java

The newest version!

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

package com.microsoft.azure.sdk.iot.service.digitaltwin.serialization;

import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.HashMap;
import java.util.Map;

@SuppressWarnings("unused") // A number of private members are unused but may be filled in or used by serialization
public final class DigitalTwinMetadata {
    /* The Id of the model that the digital twin or component is modeled by. This is present on a digital twin's root level metadata */
    @JsonProperty(value = "$model", required = true)
    private String modelId;

    /* Model-defined writable properties' request state. */
    @JsonIgnore
    private final Map writeableProperties = new HashMap<>();

    /**
     * Creates an instance of digital twin metadata.
     */
    public DigitalTwinMetadata() {
    }

    /**
     * Gets the Id of the model that the digital twin or component is modeled by.
     * @return The Id of the model that the digital twin or component is modeled by.
     */
    public String getModelId() {
        return modelId;
    }

    /**
     * Sets the Id of the model that the digital twin or component is modeled by.
     * @param modelId The Id of the model that the digital twin or component is modeled by.
     * @return The DigitalTwinMetadata object itself.
     */
    public DigitalTwinMetadata setModelId(String modelId) {
        this.modelId = modelId;
        return this;
    }

    /**
     * Gets the model-defined writable properties' request state.
     * For your convenience, the value of each map can be turned into an instance of WritableProperty.
     * @return The model-defined writable properties' request state.
     */
    @JsonAnyGetter
    public Map getWriteableProperties() {
        return writeableProperties;
    }

    /**
     * Adds the model-defined writable properties' request state.
     * @return The DigitalTwinMetadata object itself.
     */
    @JsonAnySetter
    DigitalTwinMetadata addWritableProperties(String key, WritableProperty value) {
        this.writeableProperties.put(key, value);
        return this;
    }
}