Package com.azure.resourcemanager.kusto.models

Class CosmosDbDataConnection

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.kusto.fluent.models.DataConnectionInner
com.azure.resourcemanager.kusto.models.CosmosDbDataConnection
public final class CosmosDbDataConnection extends DataConnectionInner
Class representing a CosmosDb data connection.

  • Constructor Details

    • CosmosDbDataConnection

      public CosmosDbDataConnection()
      Creates an instance of CosmosDbDataConnection class.

  • Method Details

    • withLocation

      public CosmosDbDataConnection withLocation(String location)
      Set the location property: Resource location.
      Overrides:
      withLocation in class DataConnectionInner
      Parameters:
      location - the location value to set.
      Returns:
      the DataConnectionInner object itself.

    • tableName

      public String tableName()
      Get the tableName property: The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
      Returns:
      the tableName value.

    • withTableName

      public CosmosDbDataConnection withTableName(String tableName)
      Set the tableName property: The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
      Parameters:
      tableName - the tableName value to set.
      Returns:
      the CosmosDbDataConnection object itself.

    • mappingRuleName

      public String mappingRuleName()
      Get the mappingRuleName property: The name of an existing mapping rule to use when ingesting the retrieved data.
      Returns:
      the mappingRuleName value.

    • withMappingRuleName

      public CosmosDbDataConnection withMappingRuleName(String mappingRuleName)
      Set the mappingRuleName property: The name of an existing mapping rule to use when ingesting the retrieved data.
      Parameters:
      mappingRuleName - the mappingRuleName value to set.
      Returns:
      the CosmosDbDataConnection object itself.

    • managedIdentityResourceId

      public String managedIdentityResourceId()
      Get the managedIdentityResourceId property: The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
      Returns:
      the managedIdentityResourceId value.

    • withManagedIdentityResourceId

      public CosmosDbDataConnection withManagedIdentityResourceId(String managedIdentityResourceId)
      Set the managedIdentityResourceId property: The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
      Parameters:
      managedIdentityResourceId - the managedIdentityResourceId value to set.
      Returns:
      the CosmosDbDataConnection object itself.

    • managedIdentityObjectId

      public String managedIdentityObjectId()
      Get the managedIdentityObjectId property: The object ID of the managed identity resource.
      Returns:
      the managedIdentityObjectId value.

    • cosmosDbAccountResourceId

      public String cosmosDbAccountResourceId()
      Get the cosmosDbAccountResourceId property: The resource ID of the Cosmos DB account used to create the data connection.
      Returns:
      the cosmosDbAccountResourceId value.

    • withCosmosDbAccountResourceId

      public CosmosDbDataConnection withCosmosDbAccountResourceId(String cosmosDbAccountResourceId)
      Set the cosmosDbAccountResourceId property: The resource ID of the Cosmos DB account used to create the data connection.
      Parameters:
      cosmosDbAccountResourceId - the cosmosDbAccountResourceId value to set.
      Returns:
      the CosmosDbDataConnection object itself.

    • cosmosDbDatabase

      public String cosmosDbDatabase()
      Get the cosmosDbDatabase property: The name of an existing database in the Cosmos DB account.
      Returns:
      the cosmosDbDatabase value.

    • withCosmosDbDatabase

      public CosmosDbDataConnection withCosmosDbDatabase(String cosmosDbDatabase)
      Set the cosmosDbDatabase property: The name of an existing database in the Cosmos DB account.
      Parameters:
      cosmosDbDatabase - the cosmosDbDatabase value to set.
      Returns:
      the CosmosDbDataConnection object itself.

    • cosmosDbContainer

      public String cosmosDbContainer()
      Get the cosmosDbContainer property: The name of an existing container in the Cosmos DB database.
      Returns:
      the cosmosDbContainer value.

    • withCosmosDbContainer

      public CosmosDbDataConnection withCosmosDbContainer(String cosmosDbContainer)
      Set the cosmosDbContainer property: The name of an existing container in the Cosmos DB database.
      Parameters:
      cosmosDbContainer - the cosmosDbContainer value to set.
      Returns:
      the CosmosDbDataConnection object itself.

    • retrievalStartDate

      public OffsetDateTime retrievalStartDate()
      Get the retrievalStartDate property: Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
      Returns:
      the retrievalStartDate value.

    • withRetrievalStartDate

      public CosmosDbDataConnection withRetrievalStartDate(OffsetDateTime retrievalStartDate)
      Set the retrievalStartDate property: Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
      Parameters:
      retrievalStartDate - the retrievalStartDate value to set.
      Returns:
      the CosmosDbDataConnection object itself.

    • provisioningState

      public ProvisioningState 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 class DataConnectionInner
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.