com.datadog.api.client.v2.model

Class ObservabilityPipelineSplunkHecDestination

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineSplunkHecDestination

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

The splunk_hec destination forwards logs to Splunk using the HTTP Event Collector (HEC).

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_AUTO_EXTRACT_TIMESTAMP
static String	JSON_PROPERTY_BUFFER
static String	JSON_PROPERTY_ENCODING
static String	JSON_PROPERTY_ENDPOINT_TARGET
static String	JSON_PROPERTY_ENDPOINT_URL_KEY
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_INDEX
static String	JSON_PROPERTY_INDEXED_FIELDS
static String	JSON_PROPERTY_INPUTS
static String	JSON_PROPERTY_SOURCETYPE
static String	JSON_PROPERTY_TOKEN_KEY
static String	JSON_PROPERTY_TOKEN_STRATEGY
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineSplunkHecDestination()
ObservabilityPipelineSplunkHecDestination(String id, List<String> inputs, ObservabilityPipelineSplunkHecDestinationType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineSplunkHecDestination	addIndexedFieldsItem(String indexedFieldsItem)
ObservabilityPipelineSplunkHecDestination	addInputsItem(String inputsItem)
ObservabilityPipelineSplunkHecDestination	autoExtractTimestamp(Boolean autoExtractTimestamp)
ObservabilityPipelineSplunkHecDestination	buffer(ObservabilityPipelineBufferOptions buffer)
ObservabilityPipelineSplunkHecDestination	encoding(ObservabilityPipelineSplunkHecDestinationEncoding encoding)
ObservabilityPipelineSplunkHecDestination	endpointTarget(ObservabilityPipelineSplunkHecDestinationEndpointTarget endpointTarget)
ObservabilityPipelineSplunkHecDestination	endpointUrlKey(String endpointUrlKey)
boolean	equals(Object o) Return true if this ObservabilityPipelineSplunkHecDestination 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.
Boolean	getAutoExtractTimestamp() If true, Splunk tries to extract timestamps from incoming log events.
ObservabilityPipelineBufferOptions	getBuffer() Configuration for buffer settings on destination components.
ObservabilityPipelineSplunkHecDestinationEncoding	getEncoding() Encoding format for log events.
ObservabilityPipelineSplunkHecDestinationEndpointTarget	getEndpointTarget() The Splunk HEC endpoint to send events to.
String	getEndpointUrlKey() Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
String	getId() The unique identifier for this component.
String	getIndex() Optional name of the Splunk index where logs are written.
List<String>	getIndexedFields() List of log field names to send as indexed fields to Splunk HEC.
List<String>	getInputs() A list of component IDs whose output is used as the input for this component.
String	getSourcetype() The Splunk sourcetype to assign to log events.
String	getTokenKey() Name of the environment variable or secret that holds the Splunk HEC token.
ObservabilityPipelineSplunkHecDestinationTokenStrategy	getTokenStrategy() Controls how the Splunk HEC token is supplied.
ObservabilityPipelineSplunkHecDestinationType	getType() The destination type.
int	hashCode()
ObservabilityPipelineSplunkHecDestination	id(String id)
ObservabilityPipelineSplunkHecDestination	index(String index)
ObservabilityPipelineSplunkHecDestination	indexedFields(List<String> indexedFields)
ObservabilityPipelineSplunkHecDestination	inputs(List<String> inputs)
ObservabilityPipelineSplunkHecDestination	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setAutoExtractTimestamp(Boolean autoExtractTimestamp)
void	setBuffer(ObservabilityPipelineBufferOptions buffer)
void	setEncoding(ObservabilityPipelineSplunkHecDestinationEncoding encoding)
void	setEndpointTarget(ObservabilityPipelineSplunkHecDestinationEndpointTarget endpointTarget)
void	setEndpointUrlKey(String endpointUrlKey)
void	setId(String id)
void	setIndex(String index)
void	setIndexedFields(List<String> indexedFields)
void	setInputs(List<String> inputs)
void	setSourcetype(String sourcetype)
void	setTokenKey(String tokenKey)
void	setTokenStrategy(ObservabilityPipelineSplunkHecDestinationTokenStrategy tokenStrategy)
void	setType(ObservabilityPipelineSplunkHecDestinationType type)
ObservabilityPipelineSplunkHecDestination	sourcetype(String sourcetype)
ObservabilityPipelineSplunkHecDestination	tokenKey(String tokenKey)
ObservabilityPipelineSplunkHecDestination	tokenStrategy(ObservabilityPipelineSplunkHecDestinationTokenStrategy tokenStrategy)
String	toString()
ObservabilityPipelineSplunkHecDestination	type(ObservabilityPipelineSplunkHecDestinationType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_AUTO_EXTRACT_TIMESTAMP

public static final String JSON_PROPERTY_AUTO_EXTRACT_TIMESTAMP

See Also:

Constant Field Values

JSON_PROPERTY_BUFFER

public static final String JSON_PROPERTY_BUFFER

See Also:

Constant Field Values

JSON_PROPERTY_ENCODING

public static final String JSON_PROPERTY_ENCODING

See Also:

Constant Field Values

JSON_PROPERTY_ENDPOINT_TARGET

public static final String JSON_PROPERTY_ENDPOINT_TARGET

See Also:

Constant Field Values

JSON_PROPERTY_ENDPOINT_URL_KEY

public static final String JSON_PROPERTY_ENDPOINT_URL_KEY

See Also:

Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

Constant Field Values

JSON_PROPERTY_INDEX

public static final String JSON_PROPERTY_INDEX

See Also:

Constant Field Values

JSON_PROPERTY_INDEXED_FIELDS

public static final String JSON_PROPERTY_INDEXED_FIELDS

See Also:

Constant Field Values

JSON_PROPERTY_INPUTS

public static final String JSON_PROPERTY_INPUTS

See Also:

Constant Field Values

JSON_PROPERTY_SOURCETYPE

public static final String JSON_PROPERTY_SOURCETYPE

See Also:

Constant Field Values

JSON_PROPERTY_TOKEN_KEY

public static final String JSON_PROPERTY_TOKEN_KEY

See Also:

Constant Field Values

JSON_PROPERTY_TOKEN_STRATEGY

public static final String JSON_PROPERTY_TOKEN_STRATEGY

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineSplunkHecDestination

public ObservabilityPipelineSplunkHecDestination()

ObservabilityPipelineSplunkHecDestination

public ObservabilityPipelineSplunkHecDestination(String id,
                                                 List<String> inputs,
                                                 ObservabilityPipelineSplunkHecDestinationType type)

Method Detail

autoExtractTimestamp

public ObservabilityPipelineSplunkHecDestination autoExtractTimestamp(Boolean autoExtractTimestamp)

getAutoExtractTimestamp

@Nullable
public Boolean getAutoExtractTimestamp()

If true, Splunk tries to extract timestamps from incoming log events. If false, Splunk assigns the time the event was received. Only applies when endpoint_target is event; cannot be true when endpoint_target is raw.

Returns:

autoExtractTimestamp

setAutoExtractTimestamp

public void setAutoExtractTimestamp(Boolean autoExtractTimestamp)

buffer

public ObservabilityPipelineSplunkHecDestination buffer(ObservabilityPipelineBufferOptions buffer)

getBuffer

@Nullable
public ObservabilityPipelineBufferOptions getBuffer()

Configuration for buffer settings on destination components.

Returns:

buffer

setBuffer

public void setBuffer(ObservabilityPipelineBufferOptions buffer)

encoding

public ObservabilityPipelineSplunkHecDestination encoding(ObservabilityPipelineSplunkHecDestinationEncoding encoding)

getEncoding

@Nullable
public ObservabilityPipelineSplunkHecDestinationEncoding getEncoding()

Encoding format for log events.

Returns:

encoding

setEncoding

public void setEncoding(ObservabilityPipelineSplunkHecDestinationEncoding encoding)

endpointTarget

public ObservabilityPipelineSplunkHecDestination endpointTarget(ObservabilityPipelineSplunkHecDestinationEndpointTarget endpointTarget)

getEndpointTarget

@Nullable
public ObservabilityPipelineSplunkHecDestinationEndpointTarget getEndpointTarget()

The Splunk HEC endpoint to send events to. Use event to send structured events to the /event endpoint, or raw to send the raw message to the /raw endpoint.

Returns:

endpointTarget

setEndpointTarget

public void setEndpointTarget(ObservabilityPipelineSplunkHecDestinationEndpointTarget endpointTarget)

endpointUrlKey

public ObservabilityPipelineSplunkHecDestination endpointUrlKey(String endpointUrlKey)

getEndpointUrlKey

@Nullable
public String getEndpointUrlKey()

Name of the environment variable or secret that holds the Splunk HEC endpoint URL.

Returns:

endpointUrlKey

setEndpointUrlKey

public void setEndpointUrlKey(String endpointUrlKey)

id

public ObservabilityPipelineSplunkHecDestination 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)

index

public ObservabilityPipelineSplunkHecDestination index(String index)

getIndex

@Nullable
public String getIndex()

Optional name of the Splunk index where logs are written.

Returns:

index

setIndex

public void setIndex(String index)

indexedFields

public ObservabilityPipelineSplunkHecDestination indexedFields(List<String> indexedFields)

addIndexedFieldsItem

public ObservabilityPipelineSplunkHecDestination addIndexedFieldsItem(String indexedFieldsItem)

getIndexedFields

@Nullable
public List<String> getIndexedFields()

List of log field names to send as indexed fields to Splunk HEC. Available only when encoding is json.

Returns:

indexedFields

setIndexedFields

public void setIndexedFields(List<String> indexedFields)

inputs

public ObservabilityPipelineSplunkHecDestination inputs(List<String> inputs)

addInputsItem

public ObservabilityPipelineSplunkHecDestination addInputsItem(String inputsItem)

getInputs

public List<String> getInputs()

A list of component IDs whose output is used as the input for this component.

Returns:

inputs

setInputs

public void setInputs(List<String> inputs)

sourcetype

public ObservabilityPipelineSplunkHecDestination sourcetype(String sourcetype)

getSourcetype

@Nullable
public String getSourcetype()

The Splunk sourcetype to assign to log events.

Returns:

sourcetype

setSourcetype

public void setSourcetype(String sourcetype)

tokenKey

public ObservabilityPipelineSplunkHecDestination tokenKey(String tokenKey)

getTokenKey

@Nullable
public String getTokenKey()

Name of the environment variable or secret that holds the Splunk HEC token.

Returns:

tokenKey

setTokenKey

public void setTokenKey(String tokenKey)

tokenStrategy

public ObservabilityPipelineSplunkHecDestination tokenStrategy(ObservabilityPipelineSplunkHecDestinationTokenStrategy tokenStrategy)

getTokenStrategy

@Nullable
public ObservabilityPipelineSplunkHecDestinationTokenStrategy getTokenStrategy()

Controls how the Splunk HEC token is supplied. Use custom to provide a token with token_key, or from_source to forward the token received from an upstream Splunk HEC source.

Returns:

tokenStrategy

setTokenStrategy

public void setTokenStrategy(ObservabilityPipelineSplunkHecDestinationTokenStrategy tokenStrategy)

type

public ObservabilityPipelineSplunkHecDestination type(ObservabilityPipelineSplunkHecDestinationType type)

getType

public ObservabilityPipelineSplunkHecDestinationType getType()

The destination type. Always splunk_hec.

Returns:

type

setType

public void setType(ObservabilityPipelineSplunkHecDestinationType type)

putAdditionalProperty

public ObservabilityPipelineSplunkHecDestination 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:

ObservabilityPipelineSplunkHecDestination

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 ObservabilityPipelineSplunkHecDestination 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