Class: Files::AutomationRun

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of AutomationRun.



7
8
9
10
 
# File 'lib/files.com/models/automation_run.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/automation_run.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



73
74
75
 
# File 'lib/files.com/models/automation_run.rb', line 73

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

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - Automation Run ID.

Raises:



79
80
81
82
83
84
85
86
87
 
# File 'lib/files.com/models/automation_run.rb', line 79

def self.find(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  response, options = Api.send_request("/automation_runs/#{params[:id]}", :get, params, options)
  AutomationRun.new(response.data, options)
end

.get(id, params = {}, options = {}) ⇒ Object 



89
90
91
 
# File 'lib/files.com/models/automation_run.rb', line 89

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

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

Parameters:

user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `status`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `status`.
filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `status`.
filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `status`.
automation_id (required) - int64 - ID of the associated Automation.

Raises:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/files.com/models/automation_run.rb', line 54

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: automation_id must be an Integer") if params.dig(:automation_id) and !params.dig(:automation_id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: automation_id") unless params.dig(:automation_id)

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

Instance Method Details

#automation_id ⇒ Object

int64 - ID of the associated Automation.



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

def automation_id
  @attributes[:automation_id]
end

#completed_at ⇒ Object

date-time - Automation run completion/failure date/time.



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

def completed_at
  @attributes[:completed_at]
end

#created_at ⇒ Object

date-time - Automation run start date/time.



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

def created_at
  @attributes[:created_at]
end

#id ⇒ Object

int64 - ID.



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

def id
  @attributes[:id]
end

#status ⇒ Object

string - The success status of the AutomationRun. One of ‘running`, `success`, `partial_failure`, or `failure`.



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

def status
  @attributes[:status]
end

#status_messages_url ⇒ Object

string - Link to status messages log file.



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

def status_messages_url
  @attributes[:status_messages_url]
end