Package com.azure.resourcemanager.timeseriesinsights.models

Class IoTHubEventSourceCreateOrUpdateParameters

java.lang.Object
com.azure.resourcemanager.timeseriesinsights.models.CreateOrUpdateTrackedResourceProperties
com.azure.resourcemanager.timeseriesinsights.models.EventSourceCreateOrUpdateParameters
com.azure.resourcemanager.timeseriesinsights.models.IoTHubEventSourceCreateOrUpdateParameters
public final class IoTHubEventSourceCreateOrUpdateParameters extends EventSourceCreateOrUpdateParameters
Parameters supplied to the Create or Update Event Source operation for an IoTHub event source.

  • Constructor Details

    • IoTHubEventSourceCreateOrUpdateParameters

      public IoTHubEventSourceCreateOrUpdateParameters()
      Creates an instance of IoTHubEventSourceCreateOrUpdateParameters class.

  • Method Details

    • withLocalTimestamp

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

    • withLocation

      public IoTHubEventSourceCreateOrUpdateParameters withLocation(String location)
      Set the location property: The location of the resource.
      Overrides:
      withLocation in class EventSourceCreateOrUpdateParameters
      Parameters:
      location - the location value to set.
      Returns:
      the CreateOrUpdateTrackedResourceProperties object itself.

    • withTags

      public IoTHubEventSourceCreateOrUpdateParameters withTags(Map<String,String> tags)
      Set the tags property: Key-value pairs of additional properties for the resource.
      Overrides:
      withTags in class EventSourceCreateOrUpdateParameters
      Parameters:
      tags - the tags value to set.
      Returns:
      the CreateOrUpdateTrackedResourceProperties object itself.

    • sharedAccessKey

      public String sharedAccessKey()
      Get the sharedAccessKey property: The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.
      Returns:
      the sharedAccessKey value.

    • withSharedAccessKey

      public IoTHubEventSourceCreateOrUpdateParameters withSharedAccessKey(String sharedAccessKey)
      Set the sharedAccessKey property: The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.
      Parameters:
      sharedAccessKey - the sharedAccessKey value to set.
      Returns:
      the IoTHubEventSourceCreateOrUpdateParameters object itself.

    • iotHubName

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

    • withIotHubName

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

    • localTimestampPropertiesLocalTimestamp

      public LocalTimestamp localTimestampPropertiesLocalTimestamp()
      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.

    • withLocalTimestampPropertiesLocalTimestamp

      public IoTHubEventSourceCreateOrUpdateParameters withLocalTimestampPropertiesLocalTimestamp(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 IoTHubEventSourceCreateOrUpdateParameters object itself.

    • type

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

    • withType

      public IoTHubEventSourceCreateOrUpdateParameters withType(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 IoTHubEventSourceCreateOrUpdateParameters 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 IoTHubEventSourceCreateOrUpdateParameters 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 IoTHubEventSourceCreateOrUpdateParameters 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 EventSourceCreateOrUpdateParameters
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.