Class: Fastly::AclEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/acl_entry.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AclEntry

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/fastly/models/acl_entry.rb', line 85

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::AclEntry` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::AclEntry`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'negated')
    self.negated = attributes[:'negated']
  else
    self.negated = NEGATED::disable
  end

  if attributes.key?(:'comment')
    self.comment = attributes[:'comment']
  end

  if attributes.key?(:'ip')
    self.ip = attributes[:'ip']
  end

  if attributes.key?(:'subnet')
    self.subnet = attributes[:'subnet']
  end
end

Instance Attribute Details

#comment ⇒ Object

A freeform descriptive note.



20
21
22
 
# File 'lib/fastly/models/acl_entry.rb', line 20

def comment
  @comment
end

#ip ⇒ Object

An IP address.



23
24
25
 
# File 'lib/fastly/models/acl_entry.rb', line 23

def ip
  @ip
end

#negated ⇒ Object

Whether to negate the match. Useful primarily when creating individual exceptions to larger subnets.



17
18
19
 
# File 'lib/fastly/models/acl_entry.rb', line 17

def negated
  @negated
end

#subnet ⇒ Object

Number of bits for the subnet mask applied to the IP address. For IPv4 addresses, a value of 32 represents the smallest subnet mask (1 address), 24 represents a class C subnet mask (256 addresses), 16 represents a class B subnet mask (65k addresses), and 8 is class A subnet mask (16m addresses). If not provided, no mask is applied.



26
27
28
 
# File 'lib/fastly/models/acl_entry.rb', line 26

def subnet
  @subnet
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/fastly/models/acl_entry.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



51
52
53
54
55
56
57
58
 
# File 'lib/fastly/models/acl_entry.rb', line 51

def self.attribute_map
  {
    :'negated' => :'negated',
    :'comment' => :'comment',
    :'ip' => :'ip',
    :'subnet' => :'subnet'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



168
169
170
 
# File 'lib/fastly/models/acl_entry.rb', line 168

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
80
81
 
# File 'lib/fastly/models/acl_entry.rb', line 76

def self.fastly_nullable
  Set.new([
    :'comment',
    :'subnet'
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
 
# File 'lib/fastly/models/acl_entry.rb', line 66

def self.fastly_types
  {
    :'negated' => :'Integer',
    :'comment' => :'String',
    :'ip' => :'String',
    :'subnet' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
 
# File 'lib/fastly/models/acl_entry.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      negated == o.negated &&
      comment == o.comment &&
      ip == o.ip &&
      subnet == o.subnet
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/fastly/models/acl_entry.rb', line 198

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Fastly.const_get(type)
    klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/fastly/models/acl_entry.rb', line 269

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/fastly/models/acl_entry.rb', line 175

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


155
156
157
 
# File 'lib/fastly/models/acl_entry.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



161
162
163
 
# File 'lib/fastly/models/acl_entry.rb', line 161

def hash
  [negated, comment, ip, subnet].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



119
120
121
122
 
# File 'lib/fastly/models/acl_entry.rb', line 119

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
 
# File 'lib/fastly/models/acl_entry.rb', line 245

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/fastly/models/acl_entry.rb', line 251

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



239
240
241
 
# File 'lib/fastly/models/acl_entry.rb', line 239

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



126
127
128
129
130
 
# File 'lib/fastly/models/acl_entry.rb', line 126

def valid?
  negated_validator = EnumAttributeValidator.new('Integer', [0, 1])
  return false unless negated_validator.valid?(@negated)
  true
end