Class: Files::RemoteBandwidthSnapshot

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RemoteBandwidthSnapshot.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



61
62
63
 
# File 'lib/files.com/models/remote_bandwidth_snapshot.rb', line 61

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).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[logged_at]=desc`). Valid fields are `logged_at`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.

Raises:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/files.com/models/remote_bandwidth_snapshot.rb', line 46

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_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(RemoteBandwidthSnapshot, params) do
    Api.send_request("/remote_bandwidth_snapshots", :get, params, options)
  end
end

Instance Method Details

#id ⇒ Object

int64 - Site bandwidth ID



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

def id
  @attributes[:id]
end

#logged_at ⇒ Object

date-time - Time the site bandwidth report was logged



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

def logged_at
  @attributes[:logged_at]
end

#remote_server_id ⇒ Object

int64 - ID of related Remote Server



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

def remote_server_id
  @attributes[:remote_server_id]
end

#sync_bytes_received ⇒ Object

double - Site sync bandwidth report bytes received



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

def sync_bytes_received
  @attributes[:sync_bytes_received]
end

#sync_bytes_sent ⇒ Object

double - Site sync bandwidth report bytes sent



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

def sync_bytes_sent
  @attributes[:sync_bytes_sent]
end