Class: Bandwidth::EndpointEvent

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/endpoint_event.rb

Overview

An event that occurred on an endpoint.

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ EndpointEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 119

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#creation_timestamp ⇒ Object

The time the endpoint was created. In ISO-8601 format.



27
28
29
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 27

def creation_timestamp
  @creation_timestamp
end

#device ⇒ Object

Returns the value of attribute device.



40
41
42
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 40

def device
  @device
end

#endpoint_id ⇒ Object

The unique ID of the endpoint.



20
21
22
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 20

def endpoint_id
  @endpoint_id
end

#event_time ⇒ Object

The time the event occurred. In ISO-8601 format.



36
37
38
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 36

def event_time
  @event_time
end

#event_type ⇒ Object

Returns the value of attribute event_type.



38
39
40
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 38

def event_type
  @event_type
end

#expiration_timestamp ⇒ Object

The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours.



30
31
32
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 30

def expiration_timestamp
  @expiration_timestamp
end

#status ⇒ Object

Returns the value of attribute status.



24
25
26
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 24

def status
  @status
end

#tag ⇒ Object

A tag for the endpoint.



33
34
35
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 33

def tag
  @tag
end

#type ⇒ Object

Returns the value of attribute type.



22
23
24
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 22

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



80
81
82
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 80

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 85

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 65

def self.attribute_map
  {
    :'endpoint_id' => :'endpointId',
    :'type' => :'type',
    :'status' => :'status',
    :'creation_timestamp' => :'creationTimestamp',
    :'expiration_timestamp' => :'expirationTimestamp',
    :'tag' => :'tag',
    :'event_time' => :'eventTime',
    :'event_type' => :'eventType',
    :'device' => :'device'
  }
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 345

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



111
112
113
114
115
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 111

def self.openapi_all_of
  [
  :'Endpoints'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 105

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 90

def self.openapi_types
  {
    :'endpoint_id' => :'String',
    :'type' => :'EndpointTypeEnum',
    :'status' => :'EndpointStatusEnum',
    :'creation_timestamp' => :'Time',
    :'expiration_timestamp' => :'Time',
    :'tag' => :'String',
    :'event_time' => :'Time',
    :'event_type' => :'EndpointEventTypeEnum',
    :'device' => :'Device'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      endpoint_id == o.endpoint_id &&
      type == o.type &&
      status == o.status &&
      creation_timestamp == o.creation_timestamp &&
      expiration_timestamp == o.expiration_timestamp &&
      tag == o.tag &&
      event_time == o.event_time &&
      event_type == o.event_type &&
      device == o.device
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


332
333
334
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 332

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



338
339
340
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 338

def hash
  [endpoint_id, type, status, creation_timestamp, expiration_timestamp, tag, event_time, event_type, device].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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 186

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

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

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

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

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

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

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 367

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



222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/bandwidth-sdk/models/endpoint_event.rb', line 222

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @endpoint_id.nil?
  return false if @type.nil?
  return false if @status.nil?
  return false if @creation_timestamp.nil?
  return false if @expiration_timestamp.nil?
  return false if @event_time.nil?
  return false if @event_type.nil?
  true
end