Class: Files::IpAddress
- Inherits:
-
Object
- Object
- Files::IpAddress
- Defined in:
- lib/files.com/models/ip_address.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
-
.get_exavault_reserved(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
-
.get_reserved(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
-
.get_smartfile_reserved(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
-
.list(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
Instance Method Summary collapse
-
#associated_with ⇒ Object
string - The object that this public IP address list is associated with.
-
#group_id ⇒ Object
int64 - Group ID.
-
#id ⇒ Object
string - Unique label for list; used by Zapier and other integrations.
-
#initialize(attributes = {}, options = {}) ⇒ IpAddress
constructor
A new instance of IpAddress.
-
#ip_addresses ⇒ Object
array(string) - A list of IP addresses.
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ IpAddress
Returns a new instance of IpAddress.
7 8 9 10 |
# File 'lib/files.com/models/ip_address.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/ip_address.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/ip_address.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
48 49 50 |
# File 'lib/files.com/models/ip_address.rb', line 48 def self.all(params = {}, = {}) list(params, ) end |
.get_exavault_reserved(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).
action - string
page - int64
73 74 75 76 77 78 79 80 81 82 |
# File 'lib/files.com/models/ip_address.rb', line 73 def self.get_exavault_reserved(params = {}, = {}) 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: action must be an String") if params[:action] and !params[:action].is_a?(String) raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer) List.new(PublicIpAddress, params) do Api.send_request("/ip_addresses/exavault-reserved", :get, params, ) end end |
.get_reserved(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).
action - string
page - int64
89 90 91 92 93 94 95 96 97 98 |
# File 'lib/files.com/models/ip_address.rb', line 89 def self.get_reserved(params = {}, = {}) 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: action must be an String") if params[:action] and !params[:action].is_a?(String) raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer) List.new(PublicIpAddress, params) do Api.send_request("/ip_addresses/reserved", :get, params, ) end end |
.get_smartfile_reserved(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).
action - string
page - int64
57 58 59 60 61 62 63 64 65 66 |
# File 'lib/files.com/models/ip_address.rb', line 57 def self.get_smartfile_reserved(params = {}, = {}) 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: action must be an String") if params[:action] and !params[:action].is_a?(String) raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer) List.new(PublicIpAddress, params) do Api.send_request("/ip_addresses/smartfile-reserved", :get, params, ) end 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).
action - string
page - int64
37 38 39 40 41 42 43 44 45 46 |
# File 'lib/files.com/models/ip_address.rb', line 37 def self.list(params = {}, = {}) 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: action must be an String") if params[:action] and !params[:action].is_a?(String) raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer) List.new(IpAddress, params) do Api.send_request("/ip_addresses", :get, params, ) end end |
Instance Method Details
#associated_with ⇒ Object
string - The object that this public IP address list is associated with.
18 19 20 |
# File 'lib/files.com/models/ip_address.rb', line 18 def associated_with @attributes[:associated_with] end |
#group_id ⇒ Object
int64 - Group ID
23 24 25 |
# File 'lib/files.com/models/ip_address.rb', line 23 def group_id @attributes[:group_id] end |
#id ⇒ Object
string - Unique label for list; used by Zapier and other integrations.
13 14 15 |
# File 'lib/files.com/models/ip_address.rb', line 13 def id @attributes[:id] end |
#ip_addresses ⇒ Object
array(string) - A list of IP addresses.
28 29 30 |
# File 'lib/files.com/models/ip_address.rb', line 28 def ip_addresses @attributes[:ip_addresses] end |