Package com.azure.resourcemanager.timeseriesinsights.models

Class IoTHubEventSourceCommonProperties

java.lang.Object
com.azure.resourcemanager.timeseriesinsights.models.ResourceProperties
com.azure.resourcemanager.timeseriesinsights.models.EventSourceCommonProperties
com.azure.resourcemanager.timeseriesinsights.models.AzureEventSourceProperties
com.azure.resourcemanager.timeseriesinsights.models.IoTHubEventSourceCommonProperties
Direct Known Subclasses:
IoTHubEventSourceCreationProperties, IoTHubEventSourceResourceProperties
public class IoTHubEventSourceCommonProperties extends AzureEventSourceProperties
Properties of the IoTHub event source.

  • Constructor Details

    • IoTHubEventSourceCommonProperties

      public IoTHubEventSourceCommonProperties()
      Creates an instance of IoTHubEventSourceCommonProperties class.

  • Method Details

    • iotHubName

      public String iotHubName()
      Get the iotHubName property: The name of the iot hub.
      Returns:
      the iotHubName value.

    • withIotHubName

      public IoTHubEventSourceCommonProperties withIotHubName(String iotHubName)
      Set the iotHubName property: The name of the iot hub.
      Parameters:
      iotHubName - the iotHubName value to set.
      Returns:
      the IoTHubEventSourceCommonProperties object itself.

    • consumerGroupName

      public String consumerGroupName()
      Get the consumerGroupName property: The name of the iot hub's consumer group that holds the partitions from which events will be read.
      Returns:
      the consumerGroupName value.

    • withConsumerGroupName

      public IoTHubEventSourceCommonProperties withConsumerGroupName(String consumerGroupName)
      Set the consumerGroupName property: The name of the iot hub's consumer group that holds the partitions from which events will be read.
      Parameters:
      consumerGroupName - the consumerGroupName value to set.
      Returns:
      the IoTHubEventSourceCommonProperties object itself.

    • keyName

      public String keyName()
      Get the keyName property: The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub.
      Returns:
      the keyName value.

    • withKeyName

      public IoTHubEventSourceCommonProperties withKeyName(String keyName)
      Set the keyName property: The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub.
      Parameters:
      keyName - the keyName value to set.
      Returns:
      the IoTHubEventSourceCommonProperties object itself.

    • withEventSourceResourceId

      public IoTHubEventSourceCommonProperties withEventSourceResourceId(String eventSourceResourceId)
      Set the eventSourceResourceId property: The resource id of the event source in Azure Resource Manager.
      Overrides:
      withEventSourceResourceId in class AzureEventSourceProperties
      Parameters:
      eventSourceResourceId - the eventSourceResourceId value to set.
      Returns:
      the AzureEventSourceProperties object itself.

    • withTimestampPropertyName

      public IoTHubEventSourceCommonProperties withTimestampPropertyName(String timestampPropertyName)
      Set the timestampPropertyName property: The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.
      Overrides:
      withTimestampPropertyName in class AzureEventSourceProperties
      Parameters:
      timestampPropertyName - the timestampPropertyName value to set.
      Returns:
      the EventSourceCommonProperties object itself.

    • withLocalTimestamp

      public IoTHubEventSourceCommonProperties withLocalTimestamp(LocalTimestamp localTimestamp)
      Set the localTimestamp property: An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.
      Overrides:
      withLocalTimestamp in class AzureEventSourceProperties
      Parameters:
      localTimestamp - the localTimestamp value to set.
      Returns:
      the EventSourceCommonProperties object itself.

    • withType

      public IoTHubEventSourceCommonProperties withType(IngressStartAtType type)
      Set the type property: The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
      Overrides:
      withType in class AzureEventSourceProperties
      Parameters:
      type - the type value to set.
      Returns:
      the EventSourceCommonProperties object itself.

    • withTime

      public IoTHubEventSourceCommonProperties withTime(String time)
      Set the time property: ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.
      Overrides:
      withTime in class AzureEventSourceProperties
      Parameters:
      time - the time value to set.
      Returns:
      the EventSourceCommonProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class AzureEventSourceProperties
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.