Class: SmplkitGeneratedClient::App::Context

Inherits:
ApiModelBase show all
Defined in:
lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb

Overview

A specific instance of a context type — for example, a particular user, account, or device — together with the attributes observed on it. Context instances are addressed by a composite identifier of the form ‘context_type:key` (e.g. `user:alice-123`).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Context

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 83

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::App::Context` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::Context`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

  if attributes.key?(:'context_type')
    self.context_type = attributes[:'context_type']
  else
    self.context_type = nil
  end

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

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

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

Instance Attribute Details

#attributes ⇒ Object

Observed attribute values for this context instance. The key set is conventionally aligned with the parent context type’s known attribute keys, but additional keys are accepted.



29
30
31
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 29

def attributes
  @attributes
end

#context_type ⇒ Object

Key of the context type this instance belongs to (e.g. ‘user`, `account`).



26
27
28
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 26

def context_type
  @context_type
end

#created_at ⇒ Object

When the context instance was first registered.



32
33
34
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 32

def created_at
  @created_at
end

#key ⇒ Object

Entity identifier within the context type (e.g. ‘alice-123`). Together with `context_type` it forms the composite `id` `context_type:key`. Always populated in responses; declared optional only so SDK consumers can construct a draft Context without a key. Set by the bulk-register API; not editable.



20
21
22
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 20

def key
  @key
end

#name ⇒ Object

Human-readable display name for the context instance.



23
24
25
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 23

def name
  @name
end

#updated_at ⇒ Object

When the context instance was last modified.



35
36
37
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 35

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



50
51
52
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 50

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 55

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 38

def self.attribute_map
  {
    :'key' => :'key',
    :'name' => :'name',
    :'context_type' => :'context_type',
    :'attributes' => :'attributes',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 184

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
76
77
78
79
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 72

def self.openapi_nullable
  Set.new([
    :'key',
    :'name',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 60

def self.openapi_types
  {
    :'key' => :'String',
    :'name' => :'String',
    :'context_type' => :'String',
    :'attributes' => :'Hash<String, Object>',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key == o.key &&
      name == o.name &&
      context_type == o.context_type &&
      attributes == o.attributes &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


171
172
173
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



177
178
179
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 177

def hash
  [key, name, context_type, attributes, created_at, updated_at].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



128
129
130
131
132
133
134
135
136
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 128

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @context_type.nil?
    invalid_properties.push('invalid value for "context_type", context_type cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 206

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

#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
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb', line 140

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @context_type.nil?
  true
end