Class AzureDataExplorerConnectionProperties
- java.lang.Object
-
- com.azure.resourcemanager.digitaltwins.models.TimeSeriesDatabaseConnectionProperties
-
- com.azure.resourcemanager.digitaltwins.models.AzureDataExplorerConnectionProperties
-
public final class AzureDataExplorerConnectionProperties extends TimeSeriesDatabaseConnectionProperties
Properties of a time series database connection to Azure Data Explorer with data being sent via an EventHub.
-
-
Constructor Summary
Constructors Constructor Description AzureDataExplorerConnectionProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
adxDatabaseName()
Get the adxDatabaseName property: The name of the Azure Data Explorer database.String
adxEndpointUri()
Get the adxEndpointUri property: The URI of the Azure Data Explorer endpoint.String
adxResourceId()
Get the adxResourceId property: The resource ID of the Azure Data Explorer cluster.String
adxTableName()
Get the adxTableName property: The name of the Azure Data Explorer table.String
eventHubConsumerGroup()
Get the eventHubConsumerGroup property: The EventHub consumer group to use when ADX reads from EventHub.String
eventHubEndpointUri()
Get the eventHubEndpointUri property: The URL of the EventHub namespace for identity-based authentication.String
eventHubEntityPath()
Get the eventHubEntityPath property: The EventHub name in the EventHub namespace for identity-based authentication.String
eventHubNamespaceResourceId()
Get the eventHubNamespaceResourceId property: The resource ID of the EventHub namespace.void
validate()
Validates the instance.AzureDataExplorerConnectionProperties
withAdxDatabaseName(String adxDatabaseName)
Set the adxDatabaseName property: The name of the Azure Data Explorer database.AzureDataExplorerConnectionProperties
withAdxEndpointUri(String adxEndpointUri)
Set the adxEndpointUri property: The URI of the Azure Data Explorer endpoint.AzureDataExplorerConnectionProperties
withAdxResourceId(String adxResourceId)
Set the adxResourceId property: The resource ID of the Azure Data Explorer cluster.AzureDataExplorerConnectionProperties
withAdxTableName(String adxTableName)
Set the adxTableName property: The name of the Azure Data Explorer table.AzureDataExplorerConnectionProperties
withEventHubConsumerGroup(String eventHubConsumerGroup)
Set the eventHubConsumerGroup property: The EventHub consumer group to use when ADX reads from EventHub.AzureDataExplorerConnectionProperties
withEventHubEndpointUri(String eventHubEndpointUri)
Set the eventHubEndpointUri property: The URL of the EventHub namespace for identity-based authentication.AzureDataExplorerConnectionProperties
withEventHubEntityPath(String eventHubEntityPath)
Set the eventHubEntityPath property: The EventHub name in the EventHub namespace for identity-based authentication.AzureDataExplorerConnectionProperties
withEventHubNamespaceResourceId(String eventHubNamespaceResourceId)
Set the eventHubNamespaceResourceId property: The resource ID of the EventHub namespace.-
Methods inherited from class com.azure.resourcemanager.digitaltwins.models.TimeSeriesDatabaseConnectionProperties
provisioningState
-
-
-
-
Method Detail
-
adxResourceId
public String adxResourceId()
Get the adxResourceId property: The resource ID of the Azure Data Explorer cluster.- Returns:
- the adxResourceId value.
-
withAdxResourceId
public AzureDataExplorerConnectionProperties withAdxResourceId(String adxResourceId)
Set the adxResourceId property: The resource ID of the Azure Data Explorer cluster.- Parameters:
adxResourceId
- the adxResourceId value to set.- Returns:
- the AzureDataExplorerConnectionProperties object itself.
-
adxEndpointUri
public String adxEndpointUri()
Get the adxEndpointUri property: The URI of the Azure Data Explorer endpoint.- Returns:
- the adxEndpointUri value.
-
withAdxEndpointUri
public AzureDataExplorerConnectionProperties withAdxEndpointUri(String adxEndpointUri)
Set the adxEndpointUri property: The URI of the Azure Data Explorer endpoint.- Parameters:
adxEndpointUri
- the adxEndpointUri value to set.- Returns:
- the AzureDataExplorerConnectionProperties object itself.
-
adxDatabaseName
public String adxDatabaseName()
Get the adxDatabaseName property: The name of the Azure Data Explorer database.- Returns:
- the adxDatabaseName value.
-
withAdxDatabaseName
public AzureDataExplorerConnectionProperties withAdxDatabaseName(String adxDatabaseName)
Set the adxDatabaseName property: The name of the Azure Data Explorer database.- Parameters:
adxDatabaseName
- the adxDatabaseName value to set.- Returns:
- the AzureDataExplorerConnectionProperties object itself.
-
adxTableName
public String adxTableName()
Get the adxTableName property: The name of the Azure Data Explorer table.- Returns:
- the adxTableName value.
-
withAdxTableName
public AzureDataExplorerConnectionProperties withAdxTableName(String adxTableName)
Set the adxTableName property: The name of the Azure Data Explorer table.- Parameters:
adxTableName
- the adxTableName value to set.- Returns:
- the AzureDataExplorerConnectionProperties object itself.
-
eventHubEndpointUri
public String eventHubEndpointUri()
Get the eventHubEndpointUri property: The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://.- Returns:
- the eventHubEndpointUri value.
-
withEventHubEndpointUri
public AzureDataExplorerConnectionProperties withEventHubEndpointUri(String eventHubEndpointUri)
Set the eventHubEndpointUri property: The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://.- Parameters:
eventHubEndpointUri
- the eventHubEndpointUri value to set.- Returns:
- the AzureDataExplorerConnectionProperties object itself.
-
eventHubEntityPath
public String eventHubEntityPath()
Get the eventHubEntityPath property: The EventHub name in the EventHub namespace for identity-based authentication.- Returns:
- the eventHubEntityPath value.
-
withEventHubEntityPath
public AzureDataExplorerConnectionProperties withEventHubEntityPath(String eventHubEntityPath)
Set the eventHubEntityPath property: The EventHub name in the EventHub namespace for identity-based authentication.- Parameters:
eventHubEntityPath
- the eventHubEntityPath value to set.- Returns:
- the AzureDataExplorerConnectionProperties object itself.
-
eventHubNamespaceResourceId
public String eventHubNamespaceResourceId()
Get the eventHubNamespaceResourceId property: The resource ID of the EventHub namespace.- Returns:
- the eventHubNamespaceResourceId value.
-
withEventHubNamespaceResourceId
public AzureDataExplorerConnectionProperties withEventHubNamespaceResourceId(String eventHubNamespaceResourceId)
Set the eventHubNamespaceResourceId property: The resource ID of the EventHub namespace.- Parameters:
eventHubNamespaceResourceId
- the eventHubNamespaceResourceId value to set.- Returns:
- the AzureDataExplorerConnectionProperties object itself.
-
eventHubConsumerGroup
public String eventHubConsumerGroup()
Get the eventHubConsumerGroup property: The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.- Returns:
- the eventHubConsumerGroup value.
-
withEventHubConsumerGroup
public AzureDataExplorerConnectionProperties withEventHubConsumerGroup(String eventHubConsumerGroup)
Set the eventHubConsumerGroup property: The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.- Parameters:
eventHubConsumerGroup
- the eventHubConsumerGroup value to set.- Returns:
- the AzureDataExplorerConnectionProperties object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classTimeSeriesDatabaseConnectionProperties
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-