Class: MailSlurpClient::ContentMatchOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/content_match_options.rb

Overview

Options for matching content using regex patterns based on Java Pattern syntax

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContentMatchOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 43

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

Instance Attribute Details

#pattern ⇒ Object

Java style regex pattern. Do not include the typical ‘/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\d6)`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `[’code is: 123456’, ‘123456’]‘ See docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.



19
20
21
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 19

def pattern
  @pattern
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 22

def self.attribute_map
  {
    :'pattern' => :'pattern'
  }
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



102
103
104
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 102

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



36
37
38
39
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 36

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



29
30
31
32
33
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 29

def self.openapi_types
  {
    :'pattern' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



81
82
83
84
85
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 81

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pattern == o.pattern
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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 130

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
    MailSlurpClient.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



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 199

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 109

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


89
90
91
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 89

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



95
96
97
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 95

def hash
  [pattern].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



63
64
65
66
67
68
69
70
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 63

def list_invalid_properties
  invalid_properties = Array.new
  if @pattern.nil?
    invalid_properties.push('invalid value for "pattern", pattern cannot be nil.')
  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



175
176
177
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 175

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



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 181

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



169
170
171
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 169

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



74
75
76
77
 
# File 'lib/mailslurp_client/models/content_match_options.rb', line 74

def valid?
  return false if @pattern.nil?
  true
end