Class IotHubDataConnection
java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.synapse.fluent.models.DataConnectionInner
com.azure.resourcemanager.synapse.models.IotHubDataConnection
Class representing an iot hub data connection.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the consumerGroup property: The iot hub consumer group.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 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.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.withLocation
(String location) Set the location property: Resource location.withMappingRuleName
(String mappingRuleName) Set the mappingRuleName property: The mapping rule to be used to ingest the data.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.Methods inherited from class com.azure.resourcemanager.synapse.fluent.models.DataConnectionInner
location, systemData
Methods inherited from class com.azure.core.management.ProxyResource
id, name, type
-
Constructor Details
-
IotHubDataConnection
public IotHubDataConnection()Creates an instance of IotHubDataConnection class.
-
-
Method Details
-
withLocation
Set the location property: Resource location.- Overrides:
withLocation
in classDataConnectionInner
- Parameters:
location
- the location value to set.- Returns:
- the DataConnectionInner object itself.
-
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 IotHubDataConnection 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 IotHubDataConnection 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 IotHubDataConnection 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 IotHubDataConnection 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 IotHubDataConnection 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 IotHubDataConnection object itself.
-
provisioningState
Get the provisioningState property: The provisioned state of the resource.- Returns:
- the provisioningState value.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classDataConnectionInner
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-