Class: MistApi::ResponseOrgSearchItem

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/mist_api/models/response_org_search_item.rb

Overview

ResponseOrgSearchItem Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(msp_id = SKIP, name = SKIP, num_aps = SKIP, num_gateways = SKIP, num_sites = SKIP, num_switches = SKIP, num_unassigned_aps = SKIP, org_id = SKIP, sub_ana_entitled = SKIP, sub_ana_required = SKIP, sub_ast_entitled = SKIP, sub_ast_required = SKIP, sub_eng_entitled = SKIP, sub_eng_required = SKIP, sub_ex12_required = SKIP, sub_insufficient = SKIP, sub_man_entitled = SKIP, sub_man_required = SKIP, sub_me_entitled = SKIP, sub_vna_entitled = SKIP, sub_vna_required = SKIP, timestamp = SKIP, trial_enabled = SKIP, usage_types = SKIP) ⇒ ResponseOrgSearchItem

Returns a new instance of ResponseOrgSearchItem.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 173

def initialize(msp_id = SKIP, name = SKIP, num_aps = SKIP,
               num_gateways = SKIP, num_sites = SKIP, num_switches = SKIP,
               num_unassigned_aps = SKIP, org_id = SKIP,
               sub_ana_entitled = SKIP, sub_ana_required = SKIP,
               sub_ast_entitled = SKIP, sub_ast_required = SKIP,
               sub_eng_entitled = SKIP, sub_eng_required = SKIP,
               sub_ex12_required = SKIP, sub_insufficient = SKIP,
               sub_man_entitled = SKIP, sub_man_required = SKIP,
               sub_me_entitled = SKIP, sub_vna_entitled = SKIP,
               sub_vna_required = SKIP, timestamp = SKIP,
               trial_enabled = SKIP, usage_types = SKIP)
  @msp_id = msp_id unless msp_id == SKIP
  @name = name unless name == SKIP
  @num_aps = num_aps unless num_aps == SKIP
  @num_gateways = num_gateways unless num_gateways == SKIP
  @num_sites = num_sites unless num_sites == SKIP
  @num_switches = num_switches unless num_switches == SKIP
  @num_unassigned_aps = num_unassigned_aps unless num_unassigned_aps == SKIP
  @org_id = org_id unless org_id == SKIP
  @sub_ana_entitled = sub_ana_entitled unless sub_ana_entitled == SKIP
  @sub_ana_required = sub_ana_required unless sub_ana_required == SKIP
  @sub_ast_entitled = sub_ast_entitled unless sub_ast_entitled == SKIP
  @sub_ast_required = sub_ast_required unless sub_ast_required == SKIP
  @sub_eng_entitled = sub_eng_entitled unless sub_eng_entitled == SKIP
  @sub_eng_required = sub_eng_required unless sub_eng_required == SKIP
  @sub_ex12_required = sub_ex12_required unless sub_ex12_required == SKIP
  @sub_insufficient = sub_insufficient unless sub_insufficient == SKIP
  @sub_man_entitled = sub_man_entitled unless sub_man_entitled == SKIP
  @sub_man_required = sub_man_required unless sub_man_required == SKIP
  @sub_me_entitled = sub_me_entitled unless sub_me_entitled == SKIP
  @sub_vna_entitled = sub_vna_entitled unless sub_vna_entitled == SKIP
  @sub_vna_required = sub_vna_required unless sub_vna_required == SKIP
  @timestamp = timestamp unless timestamp == SKIP
  @trial_enabled = trial_enabled unless trial_enabled == SKIP
  @usage_types = usage_types unless usage_types == SKIP
end

Instance Attribute Details

#msp_id ⇒ UUID | String

TODO: Write general description for this method

Returns:

  • (UUID | String) 


14
15
16
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 14

def msp_id
  @msp_id
end

#name ⇒ String

org name

Returns:

  • (String) 


18
19
20
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 18

def name
  @name
