Package io.camunda.zeebe.exporter.opensearch

Class OpensearchExporterConfiguration

java.lang.Object

io.camunda.zeebe.exporter.opensearch.OpensearchExporterConfiguration

public class OpensearchExporterConfiguration
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpensearchExporterConfiguration.AuthenticationConfiguration
static class	OpensearchExporterConfiguration.AwsConfiguration
static class	OpensearchExporterConfiguration.BulkConfiguration
static class	OpensearchExporterConfiguration.IndexConfiguration
static class	OpensearchExporterConfiguration.RetentionConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
final OpensearchExporterConfiguration.AwsConfiguration	aws
final OpensearchExporterConfiguration.BulkConfiguration	bulk
final OpensearchExporterConfiguration.IndexConfiguration	index
final List<io.camunda.search.connect.plugin.PluginConfiguration>	interceptorPlugins
int	requestTimeoutMs	The request timeout for the opensearch client.
final OpensearchExporterConfiguration.RetentionConfiguration	retention
String	url	Comma-separated Opensearch http urls

Constructor Summary

Constructors

Constructor	Description
OpensearchExporterConfiguration()

Method Summary

Modifier and Type	Method	Description
OpensearchExporterConfiguration.AuthenticationConfiguration	getAuthentication()
List<io.camunda.search.connect.plugin.PluginConfiguration>	getInterceptorPlugins()
boolean	getIsIncludeEnabledRecords()
boolean	hasAuthenticationPresent()
void	setIncludeEnabledRecords(boolean includeEnabledRecords)
boolean	shouldIndexRecord(io.camunda.zeebe.protocol.record.Record<?> record)
boolean	shouldIndexRecordType(io.camunda.zeebe.protocol.record.RecordType recordType)
boolean	shouldIndexRequiredValueType(io.camunda.zeebe.protocol.record.ValueType valueType)	Not all value records are required to be exported from 8.8 onward.
boolean	shouldIndexValueType(io.camunda.zeebe.protocol.record.ValueType valueType)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

url

public String url

Comma-separated Opensearch http urls

requestTimeoutMs

public int requestTimeoutMs

The request timeout for the opensearch client. The timeout unit is milliseconds.

index

public final OpensearchExporterConfiguration.IndexConfiguration index

bulk

public final OpensearchExporterConfiguration.BulkConfiguration bulk

aws

public final OpensearchExporterConfiguration.AwsConfiguration aws

retention

public final OpensearchExporterConfiguration.RetentionConfiguration retention

interceptorPlugins

public final List<io.camunda.search.connect.plugin.PluginConfiguration> interceptorPlugins

Constructor Details

OpensearchExporterConfiguration

public OpensearchExporterConfiguration()

Method Details

hasAuthenticationPresent

public boolean hasAuthenticationPresent()

getAuthentication

public OpensearchExporterConfiguration.AuthenticationConfiguration getAuthentication()

getInterceptorPlugins

public List<io.camunda.search.connect.plugin.PluginConfiguration> getInterceptorPlugins()

toString

public String toString()

Overrides:

toString in class Object

shouldIndexRecord

public boolean shouldIndexRecord(io.camunda.zeebe.protocol.record.Record<?> record)

shouldIndexValueType

public boolean shouldIndexValueType(io.camunda.zeebe.protocol.record.ValueType valueType)

shouldIndexRequiredValueType

public boolean shouldIndexRequiredValueType(io.camunda.zeebe.protocol.record.ValueType valueType)

Not all value records are required to be exported from 8.8 onward. The following included records are required by Optimize and Zeebe-Analytics so they must continue to be exported by the OpensearchExporter:

Parameters:

valueType - the value type of the record

Returns:

true if the record should be indexed, false otherwise

shouldIndexRecordType

public boolean shouldIndexRecordType(io.camunda.zeebe.protocol.record.RecordType recordType)

getIsIncludeEnabledRecords

public boolean getIsIncludeEnabledRecords()

setIncludeEnabledRecords

public void setIncludeEnabledRecords(boolean includeEnabledRecords)