AzureDataExplorerConnectionProperties Class

Package:

com.azure.resourcemanager.digitaltwins.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-digitaltwins:1.3.0

• 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

Constructor	Description
AzureDataExplorerConnectionProperties()	Creates an instance of AzureDataExplorerConnectionProperties class.

Method Summary

Modifier and Type	Method and 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	adxRelationshipLifecycleEventsTableName() Get the adxRelationshipLifecycleEventsTableName property: The name of the Azure Data Explorer table used for recording relationship lifecycle events.
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 used for storing updates to properties of twins and relationships.
String	adxTwinLifecycleEventsTableName() Get the adxTwinLifecycleEventsTableName property: The name of the Azure Data Explorer table used for recording twin lifecycle events.
ConnectionType	connectionType() Get the connectionType property: The type of time series connection resource.
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.
static AzureDataExplorerConnectionProperties	fromJson(JsonReader jsonReader) Reads an instance of AzureDataExplorerConnectionProperties from the JsonReader.
TimeSeriesDatabaseConnectionState	provisioningState() Get the provisioningState property: The provisioning state.
RecordPropertyAndItemRemovals	recordPropertyAndItemRemovals() Get the recordPropertyAndItemRemovals property: Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.).
JsonWriter	toJson(JsonWriter jsonWriter)
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	withAdxRelationshipLifecycleEventsTableName(String adxRelationshipLifecycleEventsTableName) Set the adxRelationshipLifecycleEventsTableName property: The name of the Azure Data Explorer table used for recording relationship lifecycle events.
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 used for storing updates to properties of twins and relationships.
AzureDataExplorerConnectionProperties	withAdxTwinLifecycleEventsTableName(String adxTwinLifecycleEventsTableName) Set the adxTwinLifecycleEventsTableName property: The name of the Azure Data Explorer table used for recording twin lifecycle events.
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.
AzureDataExplorerConnectionProperties	withIdentity(ManagedIdentityReference identity) Set the identity property: Managed identity properties for the time series database connection resource.
AzureDataExplorerConnectionProperties	withRecordPropertyAndItemRemovals(RecordPropertyAndItemRemovals recordPropertyAndItemRemovals) Set the recordPropertyAndItemRemovals property: Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.).

Methods inherited from TimeSeriesDatabaseConnectionProperties

connectionType fromJson identity provisioningState toJson validate withIdentity

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureDataExplorerConnectionProperties

public AzureDataExplorerConnectionProperties()

Creates an instance of AzureDataExplorerConnectionProperties class.

Method Details

adxDatabaseName

public String adxDatabaseName()

Get the adxDatabaseName property: The name of the Azure Data Explorer database.

Returns:

the adxDatabaseName value.

adxEndpointUri

public String adxEndpointUri()

Get the adxEndpointUri property: The URI of the Azure Data Explorer endpoint.

Returns:

the adxEndpointUri value.

adxRelationshipLifecycleEventsTableName

public String adxRelationshipLifecycleEventsTableName()

Get the adxRelationshipLifecycleEventsTableName property: The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.

Returns:

the adxRelationshipLifecycleEventsTableName value.

adxResourceId

public String adxResourceId()

Get the adxResourceId property: The resource ID of the Azure Data Explorer cluster.

Returns:

the adxResourceId value.

adxTableName

public String adxTableName()

Get the adxTableName property: The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.

Returns:

the adxTableName value.

adxTwinLifecycleEventsTableName

public String adxTwinLifecycleEventsTableName()

Get the adxTwinLifecycleEventsTableName property: The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.

Returns:

the adxTwinLifecycleEventsTableName value.

connectionType

public ConnectionType connectionType()

Get the connectionType property: The type of time series connection resource.

Overrides:

AzureDataExplorerConnectionProperties.connectionType()

Returns:

the connectionType value.

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.

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.

eventHubEntityPath

public String eventHubEntityPath()

Get the eventHubEntityPath property: The EventHub name in the EventHub namespace for identity-based authentication.

Returns:

the eventHubEntityPath value.

eventHubNamespaceResourceId

public String eventHubNamespaceResourceId()

Get the eventHubNamespaceResourceId property: The resource ID of the EventHub namespace.

Returns:

the eventHubNamespaceResourceId value.

fromJson

public static AzureDataExplorerConnectionProperties fromJson(JsonReader jsonReader)

Reads an instance of AzureDataExplorerConnectionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureDataExplorerConnectionProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

provisioningState

public TimeSeriesDatabaseConnectionState provisioningState()

Get the provisioningState property: The provisioning state.

Overrides:

AzureDataExplorerConnectionProperties.provisioningState()

Returns:

the provisioningState value.

recordPropertyAndItemRemovals

public RecordPropertyAndItemRemovals recordPropertyAndItemRemovals()

Get the recordPropertyAndItemRemovals property: Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.

Returns:

the recordPropertyAndItemRemovals value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureDataExplorerConnectionProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

Overrides:

AzureDataExplorerConnectionProperties.validate()

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.

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.

withAdxRelationshipLifecycleEventsTableName

public AzureDataExplorerConnectionProperties withAdxRelationshipLifecycleEventsTableName(String adxRelationshipLifecycleEventsTableName)

Set the adxRelationshipLifecycleEventsTableName property: The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.

Parameters:

adxRelationshipLifecycleEventsTableName - the adxRelationshipLifecycleEventsTableName value to set.

Returns:

the AzureDataExplorerConnectionProperties object itself.

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.

withAdxTableName

public AzureDataExplorerConnectionProperties withAdxTableName(String adxTableName)

Set the adxTableName property: The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.

Parameters:

adxTableName - the adxTableName value to set.

Returns:

the AzureDataExplorerConnectionProperties object itself.

withAdxTwinLifecycleEventsTableName

public AzureDataExplorerConnectionProperties withAdxTwinLifecycleEventsTableName(String adxTwinLifecycleEventsTableName)

Set the adxTwinLifecycleEventsTableName property: The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.

Parameters:

adxTwinLifecycleEventsTableName - the adxTwinLifecycleEventsTableName value to set.

Returns:

the AzureDataExplorerConnectionProperties object itself.

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.

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.

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.

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.

withIdentity

public AzureDataExplorerConnectionProperties withIdentity(ManagedIdentityReference identity)

Set the identity property: Managed identity properties for the time series database connection resource.

Overrides:

AzureDataExplorerConnectionProperties.withIdentity(ManagedIdentityReference identity)

Parameters:

identity

withRecordPropertyAndItemRemovals

public AzureDataExplorerConnectionProperties withRecordPropertyAndItemRemovals(RecordPropertyAndItemRemovals recordPropertyAndItemRemovals)

Set the recordPropertyAndItemRemovals property: Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.

Parameters:

recordPropertyAndItemRemovals - the recordPropertyAndItemRemovals value to set.

Returns:

the AzureDataExplorerConnectionProperties object itself.