Class: UU::AppLog::ApplicationLog::ApplicationLogGetRecordList

Inherits:
OS::REST::DTO
  • Object
show all
Includes:
TimeConversions
Defined in:
uu_applog-0.27.16/lib/uu/applog/application_log/application_log_get_record_list.rb

Overview

DTO containing criteria limiting and ordering list of application log records.

Constant Summary

Instance Attribute Summary (collapse)

Method Summary

Methods included from TimeConversions

#parse_time, #to_iso8601

Methods inherited from OS::REST::DTO

#initialize, #to_hash, #to_json

Constructor Details

This class inherits a constructor from UU::OS::REST::DTO

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class UU::OS::REST::DTO

Instance Attribute Details

- (Fixnum) limit

Count of application log records to return at once. When no limit is specified, 1000 records are returned at most. 1000 is also the largest limit number that can be specified.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum) 


36
37
38
 
# File 'uu_applog-0.27.16/lib/uu/applog/application_log/application_log_get_record_list.rb', line 36

def limit
  @limit
end

- (Fixnum) offset

Index of first item of the returned list. It is useful for return more than in limit defined records split in time. Offset means skip specified number of records and return next number of records until specified limit. When nil is set, the first record is determined automatically.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum) 


29
30
31
 
# File 'uu_applog-0.27.16/lib/uu/applog/application_log/application_log_get_record_list.rb', line 29

def offset
  @offset
end

- (String) time_from

Oldest time of time interval to get application log records for. When nil is set, time 24 hours ago is assumed.

Parameters:

  • (String, DateTime, Time)

Returns:

  • (String) 


16
17
18
 
# File 'uu_applog-0.27.16/lib/uu/applog/application_log/application_log_get_record_list.rb', line 16

def time_from
  @time_from
end

- (String) time_to

Newest time of time interval to get application log records for. When nil is set, current time is assumed.

Parameters:

  • (String, DateTime, Time)

Returns:

  • (String) 


22
23
24
 
# File 'uu_applog-0.27.16/lib/uu/applog/application_log/application_log_get_record_list.rb', line 22

def time_to
  @time_to
end