end

#num_aps ⇒ Integer

org name

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 22

def num_aps
  @num_aps
end

#num_gateways ⇒ Integer

org name

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 26

def num_gateways
  @num_gateways
end

#num_sites ⇒ Integer

org name

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 30

def num_sites
  @num_sites
end

#num_switches ⇒ Integer

org name

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 34

def num_switches
  @num_switches
end

#num_unassigned_aps ⇒ Integer

org name

Returns:

  • (Integer) 


38
39
40
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 38

def num_unassigned_aps
  @num_unassigned_aps
end

#org_id ⇒ UUID | String

org name

Returns:

  • (UUID | String) 


42
43
44
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 42

def org_id
  @org_id
end

#sub_ana_entitled ⇒ Integer

org name

Returns:

  • (Integer) 


46
47
48
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 46

def sub_ana_entitled
  @sub_ana_entitled
end

#sub_ana_required ⇒ Integer

org name

Returns:

  • (Integer) 


50
51
52
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 50

def sub_ana_required
  @sub_ana_required
end

#sub_ast_entitled ⇒ Integer

org name

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 54

def sub_ast_entitled
  @sub_ast_entitled
end

#sub_ast_required ⇒ Integer

org name

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 58

def sub_ast_required
  @sub_ast_required
end

#sub_eng_entitled ⇒ Integer

org name

Returns:

  • (Integer) 


62
63
64
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 62

def sub_eng_entitled
  @sub_eng_entitled
end

#sub_eng_required ⇒ Integer

org name

Returns:

  • (Integer) 


66
67
68
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 66

def sub_eng_required
  @sub_eng_required
end

#sub_ex12_required ⇒ Integer

org name

Returns:

  • (Integer) 


70
71
72
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 70

def sub_ex12_required
  @sub_ex12_required
end

#sub_insufficient ⇒ TrueClass | FalseClass

If this org has sufficient subscription

Returns:

  • (TrueClass | FalseClass) 


74
75
76
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 74

def sub_insufficient
  @sub_insufficient
end

#sub_man_entitled ⇒ Integer

If this org has sufficient subscription

Returns:

  • (Integer) 


78
79
80
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 78

def sub_man_entitled
  @sub_man_entitled
end

#sub_man_required ⇒ Integer

If this org has sufficient subscription

Returns:

  • (Integer) 


82
83
84
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 82

def sub_man_required
  @sub_man_required
end

#sub_me_entitled ⇒ Integer

If this org has sufficient subscription

Returns:

  • (Integer) 


86
87
88
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 86

def sub_me_entitled
  @sub_me_entitled
end

#sub_vna_entitled ⇒ Integer

If this org has sufficient subscription

Returns:

  • (Integer) 


90
91
92
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 90

def sub_vna_entitled
  @sub_vna_entitled
end

#sub_vna_required ⇒ Integer

If this org has sufficient subscription

Returns:

  • (Integer) 


94
95
96
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 94

def sub_vna_required
  @sub_vna_required
end

#timestamp ⇒ Float

Epoch (seconds)

Returns:

  • (Float) 


98
99
100
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 98

def timestamp
  @timestamp
end

#trial_enabled ⇒ TrueClass | FalseClass

If this org is under trial period

Returns:

  • (TrueClass | FalseClass) 


102
103
104
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 102

def trial_enabled
  @trial_enabled
end

#usage_types ⇒ Array[String]

a list of types that enabled by usage

Returns:

  • (Array[String]) 


106
107
108
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 106

