Class: PulpcoreClient::HeaderContentGuard

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/models/header_content_guard.rb

Overview

A serializer for HeaderContentGuard.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeaderContentGuard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 65

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PulpcoreClient::HeaderContentGuard` 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 `PulpcoreClient::HeaderContentGuard`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

Instance Attribute Details

#description ⇒ Object

An optional description.



22
23
24
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 22

def description
  @description
end

#header_name ⇒ Object

The header name the guard will check on.



25
26
27
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 25

def header_name
  @header_name
end

#header_value ⇒ Object

The value that will authorize the request.



28
29
30
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 28

def header_value
  @header_value
end

#jq_filter ⇒ Object

A JQ syntax compatible filter. If jq_filter is not set, then the value willonly be Base64 decoded and checked as an explicit string match.



31
32
33
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 31

def jq_filter
  @jq_filter
end

#name ⇒ Object

The unique name.



19
20
21
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 19

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 34

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'header_name' => :'header_name',
    :'header_value' => :'header_value',
    :'jq_filter' => :'jq_filter'
  }
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



241
242
243
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 241

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
59
60
61
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 56

def self.openapi_nullable
  Set.new([
    :'description',
    :'jq_filter'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 45

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'header_name' => :'String',
    :'header_value' => :'String',
    :'jq_filter' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 216

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      header_name == o.header_name &&
      header_value == o.header_value &&
      jq_filter == o.jq_filter
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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 269

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    PulpcoreClient.const_get(type).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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 338

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 248

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


228
229
230
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 234

def hash
  [name, description, header_name, header_value, jq_filter].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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 101

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if !@description.nil? && @description.to_s.length < 1
    invalid_properties.push('invalid value for "description", the character length must be great than or equal to 1.')
  end

  if @header_name.nil?
    invalid_properties.push('invalid value for "header_name", header_name cannot be nil.')
  end

  if @header_name.to_s.length < 1
    invalid_properties.push('invalid value for "header_name", the character length must be great than or equal to 1.')
  end

  if @header_value.nil?
    invalid_properties.push('invalid value for "header_value", header_value cannot be nil.')
  end

  if @header_value.to_s.length < 1
    invalid_properties.push('invalid value for "header_value", the character length must be great than or equal to 1.')
  end

  if !@jq_filter.nil? && @jq_filter.to_s.length < 1
    invalid_properties.push('invalid value for "jq_filter", the character length must be great than or equal to 1.')
  end

  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



314
315
316
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 314

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 320

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_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



308
309
310
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 308

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



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/pulpcore_client/models/header_content_guard.rb', line 140

def valid?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if !@description.nil? && @description.to_s.length < 1
  return false if @header_name.nil?
  return false if @header_name.to_s.length < 1
  return false if @header_value.nil?
  return false if @header_value.to_s.length < 1
  return false if !@jq_filter.nil? && @jq_filter.to_s.length < 1
  true
end