Package software.amazon.awssdk.services.iotsitewise.model

Class AssetModelProperty

    • Method Detail

      • id

        public final String id()

        The ID of the asset model property.

        • If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

        • If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

        Returns:
        The ID of the asset model property.

        • If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

        • If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

      • name

        public final String name()

        The name of the asset model property.

        Returns:
        The name of the asset model property.

      • dataTypeSpec

        public final String dataTypeSpec()

        The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

        Returns:
        The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

      • unit

        public final String unit()

        The unit of the asset model property, such as Newtons or RPM.

        Returns:
        The unit of the asset model property, such as Newtons or RPM.

      • type

        public final PropertyType type()

        The property type (see PropertyType).

        Returns:
        The property type (see PropertyType).

      • hasPath

        public final boolean hasPath()
        For responses, this returns true if the service returned a value for the Path property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • path

        public final List<AssetModelPropertyPathSegment> path()

        The structured path to the property from the root of the asset model.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPath() method.

        Returns:
        The structured path to the property from the root of the asset model.

      • externalId

        public final String externalId()

        The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.

        Returns:
        The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)