Class SearchIndexerDataSourceConnection
- java.lang.Object
-
- com.azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
-
public final class SearchIndexerDataSourceConnection extends Object
Represents a datasource definition, which can be used to configure an indexer.
-
-
Constructor Summary
Constructors Constructor Description SearchIndexerDataSourceConnection(String name)
Constructor ofSearchIndexerDataSourceConnection
.SearchIndexerDataSourceConnection(String name, SearchIndexerDataSourceType type, String connectionString, SearchIndexerDataContainer container)
Constructor ofSearchIndexerDataSourceConnection
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getConnectionString()
Get the connectionString property: The connection string for the datasource.SearchIndexerDataContainer
getContainer()
Get the container property: The data container for the datasource.DataChangeDetectionPolicy
getDataChangeDetectionPolicy()
Get the dataChangeDetectionPolicy property: The data change detection policy for the datasource.DataDeletionDetectionPolicy
getDataDeletionDetectionPolicy()
Get the dataDeletionDetectionPolicy property: The data deletion detection policy for the datasource.String
getDescription()
Get the description property: The description of the datasource.SearchResourceEncryptionKey
getEncryptionKey()
Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.String
getETag()
Get the eTag property: The ETag of the data source.SearchIndexerDataIdentity
getIdentity()
Get the identity property: An explicit managed identity to use for this datasource.String
getName()
Get the name property: The name of the datasource.SearchIndexerDataSourceType
getType()
Get the type property: The type of the datasource.SearchIndexerDataSourceConnection
setConnectionString(String connectionString)
Set the connectionString property: The connection string for the datasource.SearchIndexerDataSourceConnection
setContainer(SearchIndexerDataContainer container)
Set the container property: The data container for the datasource.SearchIndexerDataSourceConnection
setDataChangeDetectionPolicy(DataChangeDetectionPolicy dataChangeDetectionPolicy)
Set the dataChangeDetectionPolicy property: The data change detection policy for the datasource.SearchIndexerDataSourceConnection
setDataDeletionDetectionPolicy(DataDeletionDetectionPolicy dataDeletionDetectionPolicy)
Set the dataDeletionDetectionPolicy property: The data deletion detection policy for the datasource.SearchIndexerDataSourceConnection
setDescription(String description)
Set the description property: The description of the datasource.SearchIndexerDataSourceConnection
setEncryptionKey(SearchResourceEncryptionKey encryptionKey)
Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.SearchIndexerDataSourceConnection
setETag(String eTag)
Set the eTag property: The ETag of the data source.SearchIndexerDataSourceConnection
setIdentity(SearchIndexerDataIdentity identity)
Set the identity property: An explicit managed identity to use for this datasource.SearchIndexerDataSourceConnection
setType(SearchIndexerDataSourceType type)
Set the type property: The type of the datasource.
-
-
-
Constructor Detail
-
SearchIndexerDataSourceConnection
public SearchIndexerDataSourceConnection(String name)
Constructor ofSearchIndexerDataSourceConnection
.- Parameters:
name
- The name of the datasource.
-
SearchIndexerDataSourceConnection
public SearchIndexerDataSourceConnection(String name, SearchIndexerDataSourceType type, String connectionString, SearchIndexerDataContainer container)
Constructor ofSearchIndexerDataSourceConnection
.- Parameters:
name
- The name of the datasource.type
- The type of the datasource. Possible values include: 'AzureSql', 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql'connectionString
- The connection string for the datasource.container
- The data container for the datasource.
-
-
Method Detail
-
getName
public String getName()
Get the name property: The name of the datasource.- Returns:
- the name value.
-
getDescription
public String getDescription()
Get the description property: The description of the datasource.- Returns:
- the description value.
-
setDescription
public SearchIndexerDataSourceConnection setDescription(String description)
Set the description property: The description of the datasource.- Parameters:
description
- the description value to set.- Returns:
- the SearchIndexerDataSource object itself.
-
getType
public SearchIndexerDataSourceType getType()
Get the type property: The type of the datasource. Possible values include: 'AzureSql', 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql'.- Returns:
- the type value.
-
setType
public SearchIndexerDataSourceConnection setType(SearchIndexerDataSourceType type)
Set the type property: The type of the datasource. Possible values include: 'AzureSql', 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql'.- Parameters:
type
- the type value to set.- Returns:
- the SearchIndexerDataSource object itself.
-
getConnectionString
public String getConnectionString()
Get the connectionString property: The connection string for the datasource.- Returns:
- the connectionString value.
-
setConnectionString
public SearchIndexerDataSourceConnection setConnectionString(String connectionString)
Set the connectionString property: The connection string for the datasource.- Parameters:
connectionString
- the connectionString value to set.- Returns:
- the SearchIndexerDataSource object itself.
-
getContainer
public SearchIndexerDataContainer getContainer()
Get the container property: The data container for the datasource.- Returns:
- the container value.
-
setContainer
public SearchIndexerDataSourceConnection setContainer(SearchIndexerDataContainer container)
Set the container property: The data container for the datasource.- Parameters:
container
- the container value to set.- Returns:
- the SearchIndexerDataSource object itself.
-
getDataChangeDetectionPolicy
public DataChangeDetectionPolicy getDataChangeDetectionPolicy()
Get the dataChangeDetectionPolicy property: The data change detection policy for the datasource.- Returns:
- the dataChangeDetectionPolicy value.
-
setDataChangeDetectionPolicy
public SearchIndexerDataSourceConnection setDataChangeDetectionPolicy(DataChangeDetectionPolicy dataChangeDetectionPolicy)
Set the dataChangeDetectionPolicy property: The data change detection policy for the datasource.- Parameters:
dataChangeDetectionPolicy
- the dataChangeDetectionPolicy value to set.- Returns:
- the SearchIndexerDataSource object itself.
-
getDataDeletionDetectionPolicy
public DataDeletionDetectionPolicy getDataDeletionDetectionPolicy()
Get the dataDeletionDetectionPolicy property: The data deletion detection policy for the datasource.- Returns:
- the dataDeletionDetectionPolicy value.
-
setDataDeletionDetectionPolicy
public SearchIndexerDataSourceConnection setDataDeletionDetectionPolicy(DataDeletionDetectionPolicy dataDeletionDetectionPolicy)
Set the dataDeletionDetectionPolicy property: The data deletion detection policy for the datasource.- Parameters:
dataDeletionDetectionPolicy
- the dataDeletionDetectionPolicy value to set.- Returns:
- the SearchIndexerDataSource object itself.
-
getETag
public String getETag()
Get the eTag property: The ETag of the data source.- Returns:
- the eTag value.
-
setETag
public SearchIndexerDataSourceConnection setETag(String eTag)
Set the eTag property: The ETag of the data source.- Parameters:
eTag
- the eTag value to set.- Returns:
- the SearchIndexerDataSource object itself.
-
getEncryptionKey
public SearchResourceEncryptionKey getEncryptionKey()
Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition in Azure Cognitive Search. Once you have encrypted your data source definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.- Returns:
- the encryptionKey value.
-
setEncryptionKey
public SearchIndexerDataSourceConnection setEncryptionKey(SearchResourceEncryptionKey encryptionKey)
Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition in Azure Cognitive Search. Once you have encrypted your data source definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.- Parameters:
encryptionKey
- the encryptionKey value to set.- Returns:
- the SearchIndexerDataSource object itself.
-
getIdentity
public SearchIndexerDataIdentity getIdentity()
Get the identity property: An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared.- Returns:
- the identity value.
-
setIdentity
public SearchIndexerDataSourceConnection setIdentity(SearchIndexerDataIdentity identity)
Set the identity property: An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared.- Parameters:
identity
- the identity value to set.- Returns:
- the SearchIndexerDataSourceConnection object itself.
-
-