Package com.azure.resourcemanager.timeseriesinsights.models

Class IoTHubEventSourceResource

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.core.management.Resource
com.azure.resourcemanager.timeseriesinsights.fluent.models.EventSourceResourceInner
com.azure.resourcemanager.timeseriesinsights.models.IoTHubEventSourceResource
public final class IoTHubEventSourceResource extends EventSourceResourceInner
An event source that receives its data from an Azure IoTHub.

  • Constructor Details

    • IoTHubEventSourceResource

      public IoTHubEventSourceResource()
      Creates an instance of IoTHubEventSourceResource class.

  • Method Details

    • withLocation

      public IoTHubEventSourceResource withLocation(String location)
      Overrides:
      withLocation in class EventSourceResourceInner

    • withTags

      public IoTHubEventSourceResource withTags(Map<String,String> tags)
      Overrides:
      withTags in class EventSourceResourceInner

    • iotHubName

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

    • withIotHubName

      public IoTHubEventSourceResource withIotHubName(String iotHubName)
      Set the iotHubName property: The name of the iot hub.
      Parameters:
      iotHubName - the iotHubName value to set.
      Returns:
      the IoTHubEventSourceResource 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 IoTHubEventSourceResource 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 IoTHubEventSourceResource 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 IoTHubEventSourceResource 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 IoTHubEventSourceResource object itself.

    • eventSourceResourceId

      public String eventSourceResourceId()
      Get the eventSourceResourceId property: The resource id of the event source in Azure Resource Manager.
      Returns:
      the eventSourceResourceId value.

    • withEventSourceResourceId

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

    • timestampPropertyName

      public String timestampPropertyName()
      Get 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.
      Returns:
      the timestampPropertyName value.

    • withTimestampPropertyName

      public IoTHubEventSourceResource 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.
      Parameters:
      timestampPropertyName - the timestampPropertyName value to set.
      Returns:
      the IoTHubEventSourceResource object itself.

    • localTimestamp

      public LocalTimestamp localTimestamp()
      Get 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.
      Returns:
      the localTimestamp value.

    • withLocalTimestamp

      public IoTHubEventSourceResource 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.
      Parameters:
      localTimestamp - the localTimestamp value to set.
      Returns:
      the IoTHubEventSourceResource object itself.

    • typePropertiesType

      public IngressStartAtType typePropertiesType()
      Get the type property: The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
      Returns:
      the type value.

    • withTypePropertiesType

      public IoTHubEventSourceResource withTypePropertiesType(IngressStartAtType type)
      Set the type property: The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
      Parameters:
      type - the type value to set.
      Returns:
      the IoTHubEventSourceResource object itself.

    • time

      public String time()
      Get 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.
      Returns:
      the time value.

    • withTime

      public IoTHubEventSourceResource 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.
      Parameters:
      time - the time value to set.
      Returns:
      the IoTHubEventSourceResource object itself.

    • provisioningState

      public ProvisioningState provisioningState()
      Get the provisioningState property: Provisioning state of the resource.
      Returns:
      the provisioningState value.

    • creationTime

      public OffsetDateTime creationTime()
      Get the creationTime property: The time the resource was created.
      Returns:
      the creationTime value.

    • validate

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