Class: DatadogAPIClient::V2::ObservabilityPipelineOpenSearchDestination

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

Overview

The opensearch destination writes logs to an OpenSearch cluster.

**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.



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

def additional_properties
  @additional_properties
end

#auth ⇒ Object

Authentication settings for the Elasticsearch destination. When strategy is basic, use username_key and password_key to reference credentials stored in environment variables or secrets.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_open_search_destination.rb', line 28

def auth
  @auth
end

#buffer ⇒ Object

Configuration for buffer settings on destination components.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_open_search_destination.rb', line 31

def buffer
  @buffer
end

#bulk_index ⇒ Object

The index to write logs to.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_open_search_destination.rb', line 34

def bulk_index
  @bulk_index
end

#data_stream ⇒ Object

Configuration options for writing to OpenSearch Data Streams instead of a fixed index.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_open_search_destination.rb', line 37

def data_stream
  @data_stream
end

#endpoint_url_key ⇒ Object

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



40
41
42
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_open_search_destination.rb', line 40

def endpoint_url_key
  @endpoint_url_key
end

#id ⇒ Object

The unique identifier for this component.



43
44
45
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_open_search_destination.rb', line 43

def id
  @id
end

#inputs ⇒ Object

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



46
47
48
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_open_search_destination.rb', line 46

def inputs
  @inputs
end

#type ⇒ Object

The destination type. The value should always be opensearch.



49
50
51
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_open_search_destination.rb', line 49

def type
  @type
end