Class: DatadogAPIClient::V1::LogsIndex

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/models/logs_index.rb

Overview

Object describing a Datadog Log index.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogsIndex

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    attributes Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/datadog_api_client/v1/models/logs_index.rb', line 84

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::LogsIndex` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::LogsIndex`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'daily_limit')
    self.daily_limit = attributes[:'daily_limit']
  end

  if attributes.key?(:'exclusion_filters')
    if (value = attributes[:'exclusion_filters']).is_a?(Array)
      self.exclusion_filters = value
    end
  end

  if attributes.key?(:'filter')
    self.filter = attributes[:'filter']
  end

  if attributes.key?(:'is_rate_limited')
    self.is_rate_limited = attributes[:'is_rate_limited']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'num_retention_days')
    self.num_retention_days = attributes[:'num_retention_days']
  end
end

Instance Attribute Details

#daily_limit ⇒ Object

The number of log events you can send in this index per day before you are rate-limited.



27
28
29
 
# File 'lib/datadog_api_client/v1/models/logs_index.rb', line 27

def daily_limit
  @daily_limit
end

#exclusion_filters ⇒ Object

An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored.



30
31
32
 
# File 'lib/datadog_api_client/v1/models/logs_index.rb', line 30

def exclusion_filters
  @exclusion_filters
end

#filter ⇒ Object

Returns the value of attribute filter.



32
33
34
 
# File 'lib/datadog_api_client/v1/models/logs_index.rb', line 32

def filter
  @filter
end

#is_rate_limited ⇒ Object

A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent. Rate limit is reset every-day at 2pm UTC.



35
36
37
 
# File 'lib/datadog_api_client/v1/models/logs_index.rb', line 35

def is_rate_limited
  @is_rate_limited
end

#name ⇒ Object

The name of the index.



38
39
40
 
# File 'lib/datadog_api_client/v1/models/logs_index.rb', line 38

def name
  @name
end

#num_retention_days ⇒ Object

The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization’s contract/subscriptions.



41
42
43
 
# File 'lib/datadog_api_client/v1/models/logs_index.rb', line 41

def num_retention_days
  @num_retention_days
end