Class IotHubConnectionProperties


  • public final class IotHubConnectionProperties
    extends Object
    Class representing the Kusto Iot hub connection properties.
    • Constructor Detail

      • IotHubConnectionProperties

        public IotHubConnectionProperties()
    • Method Detail

      • iotHubResourceId

        public String iotHubResourceId()
        Get the iotHubResourceId property: The resource ID of the Iot hub to be used to create a data connection.
        Returns:
        the iotHubResourceId value.
      • withIotHubResourceId

        public IotHubConnectionProperties withIotHubResourceId​(String iotHubResourceId)
        Set the iotHubResourceId property: The resource ID of the Iot hub to be used to create a data connection.
        Parameters:
        iotHubResourceId - the iotHubResourceId value to set.
        Returns:
        the IotHubConnectionProperties object itself.
      • consumerGroup

        public String consumerGroup()
        Get the consumerGroup property: The iot hub consumer group.
        Returns:
        the consumerGroup value.
      • withConsumerGroup

        public IotHubConnectionProperties withConsumerGroup​(String consumerGroup)
        Set the consumerGroup property: The iot hub consumer group.
        Parameters:
        consumerGroup - the consumerGroup value to set.
        Returns:
        the IotHubConnectionProperties object itself.
      • tableName

        public String tableName()
        Get the tableName property: The table where the data should be ingested. Optionally the table information can be added to each message.
        Returns:
        the tableName value.
      • withTableName

        public IotHubConnectionProperties withTableName​(String tableName)
        Set the tableName property: The table where the data should be ingested. Optionally the table information can be added to each message.
        Parameters:
        tableName - the tableName value to set.
        Returns:
        the IotHubConnectionProperties object itself.
      • mappingRuleName

        public String mappingRuleName()
        Get the mappingRuleName property: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
        Returns:
        the mappingRuleName value.
      • withMappingRuleName

        public IotHubConnectionProperties withMappingRuleName​(String mappingRuleName)
        Set the mappingRuleName property: The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.
        Parameters:
        mappingRuleName - the mappingRuleName value to set.
        Returns:
        the IotHubConnectionProperties object itself.
      • dataFormat

        public IotHubDataFormat dataFormat()
        Get the dataFormat property: The data format of the message. Optionally the data format can be added to each message.
        Returns:
        the dataFormat value.
      • withDataFormat

        public IotHubConnectionProperties withDataFormat​(IotHubDataFormat dataFormat)
        Set the dataFormat property: The data format of the message. Optionally the data format can be added to each message.
        Parameters:
        dataFormat - the dataFormat value to set.
        Returns:
        the IotHubConnectionProperties object itself.
      • eventSystemProperties

        public List<String> eventSystemProperties()
        Get the eventSystemProperties property: System properties of the iot hub.
        Returns:
        the eventSystemProperties value.
      • withEventSystemProperties

        public IotHubConnectionProperties withEventSystemProperties​(List<String> eventSystemProperties)
        Set the eventSystemProperties property: System properties of the iot hub.
        Parameters:
        eventSystemProperties - the eventSystemProperties value to set.
        Returns:
        the IotHubConnectionProperties object itself.
      • sharedAccessPolicyName

        public String sharedAccessPolicyName()
        Get the sharedAccessPolicyName property: The name of the share access policy.
        Returns:
        the sharedAccessPolicyName value.
      • withSharedAccessPolicyName

        public IotHubConnectionProperties withSharedAccessPolicyName​(String sharedAccessPolicyName)
        Set the sharedAccessPolicyName property: The name of the share access policy.
        Parameters:
        sharedAccessPolicyName - the sharedAccessPolicyName value to set.
        Returns:
        the IotHubConnectionProperties object itself.
      • provisioningState

        public ResourceProvisioningState provisioningState()
        Get the provisioningState property: The provisioned state of the resource.
        Returns:
        the provisioningState value.
      • validate

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