Share via

EventHubProperties Class

  • Reference
Package:
com.azure.resourcemanager.iothub.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-iothub:1.2.0
  • java.lang.Object
    • com.azure.resourcemanager.iothub.models.EventHubProperties

public final class EventHubProperties

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

Constructor Summary

Constructor Description
EventHubProperties()

Creates an instance of EventHubProperties class.

Method Summary

Modifier and Type Method and 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 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EventHubProperties

public EventHubProperties()

Creates an instance of EventHubProperties class.

Method Details

endpoint

public String endpoint()

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

Returns:

the endpoint value.

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.

partitionIds

public List 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.

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.

validate

public void validate()

Validates the instance.

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.

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.

Applies to