Class: Files::ExternalEvent
- Inherits:
-
Object
- Object
- Files::ExternalEvent
- Defined in:
- lib/files.com/models/external_event.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
- .all(params = {}, options = {}) ⇒ Object
-
.create(params = {}, options = {}) ⇒ Object
Parameters: status (required) - string - Status of event.
-
.find(id, params = {}, options = {}) ⇒ Object
Parameters: id (required) - int64 - External Event ID.
- .get(id, params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
Instance Method Summary collapse
-
#body ⇒ Object
string - Event body.
- #body=(value) ⇒ Object
-
#body_url ⇒ Object
string - Link to log file.
- #body_url=(value) ⇒ Object
-
#bytes_synced ⇒ Object
int64 - For sync events, the total number of bytes synced.
- #bytes_synced=(value) ⇒ Object
-
#created_at ⇒ Object
date-time - External event create date/time.
-
#errored_files ⇒ Object
int64 - For sync events, the number of files that encountered errors.
- #errored_files=(value) ⇒ Object
-
#event_type ⇒ Object
string - Type of event being recorded.
- #event_type=(value) ⇒ Object
-
#folder_behavior_id ⇒ Object
int64 - Folder Behavior ID.
- #folder_behavior_id=(value) ⇒ Object
-
#id ⇒ Object
int64 - Event ID.
- #id=(value) ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ ExternalEvent
constructor
A new instance of ExternalEvent.
-
#remote_server_type ⇒ Object
string - Associated Remote Server type, if any.
- #remote_server_type=(value) ⇒ Object
- #save ⇒ Object
-
#status ⇒ Object
string - Status of event.
- #status=(value) ⇒ Object
-
#successful_files ⇒ Object
int64 - For sync events, the number of files handled successfully.
- #successful_files=(value) ⇒ Object
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ ExternalEvent
Returns a new instance of ExternalEvent.
7 8 9 10 |
# File 'lib/files.com/models/external_event.rb', line 7 def initialize(attributes = {}, = {}) @attributes = attributes || {} @options = || {} end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
5 6 7 |
# File 'lib/files.com/models/external_event.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/external_event.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
142 143 144 |
# File 'lib/files.com/models/external_event.rb', line 142 def self.all(params = {}, = {}) list(params, ) end |
.create(params = {}, options = {}) ⇒ Object
Parameters:
status (required) - string - Status of event.
body (required) - string - Event body
165 166 167 168 169 170 171 172 173 |
# File 'lib/files.com/models/external_event.rb', line 165 def self.create(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: status must be an String") if params.dig(:status) and !params.dig(:status).is_a?(String) raise InvalidParameterError.new("Bad parameter: body must be an String") if params.dig(:body) and !params.dig(:body).is_a?(String) raise MissingParameterError.new("Parameter missing: status") unless params.dig(:status) raise MissingParameterError.new("Parameter missing: body") unless params.dig(:body) response, = Api.send_request("/external_events", :post, params, ) ExternalEvent.new(response.data, ) end |
.find(id, params = {}, options = {}) ⇒ Object
Parameters:
id (required) - int64 - External Event ID.
148 149 150 151 152 153 154 155 156 |
# File 'lib/files.com/models/external_event.rb', line 148 def self.find(id, params = {}, = {}) 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, = Api.send_request("/external_events/#{params[:id]}", :get, params, ) ExternalEvent.new(response.data, ) end |
.get(id, params = {}, options = {}) ⇒ Object
158 159 160 |
# File 'lib/files.com/models/external_event.rb', line 158 def self.get(id, params = {}, = {}) find(id, params, ) end |
.list(params = {}, options = {}) ⇒ Object
Parameters:
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 the X-Files-Cursor-Next 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 `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/files.com/models/external_event.rb', line 126 def self.list(params = {}, = {}) 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) List.new(ExternalEvent, params) do Api.send_request("/external_events", :get, params, ) end end |
Instance Method Details
#body ⇒ Object
string - Event body
40 41 42 |
# File 'lib/files.com/models/external_event.rb', line 40 def body @attributes[:body] end |
#body=(value) ⇒ Object
44 45 46 |
# File 'lib/files.com/models/external_event.rb', line 44 def body=(value) @attributes[:body] = value end |
#body_url ⇒ Object
string - Link to log file.
54 55 56 |
# File 'lib/files.com/models/external_event.rb', line 54 def body_url @attributes[:body_url] end |
#body_url=(value) ⇒ Object
58 59 60 |
# File 'lib/files.com/models/external_event.rb', line 58 def body_url=(value) @attributes[:body_url] = value end |
#bytes_synced ⇒ Object
int64 - For sync events, the total number of bytes synced.
90 91 92 |
# File 'lib/files.com/models/external_event.rb', line 90 def bytes_synced @attributes[:bytes_synced] end |
#bytes_synced=(value) ⇒ Object
94 95 96 |
# File 'lib/files.com/models/external_event.rb', line 94 def bytes_synced=(value) @attributes[:bytes_synced] = value end |
#created_at ⇒ Object
date-time - External event create date/time
49 50 51 |
# File 'lib/files.com/models/external_event.rb', line 49 def created_at @attributes[:created_at] end |
#errored_files ⇒ Object
int64 - For sync events, the number of files that encountered errors.
81 82 83 |
# File 'lib/files.com/models/external_event.rb', line 81 def errored_files @attributes[:errored_files] end |
#errored_files=(value) ⇒ Object
85 86 87 |
# File 'lib/files.com/models/external_event.rb', line 85 def errored_files=(value) @attributes[:errored_files] = value end |
#event_type ⇒ Object
string - Type of event being recorded.
22 23 24 |
# File 'lib/files.com/models/external_event.rb', line 22 def event_type @attributes[:event_type] end |
#event_type=(value) ⇒ Object
26 27 28 |
# File 'lib/files.com/models/external_event.rb', line 26 def event_type=(value) @attributes[:event_type] = value end |
#folder_behavior_id ⇒ Object
int64 - Folder Behavior ID
63 64 65 |
# File 'lib/files.com/models/external_event.rb', line 63 def folder_behavior_id @attributes[:folder_behavior_id] end |
#folder_behavior_id=(value) ⇒ Object
67 68 69 |
# File 'lib/files.com/models/external_event.rb', line 67 def folder_behavior_id=(value) @attributes[:folder_behavior_id] = value end |
#id ⇒ Object
int64 - Event ID
13 14 15 |
# File 'lib/files.com/models/external_event.rb', line 13 def id @attributes[:id] end |
#id=(value) ⇒ Object
17 18 19 |
# File 'lib/files.com/models/external_event.rb', line 17 def id=(value) @attributes[:id] = value end |
#remote_server_type ⇒ Object
string - Associated Remote Server type, if any
99 100 101 |
# File 'lib/files.com/models/external_event.rb', line 99 def remote_server_type @attributes[:remote_server_type] end |
#remote_server_type=(value) ⇒ Object
103 104 105 |
# File 'lib/files.com/models/external_event.rb', line 103 def remote_server_type=(value) @attributes[:remote_server_type] = value end |
#save ⇒ Object
107 108 109 110 111 112 113 114 |
# File 'lib/files.com/models/external_event.rb', line 107 def save if @attributes[:id] raise NotImplementedError.new("The ExternalEvent object doesn't support updates.") else new_obj = ExternalEvent.create(@attributes, @options) @attributes = new_obj.attributes end end |
#status ⇒ Object
string - Status of event.
31 32 33 |
# File 'lib/files.com/models/external_event.rb', line 31 def status @attributes[:status] end |
#status=(value) ⇒ Object
35 36 37 |
# File 'lib/files.com/models/external_event.rb', line 35 def status=(value) @attributes[:status] = value end |
#successful_files ⇒ Object
int64 - For sync events, the number of files handled successfully.
72 73 74 |
# File 'lib/files.com/models/external_event.rb', line 72 def successful_files @attributes[:successful_files] end |
#successful_files=(value) ⇒ Object
76 77 78 |
# File 'lib/files.com/models/external_event.rb', line 76 def successful_files=(value) @attributes[:successful_files] = value end |