Class: IntersightClient::AssetHttpConnection

Inherits:
AssetConnection show all
Defined in:
lib/intersight_client/models/asset_http_connection.rb

Overview

HttpConnection provides the necessary details for Intersight to connect to and authenticate with a managed target over an HTTP connection.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from AssetConnection

#credential

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetHttpConnection

Initializes the object



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
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 114

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::AssetHttpConnection` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'asset.HttpConnection'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'asset.HttpConnection'
  end

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

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

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

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

Instance Attribute Details

#certificate_authority ⇒ Object

The certificate authority of the target. If set and connection is secure the connection will be validate using the servers identity with this certificate. If not set no validation will be done of the identity.



26
27
28
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 26

def certificate_authority
  @certificate_authority
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 20

def class_id
  @class_id
end

#is_secure ⇒ Object

Indicates whether a connection to the target should be established using HTTPS.



29
30
31
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 29

def is_secure
  @is_secure
end

#management_address ⇒ Object

The DNS hostname or IP Address, either IPv4 or IPv6, to be used to connect to the managed target.



32
33
34
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 32

def management_address
  @management_address
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 23

def object_type
  @object_type
end

#port ⇒ Object

The port number to be used to connect to the managed target. Values 1-65535 indicate a port number to be used. A value of 0 is not a valid port number and instead indicates that the default management port, as defined by the documentation of the managed target, should be used to establish a connection.



35
36
37
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 35

def port
  @port
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



77
78
79
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 77

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



72
73
74
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 72

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 60

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'certificate_authority' => :'CertificateAuthority',
    :'is_secure' => :'IsSecure',
    :'management_address' => :'ManagementAddress',
    :'port' => :'Port'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



260
261
262
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 260

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



100
101
102
103
104
105
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 100

def self.openapi_all_of
  [
  :'AssetConnection',
  :'AssetHttpConnectionAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



108
109
110
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 108

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 82

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'certificate_authority' => :'String',
    :'is_secure' => :'Boolean',
    :'management_address' => :'String',
    :'port' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      certificate_authority == o.certificate_authority &&
      is_secure == o.is_secure &&
      management_address == o.management_address &&
      port == o.port && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 291

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 362

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 267

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

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


247
248
249
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



253
254
255
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 253

def hash
  [class_id, object_type, certificate_authority, is_secure, management_address, port].hash
end

#list_invalid_properties ⇒ Object

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 163

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

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

  if !@port.nil? && @port > 65535
    invalid_properties.push('invalid value for "port", must be smaller than or equal to 65535.')
  end

  if !@port.nil? && @port < 0
    invalid_properties.push('invalid value for "port", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



338
339
340
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 338

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 344

def to_hash
  hash = super
  AssetHttpConnection.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = AssetHttpConnection.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



332
333
334
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 332

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/intersight_client/models/asset_http_connection.rb', line 186

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["asset.HttpConnection"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["asset.HttpConnection"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@port.nil? && @port > 65535
  return false if !@port.nil? && @port < 0
  true && super
end