Class: ArtikCloud::Subscription

Inherits:
Object
  • Object
show all
Defined in:
lib/artikcloud/models/subscription.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Subscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/artikcloud/models/subscription.rb', line 117

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'awsRegion')
    self.aws_region = attributes[:'awsRegion']
  end

  if attributes.has_key?(:'includeSharedDevices')
    self.include_shared_devices = attributes[:'includeSharedDevices']
  end

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

  if attributes.has_key?(:'awsKey')
    self.aws_key = attributes[:'awsKey']
  end

  if attributes.has_key?(:'awsSecret')
    self.aws_secret = attributes[:'awsSecret']
  end

  if attributes.has_key?(:'createdOn')
    self.created_on = attributes[:'createdOn']
  end

  if attributes.has_key?(:'awsKinesisStreamName')
    self.aws_kinesis_stream_name = attributes[:'awsKinesisStreamName']
  end

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

  if attributes.has_key?(:'messageType')
    self.message_type = attributes[:'messageType']
  end

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

  if attributes.has_key?(:'subscriptionType')
    self.subscription_type = attributes[:'subscriptionType']
  end

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

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

  if attributes.has_key?(:'callbackUrl')
    self.callback_url = attributes[:'callbackUrl']
  end

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

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

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

end

Instance Attribute Details

#aid ⇒ Object

Application ID



63
64
65
 
# File 'lib/artikcloud/models/subscription.rb', line 63

def aid
  @aid
end

#aws_key ⇒ Object

AWS key (if subscriptionType is awsKinesis



27
28
29
 
# File 'lib/artikcloud/models/subscription.rb', line 27

def aws_key
  @aws_key
end

#aws_kinesis_stream_name ⇒ Object

AWS Kinesis stream name (if subscriptionType is awsKinesis



36
37
38
 
# File 'lib/artikcloud/models/subscription.rb', line 36

def aws_kinesis_stream_name
  @aws_kinesis_stream_name
end

#aws_region ⇒ Object

AWS region (if subscriptionType is awsKinesis



18
19
20
 
# File 'lib/artikcloud/models/subscription.rb', line 18

def aws_region
  @aws_region
end

#aws_secret ⇒ Object

AWS secret (if subscriptionType is awsKinesis



30
31
32
 
# File 'lib/artikcloud/models/subscription.rb', line 30

def aws_secret
  @aws_secret
end

#callback_url ⇒ Object

Callback URL



57
58
59
 
# File 'lib/artikcloud/models/subscription.rb', line 57

def callback_url
  @callback_url
end

#created_on ⇒ Object

Creation timestamp



33
34
35
 
# File 'lib/artikcloud/models/subscription.rb', line 33

def created_on
  @created_on
end

#ddid ⇒ Object

Destination device ID



45
46
47
 
# File 'lib/artikcloud/models/subscription.rb', line 45

def ddid
  @ddid
end

#description ⇒ Object

Description



24
25
26
 
# File 'lib/artikcloud/models/subscription.rb', line 24

def description
  @description
end

#id ⇒ Object

Subscription ID



60
61
62
 
# File 'lib/artikcloud/models/subscription.rb', line 60

def id
  @id
end

#include_shared_devices ⇒ Object

Include Shared Devices



21
22
23
 
# File 'lib/artikcloud/models/subscription.rb', line 21

def include_shared_devices
  @include_shared_devices
end

#message_type ⇒ Object

Message type



42
43
44
 
# File 'lib/artikcloud/models/subscription.rb', line 42

def message_type
  @message_type
end

#name ⇒ Object

Name



51
52
53
 
# File 'lib/artikcloud/models/subscription.rb', line 51

def name
  @name
end

#sdid ⇒ Object

Source device ID



54
55
56
 
# File 'lib/artikcloud/models/subscription.rb', line 54

def sdid
  @sdid
end

#sdtid ⇒ Object

Source device type ID



66
67
68
 
# File 'lib/artikcloud/models/subscription.rb', line 66

def sdtid
  @sdtid
end

#subscription_type ⇒ Object

Subscription type (either httpCallback or awsKinesis, default to httpCallback)



48
49
50
 
# File 'lib/artikcloud/models/subscription.rb', line 48

def subscription_type
  @subscription_type
end

#uid ⇒ Object

User ID



39
40
41
 
# File 'lib/artikcloud/models/subscription.rb', line 39

def uid
  @uid
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/artikcloud/models/subscription.rb', line 70

def self.attribute_map
  {
    :'aws_region' => :'awsRegion',
    :'include_shared_devices' => :'includeSharedDevices',
    :'description' => :'description',
    :'aws_key' => :'awsKey',
    :'aws_secret' => :'awsSecret',
    :'created_on' => :'createdOn',
    :'aws_kinesis_stream_name' => :'awsKinesisStreamName',
    :'uid' => :'uid',
    :'message_type' => :'messageType',
    :'ddid' => :'ddid',
    :'subscription_type' => :'subscriptionType',
    :'name' => :'name',
    :'sdid' => :'sdid',
    :'callback_url' => :'callbackUrl',
    :'id' => :'id',
    :'aid' => :'aid',
    :'sdtid' => :'sdtid'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/artikcloud/models/subscription.rb', line 93

def self.swagger_types
  {
    :'aws_region' => :'String',
    :'include_shared_devices' => :'BOOLEAN',
    :'description' => :'String',
    :'aws_key' => :'String',
    :'aws_secret' => :'String',
    :'created_on' => :'Integer',
    :'aws_kinesis_stream_name' => :'String',
    :'uid' => :'String',
    :'message_type' => :'String',
    :'ddid' => :'String',
    :'subscription_type' => :'String',
    :'name' => :'String',
    :'sdid' => :'String',
    :'callback_url' => :'String',
    :'id' => :'String',
    :'aid' => :'String',
    :'sdtid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/artikcloud/models/subscription.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      aws_region == o.aws_region &&
      include_shared_devices == o.include_shared_devices &&
      description == o.description &&
      aws_key == o.aws_key &&
      aws_secret == o.aws_secret &&
      created_on == o.created_on &&
      aws_kinesis_stream_name == o.aws_kinesis_stream_name &&
      uid == o.uid &&
      message_type == o.message_type &&
      ddid == o.ddid &&
      subscription_type == o.subscription_type &&
      name == o.name &&
      sdid == o.sdid &&
      callback_url == o.callback_url &&
      id == o.id &&
      aid == o.aid &&
      sdtid == o.sdtid
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/artikcloud/models/subscription.rb', line 266

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
    temp_model = ArtikCloud.const_get(type).new
    temp_model.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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/artikcloud/models/subscription.rb', line 332

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/artikcloud/models/subscription.rb', line 245

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


232
233
234
 
# File 'lib/artikcloud/models/subscription.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



238
239
240
 
# File 'lib/artikcloud/models/subscription.rb', line 238

def hash
  [aws_region, include_shared_devices, description, aws_key, aws_secret, created_on, aws_kinesis_stream_name, uid, message_type, ddid, subscription_type, name, sdid, callback_url, id, aid, sdtid].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



195
196
197
198
 
# File 'lib/artikcloud/models/subscription.rb', line 195

def list_invalid_properties
  invalid_properties = Array.new
  return 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



312
313
314
 
# File 'lib/artikcloud/models/subscription.rb', line 312

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



318
319
320
321
322
323
324
325
326
 
# File 'lib/artikcloud/models/subscription.rb', line 318

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



306
307
308
 
# File 'lib/artikcloud/models/subscription.rb', line 306

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



202
203
204
 
# File 'lib/artikcloud/models/subscription.rb', line 202

def valid?
  return true
end