com.datadog.api.client.v2.model

Class ObservabilityPipelineKafkaDestination

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineKafkaDestination

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

The kafka destination sends logs to Apache Kafka topics.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_BOOTSTRAP_SERVERS_KEY
static String	JSON_PROPERTY_BUFFER
static String	JSON_PROPERTY_COMPRESSION
static String	JSON_PROPERTY_ENCODING
static String	JSON_PROPERTY_HEADERS_KEY
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_INPUTS
static String	JSON_PROPERTY_KEY_FIELD
static String	JSON_PROPERTY_LIBRDKAFKA_OPTIONS
static String	JSON_PROPERTY_MESSAGE_TIMEOUT_MS
static String	JSON_PROPERTY_RATE_LIMIT_DURATION_SECS
static String	JSON_PROPERTY_RATE_LIMIT_NUM
static String	JSON_PROPERTY_SASL
static String	JSON_PROPERTY_SOCKET_TIMEOUT_MS
static String	JSON_PROPERTY_TLS
static String	JSON_PROPERTY_TOPIC
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineKafkaDestination()
ObservabilityPipelineKafkaDestination(ObservabilityPipelineKafkaDestinationEncoding encoding, String id, List<String> inputs, String topic, ObservabilityPipelineKafkaDestinationType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineKafkaDestination	addInputsItem(String inputsItem)
ObservabilityPipelineKafkaDestination	addLibrdkafkaOptionsItem(ObservabilityPipelineKafkaLibrdkafkaOption librdkafkaOptionsItem)
ObservabilityPipelineKafkaDestination	bootstrapServersKey(String bootstrapServersKey)
ObservabilityPipelineKafkaDestination	buffer(ObservabilityPipelineBufferOptions buffer)
ObservabilityPipelineKafkaDestination	compression(ObservabilityPipelineKafkaDestinationCompression compression)
ObservabilityPipelineKafkaDestination	encoding(ObservabilityPipelineKafkaDestinationEncoding encoding)
boolean	equals(Object o) Return true if this ObservabilityPipelineKafkaDestination 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	getBootstrapServersKey() Name of the environment variable or secret that holds the Kafka bootstrap servers list.
ObservabilityPipelineBufferOptions	getBuffer() Configuration for buffer settings on destination components.
ObservabilityPipelineKafkaDestinationCompression	getCompression() Compression codec for Kafka messages.
ObservabilityPipelineKafkaDestinationEncoding	getEncoding() Encoding format for log events.
String	getHeadersKey() The field name to use for Kafka message headers.
String	getId() The unique identifier for this component.
List<String>	getInputs() A list of component IDs whose output is used as the input for this component.
String	getKeyField() The field name to use as the Kafka message key.
List<ObservabilityPipelineKafkaLibrdkafkaOption>	getLibrdkafkaOptions() Optional list of advanced Kafka producer configuration options, defined as key-value pairs.
Long	getMessageTimeoutMs() Maximum time in milliseconds to wait for message delivery confirmation.
Long	getRateLimitDurationSecs() Duration in seconds for the rate limit window.
Long	getRateLimitNum() Maximum number of messages allowed per rate limit duration.
ObservabilityPipelineKafkaSasl	getSasl() Specifies the SASL mechanism for authenticating with a Kafka cluster.
Long	getSocketTimeoutMs() Socket timeout in milliseconds for network requests.
ObservabilityPipelineTls	getTls() Configuration for enabling TLS encryption between the pipeline component and external services.
String	getTopic() The Kafka topic name to publish logs to.
ObservabilityPipelineKafkaDestinationType	getType() The destination type.
int	hashCode()
ObservabilityPipelineKafkaDestination	headersKey(String headersKey)
ObservabilityPipelineKafkaDestination	id(String id)
ObservabilityPipelineKafkaDestination	inputs(List<String> inputs)
ObservabilityPipelineKafkaDestination	keyField(String keyField)
ObservabilityPipelineKafkaDestination	librdkafkaOptions(List<ObservabilityPipelineKafkaLibrdkafkaOption> librdkafkaOptions)
ObservabilityPipelineKafkaDestination	messageTimeoutMs(Long messageTimeoutMs)
ObservabilityPipelineKafkaDestination	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ObservabilityPipelineKafkaDestination	rateLimitDurationSecs(Long rateLimitDurationSecs)
ObservabilityPipelineKafkaDestination	rateLimitNum(Long rateLimitNum)
ObservabilityPipelineKafkaDestination	sasl(ObservabilityPipelineKafkaSasl sasl)
void	setBootstrapServersKey(String bootstrapServersKey)
void	setBuffer(ObservabilityPipelineBufferOptions buffer)
void	setCompression(ObservabilityPipelineKafkaDestinationCompression compression)
void	setEncoding(ObservabilityPipelineKafkaDestinationEncoding encoding)
void	setHeadersKey(String headersKey)
void	setId(String id)
void	setInputs(List<String> inputs)
void	setKeyField(String keyField)
void	setLibrdkafkaOptions(List<ObservabilityPipelineKafkaLibrdkafkaOption> librdkafkaOptions)
void	setMessageTimeoutMs(Long messageTimeoutMs)
void	setRateLimitDurationSecs(Long rateLimitDurationSecs)
void	setRateLimitNum(Long rateLimitNum)
void	setSasl(ObservabilityPipelineKafkaSasl sasl)
void	setSocketTimeoutMs(Long socketTimeoutMs)
void	setTls(ObservabilityPipelineTls tls)
void	setTopic(String topic)
void	setType(ObservabilityPipelineKafkaDestinationType type)
ObservabilityPipelineKafkaDestination	socketTimeoutMs(Long socketTimeoutMs)
ObservabilityPipelineKafkaDestination	tls(ObservabilityPipelineTls tls)
ObservabilityPipelineKafkaDestination	topic(String topic)
String	toString()
ObservabilityPipelineKafkaDestination	type(ObservabilityPipelineKafkaDestinationType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_BOOTSTRAP_SERVERS_KEY

public static final String JSON_PROPERTY_BOOTSTRAP_SERVERS_KEY

See Also:

Constant Field Values

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_ENCODING

public static final String JSON_PROPERTY_ENCODING

See Also:

Constant Field Values

JSON_PROPERTY_HEADERS_KEY

public static final String JSON_PROPERTY_HEADERS_KEY

See Also:

Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

Constant Field Values

JSON_PROPERTY_INPUTS

public static final String JSON_PROPERTY_INPUTS

See Also:

Constant Field Values

JSON_PROPERTY_KEY_FIELD

public static final String JSON_PROPERTY_KEY_FIELD

See Also:

Constant Field Values

JSON_PROPERTY_LIBRDKAFKA_OPTIONS

public static final String JSON_PROPERTY_LIBRDKAFKA_OPTIONS

See Also:

Constant Field Values

JSON_PROPERTY_MESSAGE_TIMEOUT_MS

public static final String JSON_PROPERTY_MESSAGE_TIMEOUT_MS

See Also:

Constant Field Values

JSON_PROPERTY_RATE_LIMIT_DURATION_SECS

public static final String JSON_PROPERTY_RATE_LIMIT_DURATION_SECS

See Also:

Constant Field Values

JSON_PROPERTY_RATE_LIMIT_NUM

public static final String JSON_PROPERTY_RATE_LIMIT_NUM

See Also:

Constant Field Values

JSON_PROPERTY_SASL

public static final String JSON_PROPERTY_SASL

See Also:

Constant Field Values

JSON_PROPERTY_SOCKET_TIMEOUT_MS

public static final String JSON_PROPERTY_SOCKET_TIMEOUT_MS

See Also:

Constant Field Values

JSON_PROPERTY_TLS

public static final String JSON_PROPERTY_TLS

See Also:

Constant Field Values

JSON_PROPERTY_TOPIC

public static final String JSON_PROPERTY_TOPIC

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineKafkaDestination

public ObservabilityPipelineKafkaDestination()

ObservabilityPipelineKafkaDestination

public ObservabilityPipelineKafkaDestination(ObservabilityPipelineKafkaDestinationEncoding encoding,
                                             String id,
                                             List<String> inputs,
                                             String topic,
                                             ObservabilityPipelineKafkaDestinationType type)

Method Detail

bootstrapServersKey

public ObservabilityPipelineKafkaDestination bootstrapServersKey(String bootstrapServersKey)

getBootstrapServersKey

@Nullable
public String getBootstrapServersKey()

Name of the environment variable or secret that holds the Kafka bootstrap servers list.

Returns:

bootstrapServersKey

setBootstrapServersKey

public void setBootstrapServersKey(String bootstrapServersKey)

buffer

public ObservabilityPipelineKafkaDestination 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 ObservabilityPipelineKafkaDestination compression(ObservabilityPipelineKafkaDestinationCompression compression)

getCompression

@Nullable
public ObservabilityPipelineKafkaDestinationCompression getCompression()

Compression codec for Kafka messages.

Returns:

compression

setCompression

public void setCompression(ObservabilityPipelineKafkaDestinationCompression compression)

encoding

public ObservabilityPipelineKafkaDestination encoding(ObservabilityPipelineKafkaDestinationEncoding encoding)

getEncoding

public ObservabilityPipelineKafkaDestinationEncoding getEncoding()

Encoding format for log events.

Returns:

encoding

setEncoding

public void setEncoding(ObservabilityPipelineKafkaDestinationEncoding encoding)

headersKey

public ObservabilityPipelineKafkaDestination headersKey(String headersKey)

getHeadersKey

@Nullable
public String getHeadersKey()

The field name to use for Kafka message headers.

Returns:

headersKey

setHeadersKey

public void setHeadersKey(String headersKey)

id

public ObservabilityPipelineKafkaDestination id(String id)

getId

public String getId()

The unique identifier for this component.

Returns:

id

setId

public void setId(String id)

inputs

public ObservabilityPipelineKafkaDestination inputs(List<String> inputs)

addInputsItem

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

keyField

public ObservabilityPipelineKafkaDestination keyField(String keyField)

getKeyField

@Nullable
public String getKeyField()

The field name to use as the Kafka message key.

Returns:

keyField

setKeyField

public void setKeyField(String keyField)

librdkafkaOptions

public ObservabilityPipelineKafkaDestination librdkafkaOptions(List<ObservabilityPipelineKafkaLibrdkafkaOption> librdkafkaOptions)

addLibrdkafkaOptionsItem

public ObservabilityPipelineKafkaDestination addLibrdkafkaOptionsItem(ObservabilityPipelineKafkaLibrdkafkaOption librdkafkaOptionsItem)

getLibrdkafkaOptions

@Nullable
public List<ObservabilityPipelineKafkaLibrdkafkaOption> getLibrdkafkaOptions()

Optional list of advanced Kafka producer configuration options, defined as key-value pairs.

Returns:

librdkafkaOptions

setLibrdkafkaOptions

public void setLibrdkafkaOptions(List<ObservabilityPipelineKafkaLibrdkafkaOption> librdkafkaOptions)

messageTimeoutMs

public ObservabilityPipelineKafkaDestination messageTimeoutMs(Long messageTimeoutMs)

getMessageTimeoutMs

@Nullable
public Long getMessageTimeoutMs()

Maximum time in milliseconds to wait for message delivery confirmation. minimum: 1

Returns:

messageTimeoutMs

setMessageTimeoutMs

public void setMessageTimeoutMs(Long messageTimeoutMs)

rateLimitDurationSecs

public ObservabilityPipelineKafkaDestination rateLimitDurationSecs(Long rateLimitDurationSecs)

getRateLimitDurationSecs

@Nullable
public Long getRateLimitDurationSecs()

Duration in seconds for the rate limit window. minimum: 1

Returns:

rateLimitDurationSecs

setRateLimitDurationSecs

public void setRateLimitDurationSecs(Long rateLimitDurationSecs)

rateLimitNum

public ObservabilityPipelineKafkaDestination rateLimitNum(Long rateLimitNum)

getRateLimitNum

@Nullable
public Long getRateLimitNum()

Maximum number of messages allowed per rate limit duration. minimum: 1

Returns:

rateLimitNum

setRateLimitNum

public void setRateLimitNum(Long rateLimitNum)

sasl

public ObservabilityPipelineKafkaDestination sasl(ObservabilityPipelineKafkaSasl sasl)

getSasl

@Nullable
public ObservabilityPipelineKafkaSasl getSasl()

Specifies the SASL mechanism for authenticating with a Kafka cluster.

Returns:

sasl

setSasl

public void setSasl(ObservabilityPipelineKafkaSasl sasl)

socketTimeoutMs

public ObservabilityPipelineKafkaDestination socketTimeoutMs(Long socketTimeoutMs)

getSocketTimeoutMs

@Nullable
public Long getSocketTimeoutMs()

Socket timeout in milliseconds for network requests. minimum: 10 maximum: 300000

Returns:

socketTimeoutMs

setSocketTimeoutMs

public void setSocketTimeoutMs(Long socketTimeoutMs)

tls

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

topic

public ObservabilityPipelineKafkaDestination topic(String topic)

getTopic

public String getTopic()

The Kafka topic name to publish logs to.

Returns:

topic

setTopic

public void setTopic(String topic)

type

public ObservabilityPipelineKafkaDestination type(ObservabilityPipelineKafkaDestinationType type)

getType

public ObservabilityPipelineKafkaDestinationType getType()

The destination type. The value should always be kafka.

Returns:

type

setType

public void setType(ObservabilityPipelineKafkaDestinationType type)

putAdditionalProperty

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

ObservabilityPipelineKafkaDestination

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