class PulpcoreClient::PatchedHeaderContentGuard

A serializer for HeaderContentGuard.

Attributes

description[RW]

An optional description.

header_name[RW]

The header name the guard will check on.

header_value[RW]

The value that will authorize the request.

jq_filter[RW]

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.

name[RW]

The unique name.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/pulpcore_client/models/patched_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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 214
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/pulpcore_client/models/patched_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::PatchedHeaderContentGuard` 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::PatchedHeaderContentGuard`. 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 56
def self.openapi_nullable
  Set.new([
    :'description',
    :'jq_filter'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 45
def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'header_name' => :'String',
    :'header_value' => :'String',
    :'jq_filter' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 189
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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 242
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 311
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 221
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
description=(description) click to toggle source

Custom attribute writer method with validation @param [Object] description Value to be assigned

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 149
def description=(description)
  if !description.nil? && description.to_s.length < 1
    fail ArgumentError, 'invalid value for "description", the character length must be great than or equal to 1.'
  end

  @description = description
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 201
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 207
def hash
  [name, description, header_name, header_value, jq_filter].hash
end
header_name=(header_name) click to toggle source

Custom attribute writer method with validation @param [Object] header_name Value to be assigned

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 159
def header_name=(header_name)
  if !header_name.nil? && header_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "header_name", the character length must be great than or equal to 1.'
  end

  @header_name = header_name
end
header_value=(header_value) click to toggle source

Custom attribute writer method with validation @param [Object] header_value Value to be assigned

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 169
def header_value=(header_value)
  if !header_value.nil? && header_value.to_s.length < 1
    fail ArgumentError, 'invalid value for "header_value", the character length must be great than or equal to 1.'
  end

  @header_value = header_value
end
jq_filter=(jq_filter) click to toggle source

Custom attribute writer method with validation @param [Object] jq_filter Value to be assigned

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 179
def jq_filter=(jq_filter)
  if !jq_filter.nil? && jq_filter.to_s.length < 1
    fail ArgumentError, 'invalid value for "jq_filter", the character length must be great than or equal to 1.'
  end

  @jq_filter = jq_filter
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 101
def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @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? && @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? && @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
name=(name) click to toggle source

Custom attribute writer method with validation @param [Object] name Value to be assigned

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 139
def name=(name)
  if !name.nil? && name.to_s.length < 1
    fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
  end

  @name = name
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 287
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 293
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 281
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/pulpcore_client/models/patched_header_content_guard.rb, line 128
def valid?
  return false if !@name.nil? && @name.to_s.length < 1
  return false if !@description.nil? && @description.to_s.length < 1
  return false if !@header_name.nil? && @header_name.to_s.length < 1
  return false if !@header_value.nil? && @header_value.to_s.length < 1
  return false if !@jq_filter.nil? && @jq_filter.to_s.length < 1
  true
end