Class: Files::ExternalEvent

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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 = {}, 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/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
  @options
end

Class Method Details

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



162
163
164
 
# File 'lib/files.com/models/external_event.rb', line 162

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

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

Parameters:

status (required) - string - Status of event.
body (required) - string - Event body

Raises:



185
186
187
188
189
190
191
192
193
 
# File 'lib/files.com/models/external_event.rb', line 185

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

  response, options = Api.send_request("/external_events", :post, params, options)
  ExternalEvent.new(response.data, options)
end

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

Parameters:

id (required) - int64 - External Event ID.

Raises:



168
169
170
171
172
173
174
175
176
 
# File 'lib/files.com/models/external_event.rb', line 168

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("/external_events/#{params[:id]}", :get, params, options)
  ExternalEvent.new(response.data, options)
end

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



178
179
180
 
# File 'lib/files.com/models/external_event.rb', line 178

def self.get(id, params = {}, options = {})
  find(id, 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).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[remote_server_type]=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`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`.
filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.

Raises:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/files.com/models/external_event.rb', line 146

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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
  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_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].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)
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)

  List.new(ExternalEvent, params) do
    Api.send_request("/external_events", :get, params, options)
  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

#compared_files ⇒ Object

int64 - For sync events, the number of files considered for the sync.



99
100
101
 
# File 'lib/files.com/models/external_event.rb', line 99

def compared_files
  @attributes[:compared_files]
end

#compared_files=(value) ⇒ Object 



103
104
105
 
# File 'lib/files.com/models/external_event.rb', line 103

def compared_files=(value)
  @attributes[:compared_files] = value
end

#compared_folders ⇒ Object

int64 - For sync events, the number of folders listed and considered for the sync.



108
109
110
 
# File 'lib/files.com/models/external_event.rb', line 108

def compared_folders
  @attributes[:compared_folders]
end

#compared_folders=(value) ⇒ Object 



112
113
114
 
# File 'lib/files.com/models/external_event.rb', line 112

def compared_folders=(value)
  @attributes[:compared_folders] = 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



117
118
119
 
# File 'lib/files.com/models/external_event.rb', line 117

def remote_server_type
  @attributes[:remote_server_type]
end

#remote_server_type=(value) ⇒ Object 



121
122
123
 
# File 'lib/files.com/models/external_event.rb', line 121

def remote_server_type=(value)
  @attributes[:remote_server_type] = value
end

#save ⇒ Object 



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/files.com/models/external_event.rb', line 125

def save
  if @attributes[:id]
    raise NotImplementedError.new("The ExternalEvent object doesn't support updates.")
  else
    new_obj = ExternalEvent.create(@attributes, @options)
  end

  @attributes = new_obj.attributes
  true
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