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 



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

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

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

Parameters:

id (required) - int64 - Automation Run ID.

Raises:



69
70
71
72
73
74
75
76
77
 
# File 'lib/files.com/models/automation_run.rb', line 69

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

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

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



79
80
81
 
# File 'lib/files.com/models/automation_run.rb', line 79

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.  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).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation_id]=desc`). Valid fields are `automation_id`, `created_at` or `status`.
automation_id (required) - int64 - ID of the associated Automation.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ automation_id, status ]`.

Raises:



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/files.com/models/automation_run.rb', line 49

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
  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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: automation_id must be an Integer") if params[:automation_id] and !params[:automation_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
  raise MissingParameterError.new("Parameter missing: automation_id") unless params[: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