Package com.norconex.committer.azurecognitivesearch

Class AzureSearchCommitterConfig

java.lang.Object
com.norconex.committer.core.BaseCommitterConfig
com.norconex.committer.core.batch.BaseBatchCommitterConfig
com.norconex.committer.azurecognitivesearch.AzureSearchCommitterConfig
All Implemented Interfaces:
Serializable
public class AzureSearchCommitterConfig extends BaseBatchCommitterConfig implements Serializable

Azure Search Committer configuration.

Author:
Pascal Essiembre
See Also:

  • Field Details

    • DEFAULT_API_VERSION

      public static final String DEFAULT_API_VERSION
      Default Azure Search API version
      See Also:

    • DEFAULT_AZURE_KEY_FIELD

      public static final String DEFAULT_AZURE_KEY_FIELD
      Default Azure Search document key field
      See Also:

    • DEFAULT_AZURE_CONTENT_FIELD

      public static final String DEFAULT_AZURE_CONTENT_FIELD
      Default Azure Search content field
      See Also:

  • Constructor Details

    • AzureSearchCommitterConfig

      public AzureSearchCommitterConfig()

  • Method Details

    • getProxySettings

      public ProxySettings getProxySettings()
      Gets the proxy settings.
      Returns:
      proxy settings (never null).

    • setProxySettings

      public AzureSearchCommitterConfig setProxySettings(@NonNull @NonNull ProxySettings proxySettings)
      Sets the proxy settings.
      Parameters:
      proxySettings - proxy settings
      Returns:
      this

    • getEndpoint

      public String getEndpoint()
      Gets the Azure Search endpoint. (https://[service name].search.windows.net).

    • getApiVersion

      public String getApiVersion()
      The Azure API version. Default is DEFAULT_API_VERSION.

    • getApiKey

      public String getApiKey()
      The Azure API admin key.

    • getIndexName

      public String getIndexName()
      The target index name.

    • isDisableDocKeyEncoding

      public boolean isDisableDocKeyEncoding()
      Whether to disable document reference encoding. By default, references are encoded using a URL-safe Base64 encoding. When true, document references will be sent as is if they pass validation.

    • isIgnoreValidationErrors

      public boolean isIgnoreValidationErrors()
      Whether to ignore validation errors. By default, an exception is thrown if a document contains a field that Azure Search will reject. When true the validation errors are logged instead and the faulty field or document is not committed.

    • isIgnoreResponseErrors

      public boolean isIgnoreResponseErrors()
      Whether to ignore response errors. By default, an exception is thrown if the Azure Search response contains an error. When true the errors are logged instead.

    • getArrayFields

      public String getArrayFields()
      The fields which values should always be treated as array. Expects a comma-separated-value list or regular expression when the returned value of isArrayFieldsRegex() is true.
      See Also:

    • isArrayFieldsRegex

      public boolean isArrayFieldsRegex()
      Whether the list of fields to be always treated as array is represented as regular expression.
      See Also:

    • isUseWindowsAuth

      public boolean isUseWindowsAuth()
      Whether to use integrated Windows Authentication (if applicable).

    • getSourceKeyField

      public String getSourceKeyField()
      The document field name containing the value to be stored in Azure Search document key field. Default is not a field (null), but rather the document reference.

    • getTargetKeyField

      public String getTargetKeyField()
      The name of Azure Search key field where to store a document unique identifier (sourceKeyField). Default is "id".

    • getTargetContentField

      public String getTargetContentField()
      The name of the Azure Search field where content will be stored. Default is "content". Specifying a null value will disable storing the content.

    • setEndpoint

      public AzureSearchCommitterConfig setEndpoint(String endpoint)
      Gets the Azure Search endpoint. (https://[service name].search.windows.net).
      Returns:
      this.

    • setApiVersion

      public AzureSearchCommitterConfig setApiVersion(String apiVersion)
      The Azure API version. Default is DEFAULT_API_VERSION.
      Returns:
      this.

    • setApiKey

      public AzureSearchCommitterConfig setApiKey(String apiKey)
      The Azure API admin key.
      Returns:
      this.

    • setIndexName

      public AzureSearchCommitterConfig setIndexName(String indexName)
      The target index name.
      Returns:
      this.

    • setDisableDocKeyEncoding

      public AzureSearchCommitterConfig setDisableDocKeyEncoding(boolean disableDocKeyEncoding)
      Whether to disable document reference encoding. By default, references are encoded using a URL-safe Base64 encoding. When true, document references will be sent as is if they pass validation.
      Returns:
      this.

    • setIgnoreValidationErrors

      public AzureSearchCommitterConfig setIgnoreValidationErrors(boolean ignoreValidationErrors)
      Whether to ignore validation errors. By default, an exception is thrown if a document contains a field that Azure Search will reject. When true the validation errors are logged instead and the faulty field or document is not committed.
      Returns:
      this.

    • setIgnoreResponseErrors

      public AzureSearchCommitterConfig setIgnoreResponseErrors(boolean ignoreResponseErrors)
      Whether to ignore response errors. By default, an exception is thrown if the Azure Search response contains an error. When true the errors are logged instead.
      Returns:
      this.

    • setArrayFields

      public AzureSearchCommitterConfig setArrayFields(String arrayFields)
      The fields which values should always be treated as array. Expects a comma-separated-value list or regular expression when the returned value of isArrayFieldsRegex() is true.
      Returns:
      this.
      See Also:

    • setArrayFieldsRegex

      public AzureSearchCommitterConfig setArrayFieldsRegex(boolean arrayFieldsRegex)
      Whether the list of fields to be always treated as array is represented as regular expression.
      Returns:
      this.
      See Also:

    • setUseWindowsAuth

      public AzureSearchCommitterConfig setUseWindowsAuth(boolean useWindowsAuth)
      Whether to use integrated Windows Authentication (if applicable).
      Returns:
      this.

    • setSourceKeyField

      public AzureSearchCommitterConfig setSourceKeyField(String sourceKeyField)
      The document field name containing the value to be stored in Azure Search document key field. Default is not a field (null), but rather the document reference.
      Returns:
      this.

    • setTargetKeyField

      public AzureSearchCommitterConfig setTargetKeyField(String targetKeyField)
      The name of Azure Search key field where to store a document unique identifier (sourceKeyField). Default is "id".
      Returns:
      this.

    • setTargetContentField

      public AzureSearchCommitterConfig setTargetContentField(String targetContentField)
      The name of the Azure Search field where content will be stored. Default is "content". Specifying a null value will disable storing the content.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class BaseBatchCommitterConfig

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class BaseBatchCommitterConfig

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BaseBatchCommitterConfig

    • toString

      public String toString()
      Overrides:
      toString in class BaseBatchCommitterConfig