Package com.azure.resourcemanager.iothub.models

Class EventHubProperties

java.lang.Object

com.azure.resourcemanager.iothub.models.EventHubProperties

public final class EventHubProperties
extends Object

The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

Constructor Summary

Constructors

Constructor	Description
EventHubProperties()

Method Summary

Modifier and Type	Method	Description
String	endpoint()	Get the endpoint property: The Event Hub-compatible endpoint.
Integer	partitionCount()	Get the partitionCount property: The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint.
List<String>	partitionIds()	Get the partitionIds property: The partition ids in the Event Hub-compatible endpoint.
String	path()	Get the path property: The Event Hub-compatible name.
Long	retentionTimeInDays()	Get the retentionTimeInDays property: The retention time for device-to-cloud messages in days.
void	validate()	Validates the instance.
EventHubProperties	withPartitionCount(Integer partitionCount)	Set the partitionCount property: The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint.
EventHubProperties	withRetentionTimeInDays(Long retentionTimeInDays)	Set the retentionTimeInDays property: The retention time for device-to-cloud messages in days.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventHubProperties

public EventHubProperties()

Method Detail

retentionTimeInDays

public Long retentionTimeInDays()

Get the retentionTimeInDays property: The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

Returns:

the retentionTimeInDays value.

withRetentionTimeInDays

public EventHubProperties withRetentionTimeInDays(Long retentionTimeInDays)

Set the retentionTimeInDays property: The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

Parameters:

retentionTimeInDays - the retentionTimeInDays value to set.

Returns:

the EventHubProperties object itself.

partitionCount

public Integer partitionCount()

Get the partitionCount property: The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

Returns:

the partitionCount value.

withPartitionCount

public EventHubProperties withPartitionCount(Integer partitionCount)

Set the partitionCount property: The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

Parameters:

partitionCount - the partitionCount value to set.

Returns:

the EventHubProperties object itself.

partitionIds

public List<String> partitionIds()

Get the partitionIds property: The partition ids in the Event Hub-compatible endpoint.

Returns:

the partitionIds value.

path

public String path()

Get the path property: The Event Hub-compatible name.

Returns:

the path value.

endpoint

public String endpoint()

Get the endpoint property: The Event Hub-compatible endpoint.

Returns:

the endpoint value.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.