Class MessagingEndpointProperties
- java.lang.Object
-
- com.azure.resourcemanager.iothub.models.MessagingEndpointProperties
-
public final class MessagingEndpointProperties extends Object
The properties of the messaging endpoints used by this IoT hub.
-
-
Constructor Summary
Constructors Constructor Description MessagingEndpointProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Duration
lockDurationAsIso8601()
Get the lockDurationAsIso8601 property: The lock duration.Integer
maxDeliveryCount()
Get the maxDeliveryCount property: The number of times the IoT hub attempts to deliver a message.Duration
ttlAsIso8601()
Get the ttlAsIso8601 property: The period of time for which a message is available to consume before it is expired by the IoT hub.void
validate()
Validates the instance.MessagingEndpointProperties
withLockDurationAsIso8601(Duration lockDurationAsIso8601)
Set the lockDurationAsIso8601 property: The lock duration.MessagingEndpointProperties
withMaxDeliveryCount(Integer maxDeliveryCount)
Set the maxDeliveryCount property: The number of times the IoT hub attempts to deliver a message.MessagingEndpointProperties
withTtlAsIso8601(Duration ttlAsIso8601)
Set the ttlAsIso8601 property: The period of time for which a message is available to consume before it is expired by the IoT hub.
-
-
-
Method Detail
-
lockDurationAsIso8601
public Duration lockDurationAsIso8601()
Get the lockDurationAsIso8601 property: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.- Returns:
- the lockDurationAsIso8601 value.
-
withLockDurationAsIso8601
public MessagingEndpointProperties withLockDurationAsIso8601(Duration lockDurationAsIso8601)
Set the lockDurationAsIso8601 property: The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.- Parameters:
lockDurationAsIso8601
- the lockDurationAsIso8601 value to set.- Returns:
- the MessagingEndpointProperties object itself.
-
ttlAsIso8601
public Duration ttlAsIso8601()
Get the ttlAsIso8601 property: The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.- Returns:
- the ttlAsIso8601 value.
-
withTtlAsIso8601
public MessagingEndpointProperties withTtlAsIso8601(Duration ttlAsIso8601)
Set the ttlAsIso8601 property: The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.- Parameters:
ttlAsIso8601
- the ttlAsIso8601 value to set.- Returns:
- the MessagingEndpointProperties object itself.
-
maxDeliveryCount
public Integer maxDeliveryCount()
Get the maxDeliveryCount property: The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.- Returns:
- the maxDeliveryCount value.
-
withMaxDeliveryCount
public MessagingEndpointProperties withMaxDeliveryCount(Integer maxDeliveryCount)
Set the maxDeliveryCount property: The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.- Parameters:
maxDeliveryCount
- the maxDeliveryCount value to set.- Returns:
- the MessagingEndpointProperties object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-