Class AzureEventSourceProperties

Direct Known Subclasses:
EventHubEventSourceCommonProperties, IoTHubEventSourceCommonProperties

public class AzureEventSourceProperties extends EventSourceCommonProperties
Properties of an event source that reads events from an event broker in Azure.
  • Constructor Details

    • AzureEventSourceProperties

      public AzureEventSourceProperties()
      Creates an instance of AzureEventSourceProperties class.
  • Method Details

    • 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 AzureEventSourceProperties 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 AzureEventSourceProperties object itself.
    • withTimestampPropertyName

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

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

      Set the type property: The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
      Overrides:
      withType in class EventSourceCommonProperties
      Parameters:
      type - the type value to set.
      Returns:
      the EventSourceCommonProperties object itself.
    • withTime

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

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