IotHubDataConnection Class

Package:

com.microsoft.azure.management.kusto.v2020_09_18

Maven Artifact:

com.microsoft.azure.kusto.v2020_09_18:azure-mgmt-kusto:1.0.0-beta

• java.lang.Object
• • com.microsoft.azure.ProxyResource
  • • com.microsoft.azure.management.kusto.v2020_09_18.implementation.DataConnectionInner
    • • com.microsoft.azure.management.kusto.v2020_09_18.IotHubDataConnection

public class IotHubDataConnection
extends com.microsoft.azure.management.kusto.v2020_09_18.implementation.DataConnectionInner

Class representing an iot hub data connection.

Constructor Summary

Constructor	Description
IotHubDataConnection()

Method Summary

Modifier and Type	Method and Description
java.lang.String	consumerGroup() Get the iot hub consumer group.
IotHubDataFormat	dataFormat() Get the data format of the message.
java.util.List<java.lang.String>	eventSystemProperties() Get system properties of the iot hub.
java.lang.String	iotHubResourceId() Get the resource ID of the Iot hub to be used to create a data connection.
java.lang.String	mappingRuleName() Get the mapping rule to be used to ingest the data.
ProvisioningState	provisioningState() Get the provisioned state of the resource.
java.lang.String	sharedAccessPolicyName() Get the name of the share access policy.
java.lang.String	tableName() Get the table where the data should be ingested.
IotHubDataConnection	withConsumerGroup(String consumerGroup) Set the iot hub consumer group.
IotHubDataConnection	withDataFormat(IotHubDataFormat dataFormat) Set the data format of the message.
IotHubDataConnection	withEventSystemProperties(List<String> eventSystemProperties) Set system properties of the iot hub.
IotHubDataConnection	withIotHubResourceId(String iotHubResourceId) Set the resource ID of the Iot hub to be used to create a data connection.
IotHubDataConnection	withMappingRuleName(String mappingRuleName) Set the mapping rule to be used to ingest the data.
IotHubDataConnection	withSharedAccessPolicyName(String sharedAccessPolicyName) Set the name of the share access policy.
IotHubDataConnection	withTableName(String tableName) Set the table where the data should be ingested.

Methods inherited from com.microsoft.azure.ProxyResource

com.microsoft.azure.ProxyResource.id com.microsoft.azure.ProxyResource.name com.microsoft.azure.ProxyResource.type

Methods inherited from com.microsoft.azure.management.kusto.v2020_09_18.implementation.DataConnectionInner

com.microsoft.azure.management.kusto.v2020_09_18.implementation.DataConnectionInner.location com.microsoft.azure.management.kusto.v2020_09_18.implementation.DataConnectionInner.withLocation

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

IotHubDataConnection

public IotHubDataConnection()

Method Details

consumerGroup

public String consumerGroup()

Get the iot hub consumer group.

Returns:

the consumerGroup value

dataFormat

public IotHubDataFormat dataFormat()

Get the data format of the message. Optionally the data format can be added to each message. Possible values include: 'MULTIJSON', 'JSON', 'CSV', 'TSV', 'SCSV', 'SOHSV', 'PSV', 'TXT', 'RAW', 'SINGLEJSON', 'AVRO', 'TSVE', 'PARQUET', 'ORC', 'APACHEAVRO', 'W3CLOGFILE'.

Returns:

the dataFormat value

eventSystemProperties

public List eventSystemProperties()

Get system properties of the iot hub.

Returns:

the eventSystemProperties value

iotHubResourceId

public String iotHubResourceId()

Get the resource ID of the Iot hub to be used to create a data connection.

Returns:

the iotHubResourceId value

mappingRuleName

public String mappingRuleName()

Get the mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.

Returns:

the mappingRuleName value

provisioningState

public ProvisioningState provisioningState()

Get the provisioned state of the resource. Possible values include: 'Running', 'Creating', 'Deleting', 'Succeeded', 'Failed', 'Moving'.

Returns:

the provisioningState value

sharedAccessPolicyName

public String sharedAccessPolicyName()

Get the name of the share access policy.

Returns:

the sharedAccessPolicyName value

tableName

public String tableName()

Get the table where the data should be ingested. Optionally the table information can be added to each message.

Returns:

the tableName value

withConsumerGroup

public IotHubDataConnection withConsumerGroup(String consumerGroup)

Set the iot hub consumer group.

Parameters:

consumerGroup - the consumerGroup value to set

Returns:

the IotHubDataConnection object itself.

withDataFormat

public IotHubDataConnection withDataFormat(IotHubDataFormat dataFormat)

Set the data format of the message. Optionally the data format can be added to each message. Possible values include: 'MULTIJSON', 'JSON', 'CSV', 'TSV', 'SCSV', 'SOHSV', 'PSV', 'TXT', 'RAW', 'SINGLEJSON', 'AVRO', 'TSVE', 'PARQUET', 'ORC', 'APACHEAVRO', 'W3CLOGFILE'.

Parameters:

dataFormat - the dataFormat value to set

Returns:

the IotHubDataConnection object itself.

withEventSystemProperties

public IotHubDataConnection withEventSystemProperties(List eventSystemProperties)

Set system properties of the iot hub.

Parameters:

eventSystemProperties - the eventSystemProperties value to set

Returns:

the IotHubDataConnection object itself.

withIotHubResourceId

public IotHubDataConnection withIotHubResourceId(String iotHubResourceId)

Set 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.

withMappingRuleName

public IotHubDataConnection withMappingRuleName(String mappingRuleName)

Set 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.

withSharedAccessPolicyName

public IotHubDataConnection withSharedAccessPolicyName(String sharedAccessPolicyName)

Set the name of the share access policy.

Parameters:

sharedAccessPolicyName - the sharedAccessPolicyName value to set

Returns:

the IotHubDataConnection object itself.

withTableName

public IotHubDataConnection withTableName(String tableName)

Set 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.