Class: DatadogAPIClient::V2::ObservabilityPipelineKafkaDestination

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb

Overview

The kafka destination sends logs to Apache Kafka topics.

Supported pipeline types: logs

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



71
72
73
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 71

def additional_properties
  @additional_properties
end

#compression ⇒ Object

Compression codec for Kafka messages.



27
28
29
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 27

def compression
  @compression
end

#encoding ⇒ Object

Encoding format for log events.



30
31
32
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 30

def encoding
  @encoding
end

#headers_key ⇒ Object

The field name to use for Kafka message headers.



33
34
35
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 33

def headers_key
  @headers_key
end

#id ⇒ Object

The unique identifier for this component.



36
37
38
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 36

def id
  @id
end

#inputs ⇒ Object

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



39
40
41
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 39

def inputs
  @inputs
end

#key_field ⇒ Object

The field name to use as the Kafka message key.



42
43
44
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 42

def key_field
  @key_field
end

#librdkafka_options ⇒ Object

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



45
46
47
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 45

def librdkafka_options
  @librdkafka_options
end

#message_timeout_ms ⇒ Object

Maximum time in milliseconds to wait for message delivery confirmation.



48
49
50
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 48

def message_timeout_ms
  @message_timeout_ms
end

#rate_limit_duration_secs ⇒ Object

Duration in seconds for the rate limit window.



51
52
53
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 51

def rate_limit_duration_secs
  @rate_limit_duration_secs
end

#rate_limit_num ⇒ Object

Maximum number of messages allowed per rate limit duration.



54
55
56
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 54

def rate_limit_num
  @rate_limit_num
end

#sasl ⇒ Object

Specifies the SASL mechanism for authenticating with a Kafka cluster.



57
58
59
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 57

def sasl
  @sasl
end

#socket_timeout_ms ⇒ Object

Socket timeout in milliseconds for network requests.



60
61
62
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 60

def socket_timeout_ms
  @socket_timeout_ms
end

#tls ⇒ Object

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



63
64
65
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 63

def tls
  @tls
end

#topic ⇒ Object

The Kafka topic name to publish logs to.



66
67
68
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 66

def topic
  @topic
end

#type ⇒ Object

The destination type. The value should always be kafka.



69
70
71
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_kafka_destination.rb', line 69

def type
  @type
end