Module: NetboxClientRuby::Entities
- Includes:
- Enumerable, Communication
- Included in:
- Circuits::CircuitTerminations, Circuits::CircuitTypes, Circuits::Circuits, Circuits::Providers, DCIM::ConsoleConnections, DCIM::ConsolePorts, DCIM::ConsoleServerPorts, DCIM::DeviceRoles, DCIM::DeviceTypes, DCIM::Devices, DCIM::InterfaceConnections, DCIM::Interfaces, DCIM::InventoryItems, DCIM::Manufacturers, DCIM::Platforms, DCIM::PowerConnections, DCIM::PowerOutlets, DCIM::PowerPorts, DCIM::RackGroups, DCIM::RackReservations, DCIM::RackRoles, DCIM::Racks, DCIM::Regions, DCIM::Sites, DCIM::VirtualChassisList, NetboxClientRuby::Extras::ConfigContexts, NetboxClientRuby::Extras::JournalEntries, NetboxClientRuby::Extras::Tags, IPAM::Aggregates, IPAM::IpAddresses, IPAM::IpRanges, IPAM::Prefixes, IPAM::Rirs, IPAM::Roles, IPAM::Services, IPAM::VlanGroups, IPAM::Vlans, IPAM::Vrfs, Secrets::SecretRoles, Secrets::Secrets, Tenancy::TenantGroups, Tenancy::Tenants, Virtualization::ClusterGroups, Virtualization::ClusterTypes, Virtualization::Clusters, Virtualization::Interfaces, Virtualization::VirtualMachines
- Defined in:
- lib/netbox_client_ruby/entities.rb
Defined Under Namespace
Modules: ClassMethods
Class Method Summary
collapse
Instance Method Summary
collapse
#connection, #hash_to_object, #response
Class Method Details
.included(other_klass) ⇒ Object
9
10
11
|
# File 'lib/netbox_client_ruby/entities.rb', line 9
def self.included(other_klass)
other_klass.extend ClassMethods
end
|
Instance Method Details
#[](index) ⇒ Object
138
139
140
141
142
|
# File 'lib/netbox_client_ruby/entities.rb', line 138
def [](index)
return nil if length <= index
as_entity raw_data_array[index]
end
|
#all ⇒ Object
106
107
108
109
110
|
# File 'lib/netbox_client_ruby/entities.rb', line 106
def all
@instance_limit = NetboxClientRuby.config.netbox..max_limit
reset
self
end
|
#each ⇒ Object
144
145
146
|
# File 'lib/netbox_client_ruby/entities.rb', line 144
def each
raw_data_array.each { |raw_entity| yield as_entity(raw_entity) }
end
|
#filter(filter) ⇒ Object
98
99
100
101
102
103
104
|
# File 'lib/netbox_client_ruby/entities.rb', line 98
def filter(filter)
fail ArgumentError, '"filter" expects a hash' unless filter.is_a? Hash
@filter = filter
reset
self
end
|
#find_by(attributes) ⇒ Object
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
# File 'lib/netbox_client_ruby/entities.rb', line 78
def find_by(attributes)
fail ArgumentError, '"attributes" expects a hash' unless attributes.is_a? Hash
filter(attributes).find do |netbox_object|
attributes.all? do |filter_key, filter_value|
if filter_key.to_s.start_with?('cf_')
custom_field = filter_key.to_s.sub('cf_', '')
netbox_object.custom_fields[custom_field].to_s == filter_value.to_s
else
if netbox_object.respond_to?(filter_key)
netbox_object.public_send(filter_key).to_s == filter_value.to_s
else
false
end
end
end
end
end
|
#length ⇒ Object
Also known as:
size
The number of entities that have been fetched
150
151
152
|
# File 'lib/netbox_client_ruby/entities.rb', line 150
def length
raw_data_array.length
end
|
#limit(limit) ⇒ Object
112
113
114
115
116
117
118
|
# File 'lib/netbox_client_ruby/entities.rb', line 112
def limit(limit)
self.class.check_limit limit unless limit.nil?
@instance_limit = limit
reset
self
end
|
#offset(offset) ⇒ Object
120
121
122
123
124
125
126
127
|
# File 'lib/netbox_client_ruby/entities.rb', line 120
def offset(offset)
raise ArgumentError, "The offset '#{offset}' is not numeric." unless offset.is_a? Numeric
raise ArgumentError, "The offset '#{offset}' must not be negative." if offset.negative?
@offset = offset
reset
self
end
|
#page(page) ⇒ Object
129
130
131
132
133
134
135
136
|
# File 'lib/netbox_client_ruby/entities.rb', line 129
def page(page)
raise ArgumentError, "The offset '#{page}' is not numeric but has to be." unless page.is_a? Numeric
raise ArgumentError, "The offset '#{page}' must be integer but isn't." unless page.integer?
raise ArgumentError, "The offset '#{page}' must not be negative but is." if page.negative?
limit = @instance_limit || self.class.limit
offset(limit * page)
end
|
#raw_data! ⇒ Object
165
166
167
|
# File 'lib/netbox_client_ruby/entities.rb', line 165
def raw_data!
data
end
|
#reload ⇒ Object
Also known as:
get!
160
161
162
163
|
# File 'lib/netbox_client_ruby/entities.rb', line 160
def reload
@data = get
self
end
|
#total ⇒ Object
Also known as:
count
The total number of available entities for that query
156
157
158
|
# File 'lib/netbox_client_ruby/entities.rb', line 156
def total
data[self.class.count_key]
end
|