Class: DatadogAPIClient::V1::LogsListRequest

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

Overview

Object to send with the request to retrieve a list of logs from your Organization.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogsListRequest

Initializes the object

Parameters:

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

    attributes Model attributes in the form of hash



83
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
 
# File 'lib/datadog_api_client/v1/models/logs_list_request.rb', line 83

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::LogsListRequest` 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::LogsListRequest`. 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?(:'index')
    self.index = attributes[:'index']
  end

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

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

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

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

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

Instance Attribute Details

#index ⇒ Object

The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified.



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

def index
  @index
end

#limit ⇒ Object

Number of logs return in the response.



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

def limit
  @limit
end

#query ⇒ Object

The search query - following the log search syntax.



33
34
35
 
# File 'lib/datadog_api_client/v1/models/logs_list_request.rb', line 33

def query
  @query
end

#sort ⇒ Object

Returns the value of attribute sort.



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

def sort
  @sort
end

#start_at ⇒ Object

Hash identifier of the first log to return in the list, available in a log ‘id` attribute. This parameter is used for the pagination feature. Note: This parameter is ignored if the corresponding log is out of the scope of the specified time window.



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

def start_at
  @start_at
end

#time ⇒ Object

Returns the value of attribute time.



40
41
42
 
# File 'lib/datadog_api_client/v1/models/logs_list_request.rb', line 40

def time
  @time
end