Class: Metronome::ItemOrSubItemAccessLog

Inherits:
Object
  • Object
show all
Defined in:
lib/metronome/models/item_or_sub_item_access_log.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemOrSubItemAccessLog

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
148
149
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 101

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

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

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

  if attributes.key?(:'access_policies')
    if (value = attributes[:'access_policies']).is_a?(Array)
      self.access_policies = value
    end
  end

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

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

  if attributes.key?(:'accessed_sub_items')
    if (value = attributes[:'accessed_sub_items']).is_a?(Array)
      self.accessed_sub_items = value
    end
  end

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

Instance Attribute Details

#access_authoriser ⇒ Object

The ID of the system that accessed the data



23
24
25
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 23

def access_authoriser
  @access_authoriser
end

#access_policies ⇒ Object

Returns the value of attribute access_policies.



25
26
27
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 25

def access_policies
  @access_policies
end

#access_type ⇒ Object

Returns the value of attribute access_type.



20
21
22
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 20

def access_type
  @access_type
end

#accessed_sub_items ⇒ Object

Returns the value of attribute accessed_sub_items.



33
34
35
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 33

def accessed_sub_items
  @accessed_sub_items
end

#effective_expiry_date ⇒ Object

The date to which this item or sub-item would be retained after this access



31
32
33
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 31

def effective_expiry_date
  @effective_expiry_date
end

#effective_expiry_policy ⇒ Object

The policy which governed data expiry after this data access



28
29
30
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 28

def effective_expiry_policy
  @effective_expiry_policy
end

#expired ⇒ Object

Present and true only when the item expired as a result of this access



36
37
38
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 36

def expired
  @expired
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.



18
19
20
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 18

def timestamp
  @timestamp
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 61

def self.attribute_map
  {
    :'timestamp' => :'timestamp',
    :'access_type' => :'access-type',
    :'access_authoriser' => :'access-authoriser',
    :'access_policies' => :'access-policies',
    :'effective_expiry_policy' => :'effective-expiry-policy',
    :'effective_expiry_date' => :'effective-expiry-date',
    :'accessed_sub_items' => :'accessed-sub-items',
    :'expired' => :'expired'
  }
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



219
220
221
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 219

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 80

def self.openapi_types
  {
    :'timestamp' => :'Time',
    :'access_type' => :'AccessType',
    :'access_authoriser' => :'String',
    :'access_policies' => :'Array<String>',
    :'effective_expiry_policy' => :'String',
    :'effective_expiry_date' => :'Date',
    :'accessed_sub_items' => :'Array<String>',
    :'expired' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      timestamp == o.timestamp &&
      access_type == o.access_type &&
      access_authoriser == o.access_authoriser &&
      access_policies == o.access_policies &&
      effective_expiry_policy == o.effective_expiry_policy &&
      effective_expiry_date == o.effective_expiry_date &&
      accessed_sub_items == o.accessed_sub_items &&
      expired == o.expired
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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 250

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 = Metronome.const_get(type)
    klass.respond_to?(:openapi_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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 321

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 226

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_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


206
207
208
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 212

def hash
  [timestamp, access_type, access_authoriser, access_policies, effective_expiry_policy, effective_expiry_date, accessed_sub_items, expired].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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 153

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

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

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

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

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



297
298
299
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 297

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 303

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



291
292
293
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 291

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



180
181
182
183
184
185
186
187
 
# File 'lib/metronome/models/item_or_sub_item_access_log.rb', line 180

def valid?
  return false if @timestamp.nil?
  return false if @access_type.nil?
  return false if @access_authoriser.nil?
  return false if @access_policies.nil?
  return false if @effective_expiry_policy.nil?
  true
end