Package org.apache.camel.builder.endpoint.dsl

Interface SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

SplunkHECEndpointBuilderFactory

public static interface SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the Splunk HEC component.

Method Summary

Modifier and Type	Method	Description
default SplunkHECEndpointBuilderFactory.AdvancedSplunkHECEndpointBuilder	advanced()
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	bodyOnly(boolean bodyOnly)	Send only the message body.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	bodyOnly(String bodyOnly)	Send only the message body.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	headersOnly(boolean headersOnly)	Send only message headers.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	headersOnly(String headersOnly)	Send only message headers.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	host(String host)	Splunk host field of the event message.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	https(boolean https)	Contact HEC over https.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	https(String https)	Contact HEC over https.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	index(String index)	Splunk index to write to.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	skipTlsVerify(boolean skipTlsVerify)	Splunk HEC TLS verification.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	skipTlsVerify(String skipTlsVerify)	Splunk HEC TLS verification.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	source(String source)	Splunk source argument.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	sourceType(String sourceType)	Splunk sourcetype argument.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	splunkEndpoint(String splunkEndpoint)	Splunk endpoint Defaults to /services/collector/event To write RAW data like JSON use /services/collector/raw For a list of all endpoints refer to splunk documentation (HTTP Event Collector REST API endpoints) Example for Spunk 8.2.x: https://docs.splunk.com/Documentation/SplunkCloud/8.2.2203/Data/HECRESTendpoints To extract timestamps in Splunk8.0 /services/collector/eventauto_extract_timestamp=true Remember to utilize RAW{} for questionmarks or slashes in parameters.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	sslContextParameters(String sslContextParameters)	SSL configuration.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)	SSL configuration.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	time(Long time)	Time this even occurred.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	time(String time)	Time this even occurred.
default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder	token(String token)	Splunk HEC token (this is the token created for HEC and not the user's token).

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Details

advanced

default SplunkHECEndpointBuilderFactory.AdvancedSplunkHECEndpointBuilder advanced()

bodyOnly

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder bodyOnly(boolean bodyOnly)

Send only the message body. The option is a: boolean type. Default: false Group: producer

Parameters:

bodyOnly - the value to set

Returns:

the dsl builder

bodyOnly

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder bodyOnly(String bodyOnly)

Send only the message body. The option will be converted to a boolean type. Default: false Group: producer

Parameters:

bodyOnly - the value to set

Returns:

the dsl builder

headersOnly

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder headersOnly(boolean headersOnly)

Send only message headers. The option is a: boolean type. Default: false Group: producer

Parameters:

headersOnly - the value to set

Returns:

the dsl builder

headersOnly

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder headersOnly(String headersOnly)

Send only message headers. The option will be converted to a boolean type. Default: false Group: producer

Parameters:

headersOnly - the value to set

Returns:

the dsl builder

host

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder host(String host)

Splunk host field of the event message. This is not the Splunk host to connect to. The option is a: java.lang.String type. Group: producer

Parameters:

host - the value to set

Returns:

the dsl builder

index

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder index(String index)

Splunk index to write to. The option is a: java.lang.String type. Default: camel Group: producer

Parameters:

index - the value to set

Returns:

the dsl builder

source

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder source(String source)

Splunk source argument. The option is a: java.lang.String type. Default: camel Group: producer

Parameters:

source - the value to set

Returns:

the dsl builder

sourceType

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder sourceType(String sourceType)

Splunk sourcetype argument. The option is a: java.lang.String type. Default: camel Group: producer

Parameters:

sourceType - the value to set

Returns:

the dsl builder

splunkEndpoint

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder splunkEndpoint(String splunkEndpoint)

Splunk endpoint Defaults to /services/collector/event To write RAW data like JSON use /services/collector/raw For a list of all endpoints refer to splunk documentation (HTTP Event Collector REST API endpoints) Example for Spunk 8.2.x: https://docs.splunk.com/Documentation/SplunkCloud/8.2.2203/Data/HECRESTendpoints To extract timestamps in Splunk8.0 /services/collector/eventauto_extract_timestamp=true Remember to utilize RAW{} for questionmarks or slashes in parameters. The option is a: java.lang.String type. Default: /services/collector/event Group: producer

Parameters:

splunkEndpoint - the value to set

Returns:

the dsl builder

sslContextParameters

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)

SSL configuration. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: producer

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

sslContextParameters

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder sslContextParameters(String sslContextParameters)

SSL configuration. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: producer

Parameters:

sslContextParameters - the value to set

Returns:

the dsl builder

time

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder time(Long time)

Time this even occurred. By default, the time will be when this event hits the splunk server. The option is a: java.lang.Long type. Group: producer

Parameters:

time - the value to set

Returns:

the dsl builder

time

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder time(String time)

Time this even occurred. By default, the time will be when this event hits the splunk server. The option will be converted to a java.lang.Long type. Group: producer

Parameters:

time - the value to set

Returns:

the dsl builder

https

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder https(boolean https)

Contact HEC over https. The option is a: boolean type. Default: true Group: security

Parameters:

https - the value to set

Returns:

the dsl builder

https

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder https(String https)

Contact HEC over https. The option will be converted to a boolean type. Default: true Group: security

Parameters:

https - the value to set

Returns:

the dsl builder

skipTlsVerify

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder skipTlsVerify(boolean skipTlsVerify)

Splunk HEC TLS verification. The option is a: boolean type. Default: false Group: security

Parameters:

skipTlsVerify - the value to set

Returns:

the dsl builder

skipTlsVerify

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder skipTlsVerify(String skipTlsVerify)

Splunk HEC TLS verification. The option will be converted to a boolean type. Default: false Group: security

Parameters:

skipTlsVerify - the value to set

Returns:

the dsl builder

token

default SplunkHECEndpointBuilderFactory.SplunkHECEndpointBuilder token(String token)

Splunk HEC token (this is the token created for HEC and not the user's token). The option is a: java.lang.String type. Required: true Group: security

Parameters:

token - the value to set

Returns:

the dsl builder