Class: SourcesApiClient::Endpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/sources-api-client/models/endpoint.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Endpoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
192
193
194
# File 'lib/sources-api-client/models/endpoint.rb', line 114

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#availability_statusObject

Returns the value of attribute availability_status


17
18
19
# File 'lib/sources-api-client/models/endpoint.rb', line 17

def availability_status
  @availability_status
end

#availability_status_errorObject

Returns the value of attribute availability_status_error


19
20
21
# File 'lib/sources-api-client/models/endpoint.rb', line 19

def availability_status_error
  @availability_status_error
end

#certificate_authorityObject

Optional X.509 Certificate Authority


22
23
24
# File 'lib/sources-api-client/models/endpoint.rb', line 22

def certificate_authority
  @certificate_authority
end

#created_atObject

Returns the value of attribute created_at


24
25
26
# File 'lib/sources-api-client/models/endpoint.rb', line 24

def created_at
  @created_at
end

#defaultObject

Returns the value of attribute default


26
27
28
# File 'lib/sources-api-client/models/endpoint.rb', line 26

def default
  @default
end

#hostObject

URI host component


29
30
31
# File 'lib/sources-api-client/models/endpoint.rb', line 29

def host
  @host
end

#idObject

ID of the resource


32
33
34
# File 'lib/sources-api-client/models/endpoint.rb', line 32

def id
  @id
end

#last_available_atObject

Returns the value of attribute last_available_at


34
35
36
# File 'lib/sources-api-client/models/endpoint.rb', line 34

def last_available_at
  @last_available_at
end

#last_checked_atObject

Returns the value of attribute last_checked_at


36
37
38
# File 'lib/sources-api-client/models/endpoint.rb', line 36

def last_checked_at
  @last_checked_at
end

#pathObject

URI path component


39
40
41
# File 'lib/sources-api-client/models/endpoint.rb', line 39

def path
  @path
end

#portObject

URI port component


42
43
44
# File 'lib/sources-api-client/models/endpoint.rb', line 42

def port
  @port
end

#receptor_nodeObject

Identifier of a receptor node


45
46
47
# File 'lib/sources-api-client/models/endpoint.rb', line 45

def receptor_node
  @receptor_node
end

#roleObject

Returns the value of attribute role


47
48
49
# File 'lib/sources-api-client/models/endpoint.rb', line 47

def role
  @role
end

#schemeObject

URI scheme component


50
51
52
# File 'lib/sources-api-client/models/endpoint.rb', line 50

def scheme
  @scheme
end

#source_idObject

ID of the resource


53
54
55
# File 'lib/sources-api-client/models/endpoint.rb', line 53

def source_id
  @source_id
end

#updated_atObject

Returns the value of attribute updated_at


55
56
57
# File 'lib/sources-api-client/models/endpoint.rb', line 55

def updated_at
  @updated_at
end

#verify_sslObject

Should SSL be verified


58
59
60
# File 'lib/sources-api-client/models/endpoint.rb', line 58

def verify_ssl
  @verify_ssl
end

Class Method Details

.attribute_mapObject

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


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/sources-api-client/models/endpoint.rb', line 61

def self.attribute_map
  {
    :'availability_status' => :'availability_status',
    :'availability_status_error' => :'availability_status_error',
    :'certificate_authority' => :'certificate_authority',
    :'created_at' => :'created_at',
    :'default' => :'default',
    :'host' => :'host',
    :'id' => :'id',
    :'last_available_at' => :'last_available_at',
    :'last_checked_at' => :'last_checked_at',
    :'path' => :'path',
    :'port' => :'port',
    :'receptor_node' => :'receptor_node',
    :'role' => :'role',
    :'scheme' => :'scheme',
    :'source_id' => :'source_id',
    :'updated_at' => :'updated_at',
    :'verify_ssl' => :'verify_ssl'
  }
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


282
283
284
# File 'lib/sources-api-client/models/endpoint.rb', line 282

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

.openapi_nullableObject

List of attributes with nullable: true


107
108
109
110
# File 'lib/sources-api-client/models/endpoint.rb', line 107

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

.openapi_typesObject

Attribute type mapping.


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/sources-api-client/models/endpoint.rb', line 84

def self.openapi_types
  {
    :'availability_status' => :'String',
    :'availability_status_error' => :'String',
    :'certificate_authority' => :'String',
    :'created_at' => :'DateTime',
    :'default' => :'Boolean',
    :'host' => :'String',
    :'id' => :'String',
    :'last_available_at' => :'DateTime',
    :'last_checked_at' => :'DateTime',
    :'path' => :'String',
    :'port' => :'Integer',
    :'receptor_node' => :'String',
    :'role' => :'String',
    :'scheme' => :'String',
    :'source_id' => :'String',
    :'updated_at' => :'DateTime',
    :'verify_ssl' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/sources-api-client/models/endpoint.rb', line 245

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      availability_status == o.availability_status &&
      availability_status_error == o.availability_status_error &&
      certificate_authority == o.certificate_authority &&
      created_at == o.created_at &&
      default == o.default &&
      host == o.host &&
      id == o.id &&
      last_available_at == o.last_available_at &&
      last_checked_at == o.last_checked_at &&
      path == o.path &&
      port == o.port &&
      receptor_node == o.receptor_node &&
      role == o.role &&
      scheme == o.scheme &&
      source_id == o.source_id &&
      updated_at == o.updated_at &&
      verify_ssl == o.verify_ssl
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


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'lib/sources-api-client/models/endpoint.rb', line 310

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
    SourcesApiClient.const_get(type).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


379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/sources-api-client/models/endpoint.rb', line 379

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


289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/sources-api-client/models/endpoint.rb', line 289

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # 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

269
270
271
# File 'lib/sources-api-client/models/endpoint.rb', line 269

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


275
276
277
# File 'lib/sources-api-client/models/endpoint.rb', line 275

def hash
  [availability_status, availability_status_error, certificate_authority, created_at, default, host, id, last_available_at, last_checked_at, path, port, receptor_node, role, scheme, source_id, updated_at, verify_ssl].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/sources-api-client/models/endpoint.rb', line 198

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d+$/)
  if !@id.nil? && @id !~ pattern
    invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+$/)
  if !@source_id.nil? && @source_id !~ pattern
    invalid_properties.push("invalid value for \"source_id\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


355
356
357
# File 'lib/sources-api-client/models/endpoint.rb', line 355

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/sources-api-client/models/endpoint.rb', line 361

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


349
350
351
# File 'lib/sources-api-client/models/endpoint.rb', line 349

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


215
216
217
218
219
# File 'lib/sources-api-client/models/endpoint.rb', line 215

def valid?
  return false if !@id.nil? && @id !~ Regexp.new(/^\d+$/)
  return false if !@source_id.nil? && @source_id !~ Regexp.new(/^\d+$/)
  true
end