SearchIndexerDataSourceConnection Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

Implements

JsonSerializable<SearchIndexerDataSourceConnection>

public final class SearchIndexerDataSourceConnection
implements JsonSerializable<SearchIndexerDataSourceConnection>

Represents a datasource definition, which can be used to configure an indexer.

Constructor Summary

Constructor Description
SearchIndexerDataSourceConnection(String name, SearchIndexerDataSourceType type, DataSourceCredentials credentials, SearchIndexerDataContainer container)

Creates an instance of SearchIndexerDataSourceConnection class.

Method Summary

Modifier and Type Method and Description
static SearchIndexerDataSourceConnection fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexerDataSourceConnection from the JsonReader.
SearchIndexerDataContainer getContainer()

Get the container property: The data container for the datasource.
DataSourceCredentials getCredentials()

Get the credentials property: Credentials 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 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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchIndexerDataSourceConnection

public SearchIndexerDataSourceConnection(String name, SearchIndexerDataSourceType type, DataSourceCredentials credentials, SearchIndexerDataContainer container)

Creates an instance of SearchIndexerDataSourceConnection class.

Parameters:

name - the name value to set.
type - the type value to set.
credentials - the credentials value to set.
container - the container value to set.

Method Details

fromJson

public static SearchIndexerDataSourceConnection fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexerDataSourceConnection from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchIndexerDataSourceConnection 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.

getContainer

public SearchIndexerDataContainer getContainer()

Get the container property: The data container for the datasource.

Returns:

the container value.

getCredentials

public DataSourceCredentials getCredentials()

Get the credentials property: Credentials for the datasource.

Returns:

the credentials value.

getDataChangeDetectionPolicy

public DataChangeDetectionPolicy getDataChangeDetectionPolicy()

Get the dataChangeDetectionPolicy property: The data change detection policy for the datasource.

Returns:

the dataChangeDetectionPolicy value.

getDataDeletionDetectionPolicy

public DataDeletionDetectionPolicy getDataDeletionDetectionPolicy()

Get the dataDeletionDetectionPolicy property: The data deletion detection policy for the datasource.

Returns:

the dataDeletionDetectionPolicy value.

getDescription

public String getDescription()

Get the description property: The description of the datasource.

Returns:

the description value.

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. Once you have encrypted your data source definition, it will always remain encrypted. The search service 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.

getETag

public String getETag()

Get the eTag property: The ETag of the data source.

Returns:

the eTag value.

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.

getName

public String getName()

Get the name property: The name of the datasource.

Returns:

the name value.

getType

public SearchIndexerDataSourceType getType()

Get the type property: The type of the datasource.

Returns:

the type 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 SearchIndexerDataSourceConnection object itself.

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 SearchIndexerDataSourceConnection object itself.

setDescription

public SearchIndexerDataSourceConnection setDescription(String description)

Set the description property: The description of the datasource.

Parameters:

description - the description value to set.

Returns:

the SearchIndexerDataSourceConnection object itself.

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. Once you have encrypted your data source definition, it will always remain encrypted. The search service 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 SearchIndexerDataSourceConnection object itself.

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 SearchIndexerDataSourceConnection object itself.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to