Class: MailSlurpClient::PageAlias

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

Overview

Paginated email alias results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PageAlias

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 82

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#content ⇒ Object

Returns the value of attribute content.



18
19
20
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 18

def content
  @content
end

#empty ⇒ Object

Returns the value of attribute empty.



38
39
40
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 38

def empty
  @empty
end

#first ⇒ Object

Returns the value of attribute first.



30
31
32
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 30

def first
  @first
end

#last ⇒ Object

Returns the value of attribute last.



26
27
28
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 26

def last
  @last
end

#number ⇒ Object

Returns the value of attribute number.



34
35
36
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 34

def number
  @number
end

#number_of_elements ⇒ Object

Returns the value of attribute number_of_elements.



28
29
30
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 28

def number_of_elements
  @number_of_elements
end

#pageable ⇒ Object

Returns the value of attribute pageable.



20
21
22
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 20

def pageable
  @pageable
end

#size ⇒ Object

Returns the value of attribute size.



32
33
34
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 32

def size
  @size
end

#sort ⇒ Object

Returns the value of attribute sort.



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

def sort
  @sort
end

#total_elements ⇒ Object

Returns the value of attribute total_elements.



24
25
26
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 24

def total_elements
  @total_elements
end

#total_pages ⇒ Object

Returns the value of attribute total_pages.



22
23
24
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 22

def total_pages
  @total_pages
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 41

def self.attribute_map
  {
    :'content' => :'content',
    :'pageable' => :'pageable',
    :'total_pages' => :'totalPages',
    :'total_elements' => :'totalElements',
    :'last' => :'last',
    :'number_of_elements' => :'numberOfElements',
    :'first' => :'first',
    :'size' => :'size',
    :'number' => :'number',
    :'sort' => :'sort',
    :'empty' => :'empty'
  }
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



198
199
200
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 198

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 58

def self.openapi_types
  {
    :'content' => :'Array<AliasProjection>',
    :'pageable' => :'PageableObject',
    :'total_pages' => :'Integer',
    :'total_elements' => :'Integer',
    :'last' => :'Boolean',
    :'number_of_elements' => :'Integer',
    :'first' => :'Boolean',
    :'size' => :'Integer',
    :'number' => :'Integer',
    :'sort' => :'SortObject',
    :'empty' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content == o.content &&
      pageable == o.pageable &&
      total_pages == o.total_pages &&
      total_elements == o.total_elements &&
      last == o.last &&
      number_of_elements == o.number_of_elements &&
      first == o.first &&
      size == o.size &&
      number == o.number &&
      sort == o.sort &&
      empty == o.empty
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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 226

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 295

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 205

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


185
186
187
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



191
192
193
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 191

def hash
  [content, pageable, total_pages, total_elements, last, number_of_elements, first, size, number, sort, empty].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



144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 144

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

  if @total_elements.nil?
    invalid_properties.push('invalid value for "total_elements", total_elements 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



271
272
273
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 271

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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 277

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



265
266
267
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 265

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



159
160
161
162
163
 
# File 'lib/mailslurp_client/models/page_alias.rb', line 159

def valid?
  return false if @total_pages.nil?
  return false if @total_elements.nil?
  true
end