com.datadog.api.client.v2.model

Class ObservabilityPipelineSplunkHecSource

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineSplunkHecSource

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class ObservabilityPipelineSplunkHecSource
extends Object

The splunk_hec source implements the Splunk HTTP Event Collector (HEC) API.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ADDRESS_KEY
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_STORE_HEC_TOKEN
static String	JSON_PROPERTY_TLS
static String	JSON_PROPERTY_TYPE
static String	JSON_PROPERTY_VALID_TOKENS
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineSplunkHecSource()
ObservabilityPipelineSplunkHecSource(String id, ObservabilityPipelineSplunkHecSourceType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineSplunkHecSource	addressKey(String addressKey)
ObservabilityPipelineSplunkHecSource	addValidTokensItem(ObservabilityPipelineSplunkHecSourceValidToken validTokensItem)
boolean	equals(Object o) Return true if this ObservabilityPipelineSplunkHecSource object is equal to o.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
String	getAddressKey() Name of the environment variable or secret that holds the listen address for the HEC API.
String	getId() The unique identifier for this component.
Boolean	getStoreHecToken() When true, the Splunk HEC token from the incoming request is stored in the event metadata.
ObservabilityPipelineMtlsServerTls	getTls() Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
ObservabilityPipelineSplunkHecSourceType	getType() The source type.
List<ObservabilityPipelineSplunkHecSourceValidToken>	getValidTokens() A list of tokens that are accepted for authenticating incoming HEC requests.
int	hashCode()
ObservabilityPipelineSplunkHecSource	id(String id)
ObservabilityPipelineSplunkHecSource	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setAddressKey(String addressKey)
void	setId(String id)
void	setStoreHecToken(Boolean storeHecToken)
void	setTls(ObservabilityPipelineMtlsServerTls tls)
void	setType(ObservabilityPipelineSplunkHecSourceType type)
void	setValidTokens(List<ObservabilityPipelineSplunkHecSourceValidToken> validTokens)
ObservabilityPipelineSplunkHecSource	storeHecToken(Boolean storeHecToken)
ObservabilityPipelineSplunkHecSource	tls(ObservabilityPipelineMtlsServerTls tls)
String	toString()
ObservabilityPipelineSplunkHecSource	type(ObservabilityPipelineSplunkHecSourceType type)
ObservabilityPipelineSplunkHecSource	validTokens(List<ObservabilityPipelineSplunkHecSourceValidToken> validTokens)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ADDRESS_KEY

public static final String JSON_PROPERTY_ADDRESS_KEY

See Also:

Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

Constant Field Values

JSON_PROPERTY_STORE_HEC_TOKEN

public static final String JSON_PROPERTY_STORE_HEC_TOKEN

See Also:

Constant Field Values

JSON_PROPERTY_TLS

public static final String JSON_PROPERTY_TLS

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_VALID_TOKENS

public static final String JSON_PROPERTY_VALID_TOKENS

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineSplunkHecSource

public ObservabilityPipelineSplunkHecSource()

ObservabilityPipelineSplunkHecSource

public ObservabilityPipelineSplunkHecSource(String id,
                                            ObservabilityPipelineSplunkHecSourceType type)

Method Detail

addressKey

public ObservabilityPipelineSplunkHecSource addressKey(String addressKey)

getAddressKey

@Nullable
public String getAddressKey()

Name of the environment variable or secret that holds the listen address for the HEC API.

Returns:

addressKey

setAddressKey

public void setAddressKey(String addressKey)

id

public ObservabilityPipelineSplunkHecSource id(String id)

getId

public String getId()

The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the input to downstream components).

Returns:

id

setId

public void setId(String id)

storeHecToken

public ObservabilityPipelineSplunkHecSource storeHecToken(Boolean storeHecToken)

getStoreHecToken

@Nullable
public Boolean getStoreHecToken()

When true, the Splunk HEC token from the incoming request is stored in the event metadata. This allows downstream components to forward the token to other Splunk HEC destinations.

Returns:

storeHecToken

setStoreHecToken

public void setStoreHecToken(Boolean storeHecToken)

tls

public ObservabilityPipelineSplunkHecSource tls(ObservabilityPipelineMtlsServerTls tls)

getTls

@Nullable
public ObservabilityPipelineMtlsServerTls getTls()

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

Returns:

tls

setTls

public void setTls(ObservabilityPipelineMtlsServerTls tls)

type

public ObservabilityPipelineSplunkHecSource type(ObservabilityPipelineSplunkHecSourceType type)

getType

public ObservabilityPipelineSplunkHecSourceType getType()

The source type. Always splunk_hec.

Returns:

type

setType

public void setType(ObservabilityPipelineSplunkHecSourceType type)

validTokens

public ObservabilityPipelineSplunkHecSource validTokens(List<ObservabilityPipelineSplunkHecSourceValidToken> validTokens)

addValidTokensItem

public ObservabilityPipelineSplunkHecSource addValidTokensItem(ObservabilityPipelineSplunkHecSourceValidToken validTokensItem)

getValidTokens

@Nullable
public List<ObservabilityPipelineSplunkHecSourceValidToken> getValidTokens()

A list of tokens that are accepted for authenticating incoming HEC requests. When set, the source rejects any request whose HEC token does not match an enabled entry in this list.

Returns:

validTokens

setValidTokens

public void setValidTokens(List<ObservabilityPipelineSplunkHecSourceValidToken> validTokens)

putAdditionalProperty

public ObservabilityPipelineSplunkHecSource putAdditionalProperty(String key,
                                                                  Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

ObservabilityPipelineSplunkHecSource

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this ObservabilityPipelineSplunkHecSource object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object