Module: NetboxClientRuby::Entity::ClassMethods

Defined in:
lib/netbox_client_ruby/entity.rb

Instance Method Summary collapse

Instance Method Details

#creation_path(creation_path = nil) ⇒ Object

Raises:

  • (ArgumentError) 


51
52
53
54
55
56
57
 
# File 'lib/netbox_client_ruby/entity.rb', line 51

def creation_path(creation_path = nil)
  @creation_path ||= creation_path

  return @creation_path if @creation_path

  raise ArgumentError, "No argument to 'creation_path' was given."
end

#deletable(deletable = false) ⇒ Object

rubocop:disable Style/OptionalBooleanParameter



39
40
41
 
# File 'lib/netbox_client_ruby/entity.rb', line 39

def deletable(deletable = false) # rubocop:disable Style/OptionalBooleanParameter
  @deletable ||= deletable
end

#id(*fields) ⇒ Object

Expects ids in the following format:

id 'an_id_field'
id :an_id_field
id 'an_id_field', 'another_id_field'
id :an_id_field, :another_id_field
id an_id_field: 'id_field_in_data'
id an_id_field: :id_field_in_data
id 'an_id_field' => :id_field_in_data
id 'an_id_field' => 'id_field_in_data'
id an_id_field: 'id_field_in_data', :another_id_field: 'id_field2_in_data'

Raises:

  • (ArgumentError) 


24
25
26
27
28
29
30
31
 
# File 'lib/netbox_client_ruby/entity.rb', line 24

def id(*fields)
  return @id_fields if @id_fields

  raise ArgumentError, "No 'id' was defined, but one is expected." if fields.empty?

  @id_fields = load_attributes(fields)
  @id_fields
end

#object_fields(*fields_to_class_map) ⇒ Object

allowed values: object_fields :field_a, :field_b, :field_c, 'fieldname_as_string' # next is ame as previous object_fields field_a: nil, field_b: nil, field_c: nil, 'fieldname_as_string': nil # next defines the types of the objects object_fields field_a: Klass, field_b: proc { |data| Klass.new data }, field_c: nil, 'fieldname_as_string' 



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/netbox_client_ruby/entity.rb', line 67

def object_fields(*fields_to_class_map)
  return @object_fields if @object_fields

  if fields_to_class_map.nil? || fields_to_class_map.empty?
    @object_fields = {}
  else
    fields_map = sanitize_mapping(fields_to_class_map)
    @object_fields = fields_map
  end
end

#path(path = nil) ⇒ Object

Raises:

  • (ArgumentError) 


43
44
45
46
47
48
49
 
# File 'lib/netbox_client_ruby/entity.rb', line 43

def path(path = nil)
  @path ||= path

  return @path if @path

  raise ArgumentError, "No argument to 'path' was given."
end

#readonly_fields(*fields) ⇒ Object 



33
34
35
36
37
 
# File 'lib/netbox_client_ruby/entity.rb', line 33

def readonly_fields(*fields)
  return @readonly_fields if @readonly_fields

  @readonly_fields = fields.map(&:to_s)
end