Class: DatadogAPIClient::V2::CustomDestinationResponseForwardDestinationElasticsearch

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

Overview

The Elasticsearch destination.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#auth ⇒ Object

Basic access authentication.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_elasticsearch.rb', line 25

def auth
  @auth
end

#endpoint ⇒ Object

The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.



29
30
31
 
# File 'lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_elasticsearch.rb', line 29

def endpoint
  @endpoint
end

#index_name ⇒ Object

Name of the Elasticsearch index (must follow Elasticsearch's criteria).



32
33
34
 
# File 'lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_elasticsearch.rb', line 32

def index_name
  @index_name
end

#index_rotation ⇒ Object

Date pattern with US locale and UTC timezone to be appended to the index name after adding - (that is, ${index_name}-${indexPattern}). You can customize the index rotation naming pattern by choosing one of these options:

  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)

If this field is missing or is blank, it means that the index name will always be the same (that is, no rotation).



44
45
46
 
# File 'lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_elasticsearch.rb', line 44

def index_rotation
  @index_rotation
end

#type ⇒ Object

Type of the Elasticsearch destination.



47
48
49
 
# File 'lib/datadog_api_client/v2/models/custom_destination_response_forward_destination_elasticsearch.rb', line 47

def type
  @type
end