com.datadog.api.client.v2.model

Class ObservabilityPipelineSplunkHecMetricsDestination

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineSplunkHecMetricsDestination

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

The splunk_hec_metrics destination forwards metrics to Splunk using the HTTP Event Collector (HEC).

Supported pipeline types: metrics

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_BUFFER
static String	JSON_PROPERTY_COMPRESSION
static String	JSON_PROPERTY_DEFAULT_NAMESPACE
static String	JSON_PROPERTY_ENDPOINT_URL_KEY
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_INDEX
static String	JSON_PROPERTY_INPUTS
static String	JSON_PROPERTY_SOURCE
static String	JSON_PROPERTY_SOURCETYPE
static String	JSON_PROPERTY_TLS
static String	JSON_PROPERTY_TOKEN_KEY
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineSplunkHecMetricsDestination()
ObservabilityPipelineSplunkHecMetricsDestination(String id, List<String> inputs, ObservabilityPipelineSplunkHecMetricsDestinationType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineSplunkHecMetricsDestination	addInputsItem(String inputsItem)
ObservabilityPipelineSplunkHecMetricsDestination	buffer(ObservabilityPipelineBufferOptions buffer)
ObservabilityPipelineSplunkHecMetricsDestination	compression(ObservabilityPipelineSplunkHecMetricsDestinationCompression compression)
ObservabilityPipelineSplunkHecMetricsDestination	defaultNamespace(String defaultNamespace)
ObservabilityPipelineSplunkHecMetricsDestination	endpointUrlKey(String endpointUrlKey)
boolean	equals(Object o) Return true if this ObservabilityPipelineSplunkHecMetricsDestination 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.
ObservabilityPipelineBufferOptions	getBuffer() Configuration for buffer settings on destination components.
ObservabilityPipelineSplunkHecMetricsDestinationCompression	getCompression() Compression algorithm applied when sending metrics to Splunk HEC.
String	getDefaultNamespace() Optional default namespace for metrics sent to Splunk HEC.
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 metrics are written.
List<String>	getInputs() A list of component IDs whose output is used as the input for this component.
String	getSource() The Splunk source field value for metric events.
String	getSourcetype() The Splunk sourcetype to assign to metric events.
ObservabilityPipelineTls	getTls() Configuration for enabling TLS encryption between the pipeline component and external services.
String	getTokenKey() Name of the environment variable or secret that holds the Splunk HEC token.
ObservabilityPipelineSplunkHecMetricsDestinationType	getType() The destination type.
int	hashCode()
ObservabilityPipelineSplunkHecMetricsDestination	id(String id)
ObservabilityPipelineSplunkHecMetricsDestination	index(String index)
ObservabilityPipelineSplunkHecMetricsDestination	inputs(List<String> inputs)
ObservabilityPipelineSplunkHecMetricsDestination	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setBuffer(ObservabilityPipelineBufferOptions buffer)
void	setCompression(ObservabilityPipelineSplunkHecMetricsDestinationCompression compression)
void	setDefaultNamespace(String defaultNamespace)
void	setEndpointUrlKey(String endpointUrlKey)
void	setId(String id)
void	setIndex(String index)
void	setInputs(List<String> inputs)
void	setSource(String source)
void	setSourcetype(String sourcetype)
void	setTls(ObservabilityPipelineTls tls)
void	setTokenKey(String tokenKey)
void	setType(ObservabilityPipelineSplunkHecMetricsDestinationType type)
ObservabilityPipelineSplunkHecMetricsDestination	source(String source)
ObservabilityPipelineSplunkHecMetricsDestination	sourcetype(String sourcetype)
ObservabilityPipelineSplunkHecMetricsDestination	tls(ObservabilityPipelineTls tls)
ObservabilityPipelineSplunkHecMetricsDestination	tokenKey(String tokenKey)
String	toString()
ObservabilityPipelineSplunkHecMetricsDestination	type(ObservabilityPipelineSplunkHecMetricsDestinationType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_BUFFER

public static final String JSON_PROPERTY_BUFFER

See Also:

Constant Field Values

JSON_PROPERTY_COMPRESSION

public static final String JSON_PROPERTY_COMPRESSION

See Also:

Constant Field Values

JSON_PROPERTY_DEFAULT_NAMESPACE

public static final String JSON_PROPERTY_DEFAULT_NAMESPACE

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_INPUTS

public static final String JSON_PROPERTY_INPUTS

See Also:

Constant Field Values

JSON_PROPERTY_SOURCE

public static final String JSON_PROPERTY_SOURCE

See Also:

Constant Field Values

JSON_PROPERTY_SOURCETYPE

public static final String JSON_PROPERTY_SOURCETYPE

See Also:

Constant Field Values

JSON_PROPERTY_TLS

public static final String JSON_PROPERTY_TLS

See Also:

Constant Field Values

JSON_PROPERTY_TOKEN_KEY

public static final String JSON_PROPERTY_TOKEN_KEY

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineSplunkHecMetricsDestination

public ObservabilityPipelineSplunkHecMetricsDestination()

ObservabilityPipelineSplunkHecMetricsDestination

public ObservabilityPipelineSplunkHecMetricsDestination(String id,
                                                        List<String> inputs,
                                                        ObservabilityPipelineSplunkHecMetricsDestinationType type)

Method Detail

buffer

public ObservabilityPipelineSplunkHecMetricsDestination buffer(ObservabilityPipelineBufferOptions buffer)

getBuffer

@Nullable
public ObservabilityPipelineBufferOptions getBuffer()

Configuration for buffer settings on destination components.

Returns:

buffer

setBuffer

public void setBuffer(ObservabilityPipelineBufferOptions buffer)

compression

public ObservabilityPipelineSplunkHecMetricsDestination compression(ObservabilityPipelineSplunkHecMetricsDestinationCompression compression)

getCompression

@Nullable
public ObservabilityPipelineSplunkHecMetricsDestinationCompression getCompression()

Compression algorithm applied when sending metrics to Splunk HEC.

Returns:

compression

setCompression

public void setCompression(ObservabilityPipelineSplunkHecMetricsDestinationCompression compression)

defaultNamespace

public ObservabilityPipelineSplunkHecMetricsDestination defaultNamespace(String defaultNamespace)

getDefaultNamespace

@Nullable
public String getDefaultNamespace()

Optional default namespace for metrics sent to Splunk HEC.

Returns:

defaultNamespace

setDefaultNamespace

public void setDefaultNamespace(String defaultNamespace)

endpointUrlKey

public ObservabilityPipelineSplunkHecMetricsDestination 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 ObservabilityPipelineSplunkHecMetricsDestination 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 ObservabilityPipelineSplunkHecMetricsDestination index(String index)

getIndex

@Nullable
public String getIndex()

Optional name of the Splunk index where metrics are written.

Returns:

index

setIndex

public void setIndex(String index)

inputs

public ObservabilityPipelineSplunkHecMetricsDestination inputs(List<String> inputs)

addInputsItem

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

source

public ObservabilityPipelineSplunkHecMetricsDestination source(String source)

getSource

@Nullable
public String getSource()

The Splunk source field value for metric events.

Returns:

source

setSource

public void setSource(String source)

sourcetype

public ObservabilityPipelineSplunkHecMetricsDestination sourcetype(String sourcetype)

getSourcetype

@Nullable
public String getSourcetype()

The Splunk sourcetype to assign to metric events.

Returns:

sourcetype

setSourcetype

public void setSourcetype(String sourcetype)

tls

public ObservabilityPipelineSplunkHecMetricsDestination tls(ObservabilityPipelineTls tls)

getTls

@Nullable
public ObservabilityPipelineTls getTls()

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

Returns:

tls

setTls

public void setTls(ObservabilityPipelineTls tls)

tokenKey

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

type

public ObservabilityPipelineSplunkHecMetricsDestination type(ObservabilityPipelineSplunkHecMetricsDestinationType type)

getType

public ObservabilityPipelineSplunkHecMetricsDestinationType getType()

The destination type. Always splunk_hec_metrics.

Returns:

type

setType

public void setType(ObservabilityPipelineSplunkHecMetricsDestinationType type)

putAdditionalProperty

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

ObservabilityPipelineSplunkHecMetricsDestination

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