Package com.azure.resourcemanager.iothub.models

Class RoutingProperties

  • public final class RoutingProperties
extends Object
    The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging.

    • Constructor Detail

      • RoutingProperties

        public RoutingProperties()

    • Method Detail

      • endpoints

        public RoutingEndpoints endpoints()
        Get the endpoints property: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.
        Returns:
        the endpoints value.

      • withEndpoints

        public RoutingProperties withEndpoints​(RoutingEndpoints endpoints)
        Set the endpoints property: The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.
        Parameters:
        endpoints - the endpoints value to set.
        Returns:
        the RoutingProperties object itself.

      • routes

        public List<RouteProperties> routes()
        Get the routes property: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
        Returns:
        the routes value.

      • withRoutes

        public RoutingProperties withRoutes​(List<RouteProperties> routes)
        Set the routes property: The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
        Parameters:
        routes - the routes value to set.
        Returns:
        the RoutingProperties object itself.

      • fallbackRoute

        public FallbackRouteProperties fallbackRoute()
        Get the fallbackRoute property: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
        Returns:
        the fallbackRoute value.

      • withFallbackRoute

        public RoutingProperties withFallbackRoute​(FallbackRouteProperties fallbackRoute)
        Set the fallbackRoute property: The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
        Parameters:
        fallbackRoute - the fallbackRoute value to set.
        Returns:
        the RoutingProperties object itself.

      • enrichments

        public List<EnrichmentProperties> enrichments()
        Get the enrichments property: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid.
        Returns:
        the enrichments value.

      • withEnrichments

        public RoutingProperties withEnrichments​(List<EnrichmentProperties> enrichments)
        Set the enrichments property: The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid.
        Parameters:
        enrichments - the enrichments value to set.
        Returns:
        the RoutingProperties object itself.

      • validate

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