Class IotHubConnectionProperties
java.lang.Object
com.azure.resourcemanager.kusto.fluent.models.IotHubConnectionProperties
Class representing the Kusto Iot hub connection properties.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the consumerGroup property: The iot hub consumer group.Get the databaseRouting property: Indication for database routing information from the data connection, by default only database routing information is allowed.Get the dataFormat property: The data format of the message.Get the eventSystemProperties property: System properties of the iot hub.Get the iotHubResourceId property: The resource ID of the Iot hub to be used to create a data connection.Get the mappingRuleName property: The mapping rule to be used to ingest the data.Get the provisioningState property: The provisioned state of the resource.Get the retrievalStartDate property: When defined, the data connection retrieves existing Event hub events created since the Retrieval start date.Get the sharedAccessPolicyName property: The name of the share access policy.Get the tableName property: The table where the data should be ingested.void
validate()
Validates the instance.withConsumerGroup
(String consumerGroup) Set the consumerGroup property: The iot hub consumer group.withDatabaseRouting
(DatabaseRouting databaseRouting) Set the databaseRouting property: Indication for database routing information from the data connection, by default only database routing information is allowed.withDataFormat
(IotHubDataFormat dataFormat) Set the dataFormat property: The data format of the message.withEventSystemProperties
(List<String> eventSystemProperties) Set the eventSystemProperties property: System properties of the iot hub.withIotHubResourceId
(String iotHubResourceId) Set the iotHubResourceId property: The resource ID of the Iot hub to be used to create a data connection.withMappingRuleName
(String mappingRuleName) Set the mappingRuleName property: The mapping rule to be used to ingest the data.withRetrievalStartDate
(OffsetDateTime retrievalStartDate) Set the retrievalStartDate property: When defined, the data connection retrieves existing Event hub events created since the Retrieval start date.withSharedAccessPolicyName
(String sharedAccessPolicyName) Set the sharedAccessPolicyName property: The name of the share access policy.withTableName
(String tableName) Set the tableName property: The table where the data should be ingested.
-
Constructor Details
-
IotHubConnectionProperties
public IotHubConnectionProperties()
-
-
Method Details
-
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
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
Get the consumerGroup property: The iot hub consumer group.- Returns:
- the consumerGroup value.
-
withConsumerGroup
Set the consumerGroup property: The iot hub consumer group.- Parameters:
consumerGroup
- the consumerGroup value to set.- Returns:
- the IotHubConnectionProperties object itself.
-
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
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
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
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
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
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
Get the eventSystemProperties property: System properties of the iot hub.- Returns:
- the eventSystemProperties value.
-
withEventSystemProperties
Set the eventSystemProperties property: System properties of the iot hub.- Parameters:
eventSystemProperties
- the eventSystemProperties value to set.- Returns:
- the IotHubConnectionProperties object itself.
-
databaseRouting
Get the databaseRouting property: Indication for database routing information from the data connection, by default only database routing information is allowed.- Returns:
- the databaseRouting value.
-
withDatabaseRouting
Set the databaseRouting property: Indication for database routing information from the data connection, by default only database routing information is allowed.- Parameters:
databaseRouting
- the databaseRouting value to set.- Returns:
- the IotHubConnectionProperties object itself.
-
retrievalStartDate
Get the retrievalStartDate property: When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period.- Returns:
- the retrievalStartDate value.
-
withRetrievalStartDate
Set the retrievalStartDate property: When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period.- Parameters:
retrievalStartDate
- the retrievalStartDate value to set.- Returns:
- the IotHubConnectionProperties object itself.
-
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.
-