Class: DatadogAPIClient::V1::LogsListRequest

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
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

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



47
48
49
 
# File 'lib/datadog_api_client/v1/models/logs_list_request.rb', line 47

def additional_properties
  @additional_properties
end

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



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

def index
  @index
end

#limit ⇒ Object

Number of logs return in the response.



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

def limit
  @limit
end

#query ⇒ Object

The search query - following the log search syntax.



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

def query
  @query
end

#sort ⇒ Object

Time-ascending ‘asc` or time-descending `desc` results.



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.



42
43
44
 
# File 'lib/datadog_api_client/v1/models/logs_list_request.rb', line 42

def start_at
  @start_at
end

#time ⇒ Object

Timeframe to retrieve the log from.



45
46
47
 
# File 'lib/datadog_api_client/v1/models/logs_list_request.rb', line 45

def time
  @time
end