Package com.azure.resourcemanager.timeseriesinsights.models

Class EventHubEventSourceCommonProperties

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.EventHubEventSourceCommonProperties
Direct Known Subclasses:
EventHubEventSourceCreationProperties, EventHubEventSourceResourceProperties
public class EventHubEventSourceCommonProperties extends AzureEventSourceProperties
Properties of the EventHub event source.

  • Constructor Details

    • EventHubEventSourceCommonProperties

      public EventHubEventSourceCommonProperties()
      Creates an instance of EventHubEventSourceCommonProperties class.

  • Method Details

    • serviceBusNamespace

      public String serviceBusNamespace()
      Get the serviceBusNamespace property: The name of the service bus that contains the event hub.
      Returns:
      the serviceBusNamespace value.

    • withServiceBusNamespace

      public EventHubEventSourceCommonProperties withServiceBusNamespace(String serviceBusNamespace)
      Set the serviceBusNamespace property: The name of the service bus that contains the event hub.
      Parameters:
      serviceBusNamespace - the serviceBusNamespace value to set.
      Returns:
      the EventHubEventSourceCommonProperties object itself.

    • eventHubName

      public String eventHubName()
      Get the eventHubName property: The name of the event hub.
      Returns:
      the eventHubName value.

    • withEventHubName

      public EventHubEventSourceCommonProperties withEventHubName(String eventHubName)
      Set the eventHubName property: The name of the event hub.
      Parameters:
      eventHubName - the eventHubName value to set.
      Returns:
      the EventHubEventSourceCommonProperties object itself.

    • consumerGroupName

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

    • withConsumerGroupName

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

    • keyName

      public String keyName()
      Get the keyName property: The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.
      Returns:
      the keyName value.

    • withKeyName

      public EventHubEventSourceCommonProperties withKeyName(String keyName)
      Set the keyName property: The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.
      Parameters:
      keyName - the keyName value to set.
      Returns:
      the EventHubEventSourceCommonProperties object itself.

    • withEventSourceResourceId

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