Package com.atlassian.jira.webtests.ztests.opensearch

Class OpenSearchClient

java.lang.Object

com.atlassian.jira.webtests.ztests.opensearch.OpenSearchClient

public class OpenSearchClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ISSUE_INDEX_NAME	This is the opensearch.index.issues.name set by configure-jira-to-use-opensearch.xml

Constructor Summary

Constructors

Constructor	Description
OpenSearchClient(JIRAEnvironmentData environmentData)
OpenSearchClient(JIRAEnvironmentData environmentData, String openSearchUrl)

Method Summary

Modifier and Type	Method	Description
void	deindexIssue(long issueId)	Deindexes an issue from the OpenSearch index by issue ID.
void	deindexIssue(String issueId)	Deindexes an issue document from the OpenSearch index by issue ID string.
int	getMaxTermsCount()	Retrieves the current OpenSearch max terms count limit.
void	setFieldLimits(int limit)	Configures OpenSearch field limits to handle large numbers of fields.
void	setMaxResultWindow(int maxResultWindow)	Configures OpenSearch max result window limit.
void	setMaxTermsCount(int maxTermsCount)	Configures OpenSearch max terms count limit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ISSUE_INDEX_NAME

public static final String ISSUE_INDEX_NAME

This is the opensearch.index.issues.name set by configure-jira-to-use-opensearch.xml

See Also:

• Constant Field Values

Constructor Details

OpenSearchClient

public OpenSearchClient(JIRAEnvironmentData environmentData)

OpenSearchClient

public OpenSearchClient(JIRAEnvironmentData environmentData,
 String openSearchUrl)

Method Details

setMaxResultWindow

public void setMaxResultWindow(int maxResultWindow)

Configures OpenSearch max result window limit.

Parameters:

maxResultWindow - the maximum result window value to set

setMaxTermsCount

public void setMaxTermsCount(int maxTermsCount)

Configures OpenSearch max terms count limit.

Parameters:

maxTermsCount - the maximum terms count value to set

getMaxTermsCount

public int getMaxTermsCount()

Retrieves the current OpenSearch max terms count limit.

Returns:

the current maximum terms count value, or -1 if not configured or an error occurs

setFieldLimits

public void setFieldLimits(int limit)

Configures OpenSearch field limits to handle large numbers of fields.

Parameters:

limit - the maximum number of fields allowed in the index.

deindexIssue

public void deindexIssue(long issueId)

Deindexes an issue from the OpenSearch index by issue ID.

Parameters:

issueId - the ID of the issue to deindex

deindexIssue

public void deindexIssue(String issueId)

Deindexes an issue document from the OpenSearch index by issue ID string.

Parameters:

issueId - the ID of the issue to deindex as a string