Package com.oracle.bmc.iot.model

Class DigitalTwinModel

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20250531")
public final class DigitalTwinModel
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A digital twin model, defined using Digital Twins Definition Language, specifies the schema for digital twin instance, including its components, properties, telemetry, commands, and relationships within the IoT domain.

    To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
    Note: Objects should always be created or deserialized using the DigitalTwinModel.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the DigitalTwinModel.Builder, which maintain a set of all explicitly set fields called DigitalTwinModel.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the resource.
        Returns:
        the value

      • getIotDomainId

        public String getIotDomainId()
        The OCID of the IoT domain.
        Returns:
        the value

      • getSpecUri

        public String getSpecUri()
        This is the DTMI (Digital Twin Model Identifier) of the digital twin model as defined in DTDL specification.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information. If left blank, the display name will be derived from the spec.

        Returns:
        the value

      • getDescription

        public String getDescription()
        A short description of the resource.

        If left blank, the description will be derived from the spec.

        Returns:
        the value

      • getLifecycleState

        public LifecycleState getLifecycleState()
        The current state of the digital twin model.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time when the resource was created, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time when the resource was last updated, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel