Class EnrichmentProperties


  • public final class EnrichmentProperties
    extends Object
    The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.
    • Constructor Detail

      • EnrichmentProperties

        public EnrichmentProperties()
    • Method Detail

      • key

        public String key()
        Get the key property: The key or name for the enrichment property.
        Returns:
        the key value.
      • withKey

        public EnrichmentProperties withKey​(String key)
        Set the key property: The key or name for the enrichment property.
        Parameters:
        key - the key value to set.
        Returns:
        the EnrichmentProperties object itself.
      • value

        public String value()
        Get the value property: The value for the enrichment property.
        Returns:
        the value value.
      • withValue

        public EnrichmentProperties withValue​(String value)
        Set the value property: The value for the enrichment property.
        Parameters:
        value - the value value to set.
        Returns:
        the EnrichmentProperties object itself.
      • endpointNames

        public List<String> endpointNames()
        Get the endpointNames property: The list of endpoints for which the enrichment is applied to the message.
        Returns:
        the endpointNames value.
      • withEndpointNames

        public EnrichmentProperties withEndpointNames​(List<String> endpointNames)
        Set the endpointNames property: The list of endpoints for which the enrichment is applied to the message.
        Parameters:
        endpointNames - the endpointNames value to set.
        Returns:
        the EnrichmentProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.