def usage_types
  @usage_types
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 211

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  msp_id = hash.key?('msp_id') ? hash['msp_id'] : SKIP
  name = hash.key?('name') ? hash['name'] : SKIP
  num_aps = hash.key?('num_aps') ? hash['num_aps'] : SKIP
  num_gateways = hash.key?('num_gateways') ? hash['num_gateways'] : SKIP
  num_sites = hash.key?('num_sites') ? hash['num_sites'] : SKIP
  num_switches = hash.key?('num_switches') ? hash['num_switches'] : SKIP
  num_unassigned_aps =
    hash.key?('num_unassigned_aps') ? hash['num_unassigned_aps'] : SKIP
  org_id = hash.key?('org_id') ? hash['org_id'] : SKIP
  sub_ana_entitled =
    hash.key?('sub_ana_entitled') ? hash['sub_ana_entitled'] : SKIP
  sub_ana_required =
    hash.key?('sub_ana_required') ? hash['sub_ana_required'] : SKIP
  sub_ast_entitled =
    hash.key?('sub_ast_entitled') ? hash['sub_ast_entitled'] : SKIP
  sub_ast_required =
    hash.key?('sub_ast_required') ? hash['sub_ast_required'] : SKIP
  sub_eng_entitled =
    hash.key?('sub_eng_entitled') ? hash['sub_eng_entitled'] : SKIP
  sub_eng_required =
    hash.key?('sub_eng_required') ? hash['sub_eng_required'] : SKIP
  sub_ex12_required =
    hash.key?('sub_ex12_required') ? hash['sub_ex12_required'] : SKIP
  sub_insufficient =
    hash.key?('sub_insufficient') ? hash['sub_insufficient'] : SKIP
  sub_man_entitled =
    hash.key?('sub_man_entitled') ? hash['sub_man_entitled'] : SKIP
  sub_man_required =
    hash.key?('sub_man_required') ? hash['sub_man_required'] : SKIP
  sub_me_entitled =
    hash.key?('sub_me_entitled') ? hash['sub_me_entitled'] : SKIP
  sub_vna_entitled =
    hash.key?('sub_vna_entitled') ? hash['sub_vna_entitled'] : SKIP
  sub_vna_required =
    hash.key?('sub_vna_required') ? hash['sub_vna_required'] : SKIP
  timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
  trial_enabled = hash.key?('trial_enabled') ? hash['trial_enabled'] : SKIP
  usage_types = hash.key?('usage_types') ? hash['usage_types'] : SKIP

  # Create object from extracted values.
  ResponseOrgSearchItem.new(msp_id,
                            name,
                            num_aps,
                            num_gateways,
                            num_sites,
                            num_switches,
                            num_unassigned_aps,
                            org_id,
                            sub_ana_entitled,
                            sub_ana_required,
                            sub_ast_entitled,
                            sub_ast_required,
                            sub_eng_entitled,
                            sub_eng_required,
                            sub_ex12_required,
                            sub_insufficient,
                            sub_man_entitled,
                            sub_man_required,
                            sub_me_entitled,
                            sub_vna_entitled,
                            sub_vna_required,
                            timestamp,
                            trial_enabled,
                            usage_types)
end

.names ⇒ Object

A mapping from model property names to API property names.



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
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 109

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['msp_id'] = 'msp_id'
  @_hash['name'] = 'name'
  @_hash['num_aps'] = 'num_aps'
  @_hash['num_gateways'] = 'num_gateways'
  @_hash['num_sites'] = 'num_sites'
  @_hash['num_switches'] = 'num_switches'
  @_hash['num_unassigned_aps'] = 'num_unassigned_aps'
  @_hash['org_id'] = 'org_id'
  @_hash['sub_ana_entitled'] = 'sub_ana_entitled'
  @_hash['sub_ana_required'] = 'sub_ana_required'
  @_hash['sub_ast_entitled'] = 'sub_ast_entitled'
  @_hash['sub_ast_required'] = 'sub_ast_required'
  @_hash['sub_eng_entitled'] = 'sub_eng_entitled'
  @_hash['sub_eng_required'] = 'sub_eng_required'
  @_hash['sub_ex12_required'] = 'sub_ex12_required'
  @_hash['sub_insufficient'] = 'sub_insufficient'
  @_hash['sub_man_entitled'] = 'sub_man_entitled'
  @_hash['sub_man_required'] = 'sub_man_required'
  @_hash['sub_me_entitled'] = 'sub_me_entitled'
  @_hash['sub_vna_entitled'] = 'sub_vna_entitled'
  @_hash['sub_vna_required'] = 'sub_vna_required'
  @_hash['timestamp'] = 'timestamp'
  @_hash['trial_enabled'] = 'trial_enabled'
  @_hash['usage_types'] = 'usage_types'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



