OpenSearchConfig (Atlassian Confluence 8.7.2 API)

java.lang.Object
- com.atlassian.confluence.plugins.opensearch.OpenSearchConfig

All Implemented Interfaces:: SearchPlatformConfig

@ParametersAreNonnullByDefault
@ReturnValuesAreNonnullByDefault
public class OpenSearchConfig
extends Object
implements SearchPlatformConfig

Application config for configuring OpenSearch

Since:: 8.6

Constructor Summary

Constructors
Constructor Description

OpenSearchConfig(com.atlassian.config.ApplicationConfiguration applicationConfig)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Optional<String>`	`getAWSRegion()`
`Integer`	`getBulkApiBatchSize()`
`String`	`getChangeIndexName()`
`Long`	`getConnectRequestTimeout()`
`Long`	`getConnectTimout()`
`String`	`getContentIndexName()`
`String`	`getCustomIndexPrefix()`
`String`	`getHttpUrl()`
`String`	`getIndexName(Index index)`
`String`	`getJournalIndexName()`
`Integer`	`getSocketTimeout()`
`Optional<org.apache.commons.lang3.tuple.Pair<String,String>>`	`getUsernamePassword()`
`boolean`	`isSharedIndex()`	Indicate whether indices are shared between nodes in cluster
`void`	`refresh()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenSearchConfig

public OpenSearchConfig(com.atlassian.config.ApplicationConfiguration applicationConfig)

Method Detail

refresh
```
public void refresh()
```

getHttpUrl
```
public String getHttpUrl()
```

getIndexName

public String getIndexName(Index index)

getContentIndexName
```
public String getContentIndexName()
```

getChangeIndexName
```
public String getChangeIndexName()
```

getCustomIndexPrefix
```
public String getCustomIndexPrefix()
```

getJournalIndexName
```
public String getJournalIndexName()
```

getUsernamePassword

public Optional<org.apache.commons.lang3.tuple.Pair<String,String>> getUsernamePassword()

getAWSRegion

public Optional<String> getAWSRegion()

getConnectRequestTimeout

public Long getConnectRequestTimeout()

getConnectTimout
```
public Long getConnectTimout()
```

getSocketTimeout
```
public Integer getSocketTimeout()
```

getBulkApiBatchSize
```
public Integer getBulkApiBatchSize()
```

isSharedIndex
```
public boolean isSharedIndex()
```
Description copied from interface: SearchPlatformConfig

Indicate whether indices are shared between nodes in cluster

Specified by:

isSharedIndex in interface SearchPlatformConfig

Returns:

true is indices are shared otherwise false