Class FallbackRouteProperties
- java.lang.Object
-
- com.azure.resourcemanager.iothub.models.FallbackRouteProperties
-
public final class FallbackRouteProperties extends Object
The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
-
-
Constructor Summary
Constructors Constructor Description FallbackRouteProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
condition()
Get the condition property: The condition which is evaluated in order to apply the fallback route.List<String>
endpointNames()
Get the endpointNames property: The list of endpoints to which the messages that satisfy the condition are routed to.boolean
isEnabled()
Get the isEnabled property: Used to specify whether the fallback route is enabled.String
name()
Get the name property: The name of the route.RoutingSource
source()
Get the source property: The source to which the routing rule is to be applied to.void
validate()
Validates the instance.FallbackRouteProperties
withCondition(String condition)
Set the condition property: The condition which is evaluated in order to apply the fallback route.FallbackRouteProperties
withEndpointNames(List<String> endpointNames)
Set the endpointNames property: The list of endpoints to which the messages that satisfy the condition are routed to.FallbackRouteProperties
withIsEnabled(boolean isEnabled)
Set the isEnabled property: Used to specify whether the fallback route is enabled.FallbackRouteProperties
withName(String name)
Set the name property: The name of the route.FallbackRouteProperties
withSource(RoutingSource source)
Set the source property: The source to which the routing rule is to be applied to.
-
-
-
Method Detail
-
name
public String name()
Get the name property: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.- Returns:
- the name value.
-
withName
public FallbackRouteProperties withName(String name)
Set the name property: The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.- Parameters:
name
- the name value to set.- Returns:
- the FallbackRouteProperties object itself.
-
source
public RoutingSource source()
Get the source property: The source to which the routing rule is to be applied to. For example, DeviceMessages.- Returns:
- the source value.
-
withSource
public FallbackRouteProperties withSource(RoutingSource source)
Set the source property: The source to which the routing rule is to be applied to. For example, DeviceMessages.- Parameters:
source
- the source value to set.- Returns:
- the FallbackRouteProperties object itself.
-
condition
public String condition()
Get the condition property: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.- Returns:
- the condition value.
-
withCondition
public FallbackRouteProperties withCondition(String condition)
Set the condition property: The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.- Parameters:
condition
- the condition value to set.- Returns:
- the FallbackRouteProperties object itself.
-
endpointNames
public List<String> endpointNames()
Get the endpointNames property: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.- Returns:
- the endpointNames value.
-
withEndpointNames
public FallbackRouteProperties withEndpointNames(List<String> endpointNames)
Set the endpointNames property: The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.- Parameters:
endpointNames
- the endpointNames value to set.- Returns:
- the FallbackRouteProperties object itself.
-
isEnabled
public boolean isEnabled()
Get the isEnabled property: Used to specify whether the fallback route is enabled.- Returns:
- the isEnabled value.
-
withIsEnabled
public FallbackRouteProperties withIsEnabled(boolean isEnabled)
Set the isEnabled property: Used to specify whether the fallback route is enabled.- Parameters:
isEnabled
- the isEnabled value to set.- Returns:
- the FallbackRouteProperties object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-