169
170
171
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 169

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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
166
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 139

def self.optionals
  %w[
    msp_id
    name
    num_aps
    num_gateways
    num_sites
    num_switches
    num_unassigned_aps
    org_id
    sub_ana_entitled
    sub_ana_required
    sub_ast_entitled
    sub_ast_required
    sub_eng_entitled
    sub_eng_required
    sub_ex12_required
    sub_insufficient
    sub_man_entitled
    sub_man_required
    sub_me_entitled
    sub_vna_entitled
    sub_vna_required
    timestamp
    trial_enabled
    usage_types
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 298

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} msp_id: #{@msp_id.inspect}, name: #{@name.inspect}, num_aps:"\
  " #{@num_aps.inspect}, num_gateways: #{@num_gateways.inspect}, num_sites:"\
  " #{@num_sites.inspect}, num_switches: #{@num_switches.inspect}, num_unassigned_aps:"\
  " #{@num_unassigned_aps.inspect}, org_id: #{@org_id.inspect}, sub_ana_entitled:"\
  " #{@sub_ana_entitled.inspect}, sub_ana_required: #{@sub_ana_required.inspect},"\
  " sub_ast_entitled: #{@sub_ast_entitled.inspect}, sub_ast_required:"\
  " #{@sub_ast_required.inspect}, sub_eng_entitled: #{@sub_eng_entitled.inspect},"\
  " sub_eng_required: #{@sub_eng_required.inspect}, sub_ex12_required:"\
  " #{@sub_ex12_required.inspect}, sub_insufficient: #{@sub_insufficient.inspect},"\
  " sub_man_entitled: #{@sub_man_entitled.inspect}, sub_man_required:"\
  " #{@sub_man_required.inspect}, sub_me_entitled: #{@sub_me_entitled.inspect},"\
  " sub_vna_entitled: #{@sub_vna_entitled.inspect}, sub_vna_required:"\
  " #{@sub_vna_required.inspect}, timestamp: #{@timestamp.inspect}, trial_enabled:"\
  " #{@trial_enabled.inspect}, usage_types: #{@usage_types.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/mist_api/models/response_org_search_item.rb', line 282

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} msp_id: #{@msp_id}, name: #{@name}, num_aps: #{@num_aps}, num_gateways:"\
  " #{@num_gateways}, num_sites: #{@num_sites}, num_switches: #{@num_switches},"\
  " num_unassigned_aps: #{@num_unassigned_aps}, org_id: #{@org_id}, sub_ana_entitled:"\
  " #{@sub_ana_entitled}, sub_ana_required: #{@sub_ana_required}, sub_ast_entitled:"\
  " #{@sub_ast_entitled}, sub_ast_required: #{@sub_ast_required}, sub_eng_entitled:"\
  " #{@sub_eng_entitled}, sub_eng_required: #{@sub_eng_required}, sub_ex12_required:"\
  " #{@sub_ex12_required}, sub_insufficient: #{@sub_insufficient}, sub_man_entitled:"\
  " #{@sub_man_entitled}, sub_man_required: #{@sub_man_required}, sub_me_entitled:"\
  " #{@sub_me_entitled}, sub_vna_entitled: #{@sub_vna_entitled}, sub_vna_required:"\
  " #{@sub_vna_required}, timestamp: #{@timestamp}, trial_enabled: #{@trial_enabled},"\
  " usage_types: #{@usage_types}>"
end