Class: Files::ExavaultApiRequestLog

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/exavault_api_request_log.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ ExavaultApiRequestLog

Returns a new instance of ExavaultApiRequestLog.



7
8
9
10
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



87
88
89
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 87

def self.all(params = {}, options = {})
  list(params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
action - string
page - int64
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `request_ip`, `request_method` or `success`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.
filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `request_ip` and `request_method`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.

Raises:



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 74

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)

  List.new(ExavaultApiRequestLog, params) do
    Api.send_request("/exavault_api_request_logs", :get, params, options)
  end
end

Instance Method Details

#duration_ms ⇒ Object

int64 - Duration (in milliseconds)



63
64
65
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 63

def duration_ms
  @attributes[:duration_ms]
end

#endpoint ⇒ Object

string - Name of API Endpoint



18
19
20
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 18

def endpoint
  @attributes[:endpoint]
end

#error_message ⇒ Object

string - Error message, if applicable



43
44
45
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 43

def error_message
  @attributes[:error_message]
end

#error_type ⇒ Object

string - Error type, if applicable



38
39
40
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 38

def error_type
  @attributes[:error_type]
end

#request_ip ⇒ Object

string - IP of requesting client



28
29
30
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 28

def request_ip
  @attributes[:request_ip]
end

#request_method ⇒ Object

string - HTTP Method



33
34
35
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 33

def request_method
  @attributes[:request_method]
end

#response_code ⇒ Object

int64 - HTTP Response Code



53
54
55
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 53

def response_code
  @attributes[:response_code]
end

#success ⇒ Object

boolean - ‘false` if HTTP Response Code is 4xx or 5xx



58
59
60
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 58

def success
  @attributes[:success]
end

#timestamp ⇒ Object

date-time - Start Time of Action



13
14
15
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 13

def timestamp
  @attributes[:timestamp]
end

#user_agent ⇒ Object

string - User-Agent



48
49
50
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 48

def user_agent
  @attributes[:user_agent]
end

#version ⇒ Object

string - Exavault API Version



23
24
25
 
# File 'lib/files.com/models/exavault_api_request_log.rb', line 23

def version
  @attributes[:version]
end