CloudToDeviceProperties Class

Package:

com.azure.resourcemanager.iothub.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-iothub:1.3.0

• java.lang.Object
• • com.azure.resourcemanager.iothub.models.CloudToDeviceProperties

Implements

JsonSerializable<CloudToDeviceProperties>

public final class CloudToDeviceProperties
implements JsonSerializable<CloudToDeviceProperties>

The IoT hub cloud-to-device messaging properties.

Constructor Summary

Constructor	Description
CloudToDeviceProperties()	Creates an instance of CloudToDeviceProperties class.

Method Summary

Modifier and Type	Method and Description
Duration	defaultTtlAsIso8601() Get the defaultTtlAsIso8601 property: The default time to live for cloud-to-device messages in the device queue.
FeedbackProperties	feedback() Get the feedback property: The properties of the feedback queue for cloud-to-device messages.
static CloudToDeviceProperties	fromJson(JsonReader jsonReader) Reads an instance of CloudToDeviceProperties from the JsonReader.
Integer	maxDeliveryCount() Get the maxDeliveryCount property: The max delivery count for cloud-to-device messages in the device queue.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
CloudToDeviceProperties	withDefaultTtlAsIso8601(Duration defaultTtlAsIso8601) Set the defaultTtlAsIso8601 property: The default time to live for cloud-to-device messages in the device queue.
CloudToDeviceProperties	withFeedback(FeedbackProperties feedback) Set the feedback property: The properties of the feedback queue for cloud-to-device messages.
CloudToDeviceProperties	withMaxDeliveryCount(Integer maxDeliveryCount) Set the maxDeliveryCount property: The max delivery count for cloud-to-device messages in the device queue.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CloudToDeviceProperties

public CloudToDeviceProperties()

Creates an instance of CloudToDeviceProperties class.

Method Details

defaultTtlAsIso8601

public Duration defaultTtlAsIso8601()

Get the defaultTtlAsIso8601 property: The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging\#cloud-to-device-messages.

Returns:

the defaultTtlAsIso8601 value.

feedback

public FeedbackProperties feedback()

Get the feedback property: The properties of the feedback queue for cloud-to-device messages.

Returns:

the feedback value.

fromJson

public static CloudToDeviceProperties fromJson(JsonReader jsonReader)

Reads an instance of CloudToDeviceProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CloudToDeviceProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the CloudToDeviceProperties.

maxDeliveryCount

public Integer maxDeliveryCount()

Get the maxDeliveryCount property: The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging\#cloud-to-device-messages.

Returns:

the maxDeliveryCount value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withDefaultTtlAsIso8601

public CloudToDeviceProperties withDefaultTtlAsIso8601(Duration defaultTtlAsIso8601)

Set the defaultTtlAsIso8601 property: The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging\#cloud-to-device-messages.

Parameters:

defaultTtlAsIso8601 - the defaultTtlAsIso8601 value to set.

Returns:

the CloudToDeviceProperties object itself.

withFeedback

public CloudToDeviceProperties withFeedback(FeedbackProperties feedback)

Set the feedback property: The properties of the feedback queue for cloud-to-device messages.

Parameters:

feedback - the feedback value to set.

Returns:

the CloudToDeviceProperties object itself.

withMaxDeliveryCount

public CloudToDeviceProperties withMaxDeliveryCount(Integer maxDeliveryCount)

Set the maxDeliveryCount property: The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging\#cloud-to-device-messages.

Parameters:

maxDeliveryCount - the maxDeliveryCount value to set.

Returns:

the CloudToDeviceProperties object itself.