public class AzureSearchCommitterConfig extends Object implements Serializable
Azure Search Committer configuration.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_API_VERSION
Default Azure Search API version
|
static String |
DEFAULT_AZURE_CONTENT_FIELD
Default Azure Search content field
|
static String |
DEFAULT_AZURE_KEY_FIELD
Default Azure Search document key field
|
Constructor and Description |
---|
AzureSearchCommitterConfig() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object other) |
String |
getApiKey()
Gets the Azure API admin key.
|
String |
getApiVersion()
Gets the Azure API version.
|
String |
getArrayFields()
Gets fields which values should always be treated as array.
|
String |
getEndpoint()
Gets the Azure Search endpoint
(https://[service name].search.windows.net).
|
String |
getIndexName()
Gets the index name.
|
ProxySettings |
getProxySettings()
Gets the proxy settings.
|
String |
getSourceKeyField()
Gets the document field name containing the value to be stored
in Azure Search document key field.
|
String |
getTargetContentField()
Gets the name of the Azure Search field where content will be stored.
|
String |
getTargetKeyField()
Gets the name of Azure Search key field where to store a
document unique identifier (sourceKeyField).
|
int |
hashCode() |
boolean |
isArrayFieldsRegex()
Gets whether the list of fields to be always treated as array
is represented as regular expression.
|
boolean |
isDisableDocKeyEncoding()
Whether to disable document reference encoding.
|
boolean |
isIgnoreResponseErrors()
Whether to ignore response errors.
|
boolean |
isIgnoreValidationErrors()
Whether to ignore validation errors.
|
boolean |
isUseWindowsAuth()
Whether to use integrated Windows Authentication (if applicable).
|
void |
setApiKey(String apiKey)
Sets the Azure API admin key.
|
void |
setApiVersion(String apiVersion)
Sets the Azure API version.
|
void |
setArrayFields(String arrayFields)
Sets fields which values should always be treated as array.
|
void |
setArrayFieldsRegex(boolean arrayFieldsRegex)
Sets whether the list of fields to be always treated as array
is represented as regular expression.
|
void |
setDisableDocKeyEncoding(boolean disableReferenceEncoding)
Sets whether to disable document reference encoding.
|
void |
setEndpoint(String endpoint)
Sets the Azure Search endpoint
(https://[service name].search.windows.net).
|
void |
setIgnoreResponseErrors(boolean ignoreResponseErrors)
Sets whether to ignore response errors.
|
void |
setIgnoreValidationErrors(boolean ignoreValidationErrors)
Sets whether to ignore validation errors.
|
void |
setIndexName(String indexName)
Sets the index name.
|
void |
setSourceKeyField(String sourceKeyField)
Sets the document field name containing the value to be stored
in Azure Search key field.
|
void |
setTargetContentField(String targetContentField)
Sets the name of the Azure Search field where content will be stored.
|
void |
setTargetKeyField(String targetKeyField)
Sets the name of the Azure Search document key field where to store
a document unique identifier (sourceKeyField).
|
void |
setUseWindowsAuth(boolean useWindowsAuth)
Sets whether to use integrated Windows Authentication (if applicable).
|
String |
toString() |
public static final String DEFAULT_API_VERSION
public static final String DEFAULT_AZURE_KEY_FIELD
public static final String DEFAULT_AZURE_CONTENT_FIELD
public String getIndexName()
public void setIndexName(String indexName)
indexName
- the index namepublic String getEndpoint()
public void setEndpoint(String endpoint)
endpoint
- Azure Search endpointpublic String getApiVersion()
DEFAULT_API_VERSION
.public void setApiVersion(String apiVersion)
apiVersion
- Azure API versionpublic String getApiKey()
public void setApiKey(String apiKey)
apiKey
- Azure API admin keypublic boolean isDisableDocKeyEncoding()
true
,
document references will be sent as is if they pass validation.true
if disabling reference encodingpublic void setDisableDocKeyEncoding(boolean disableReferenceEncoding)
false
, references are encoded using a URL-safe Base64
encoding. When true
, document references will be sent as
is if they pass validation.disableReferenceEncoding
- true
if disabling
reference encodingpublic boolean isIgnoreValidationErrors()
true
the validation errors are logged
instead and the faulty field or document is not committed.true
when ignoring validation errorspublic void setIgnoreValidationErrors(boolean ignoreValidationErrors)
false
, 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.ignoreValidationErrors
- true
when ignoring validation
errorspublic boolean isIgnoreResponseErrors()
true
the errors are logged instead.true
when ignoring response errorspublic void setIgnoreResponseErrors(boolean ignoreResponseErrors)
false
, an exception is
thrown if the Azure Search response contains an error.
When true
the errors are logged instead.ignoreResponseErrors
- true
when ignoring response
errorspublic ProxySettings getProxySettings()
null
).public boolean isUseWindowsAuth()
true
if using Windows Authenticationpublic void setUseWindowsAuth(boolean useWindowsAuth)
useWindowsAuth
- true
if using Windows Authenticationpublic String getArrayFields()
isArrayFieldsRegex()
.isArrayFieldsRegex()
public void setArrayFields(String arrayFields)
isArrayFieldsRegex()
.arrayFields
- list of fields or regular expression matching fieldssetArrayFieldsRegex(boolean)
public boolean isArrayFieldsRegex()
true
if regular expressiongetArrayFields()
public void setArrayFieldsRegex(boolean arrayFieldsRegex)
arrayFieldsRegex
- true
if regular expressionsetArrayFields(String)
public String getSourceKeyField()
public void setSourceKeyField(String sourceKeyField)
null
to use the
document reference instead of a field (default).sourceKeyField
- name of field containing id value,
or null
public String getTargetKeyField()
public void setTargetKeyField(String targetKeyField)
targetKeyField
- name of Solr ID fieldpublic String getTargetContentField()
public void setTargetContentField(String targetContentField)
null
value will disable storing the content.targetContentField
- field nameCopyright © 2017–2022 Norconex Inc.. All rights reserved.