Class: IntersightClient::SyslogRemoteClientBaseAllOf

Inherits:
Object
  • Object
show all
Defined in:
lib/intersight_client/models/syslog_remote_client_base_all_of.rb

Overview

Definition of the list of properties defined in ‘syslog.RemoteClientBase’, excluding properties defined in parent classes.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SyslogRemoteClientBaseAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
108
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::SyslogRemoteClientBaseAllOf` 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
  }

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

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

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

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

  if attributes.key?(:'min_severity')
    self.min_severity = attributes[:'min_severity']
  else
    self.min_severity = 'warning'
  end

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

  if attributes.key?(:'protocol')
    self.protocol = attributes[:'protocol']
  else
    self.protocol = 'udp'
  end
end

Instance Attribute Details

#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. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def class_id
  @class_id
end

#enabled ⇒ Object

Enables/disables remote logging for the endpoint If enabled, log messages will be sent to the syslog server mentioned in the Hostname/IP Address field.



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

def enabled
  @enabled
end

#hostname ⇒ Object

Hostname or IP Address of the syslog server where log should be stored.



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

def hostname
  @hostname
end

#min_severity ⇒ Object

Lowest level of messages to be included in the remote log. * ‘warning` - Use logging level warning for logs classified as warning. * `emergency` - Use logging level emergency for logs classified as emergency. * `alert` - Use logging level alert for logs classified as alert. * `critical` - Use logging level critical for logs classified as critical. * `error` - Use logging level error for logs classified as error. * `notice` - Use logging level notice for logs classified as notice. * `informational` - Use logging level informational for logs classified as informational. * `debug` - Use logging level debug for logs classified as debug.



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

def min_severity
  @min_severity
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def object_type
  @object_type
end

#port ⇒ Object

Port number used for logging on syslog server.



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

def port
  @port
end

#protocol ⇒ Object

Transport layer protocol for transmission of log messages to syslog server. * ‘udp` - Use User Datagram Protocol (UDP) for syslog remote server connection. * `tcp` - Use Transmission Control Protocol (TCP) for syslog remote server connection.



38
39
40
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 38

def protocol
  @protocol
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



81
82
83
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 81

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 63

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'enabled' => :'Enabled',
    :'hostname' => :'Hostname',
    :'min_severity' => :'MinSeverity',
    :'port' => :'Port',
    :'protocol' => :'Protocol'
  }
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



284
285
286
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 284

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 86

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'enabled' => :'Boolean',
    :'hostname' => :'String',
    :'min_severity' => :'String',
    :'port' => :'Integer',
    :'protocol' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      enabled == o.enabled &&
      hostname == o.hostname &&
      min_severity == o.min_severity &&
      port == o.port &&
      protocol == o.protocol
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



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
346
347
348
349
350
351
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 314

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 385

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 291

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


271
272
273
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 277

def hash
  [class_id, object_type, enabled, hostname, min_severity, port, protocol].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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 < 1
    invalid_properties.push('invalid value for "port", must be greater than or equal to 1.')
  end

  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



361
362
363
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 367

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

Returns:

  • (String) —

    String presentation of the object



355
356
357
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 355

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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/intersight_client/models/syslog_remote_client_base_all_of.rb', line 185

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["syslog.RemoteLoggingClient"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["syslog.RemoteLoggingClient"])
  return false unless object_type_validator.valid?(@object_type)
  min_severity_validator = EnumAttributeValidator.new('String', ["warning", "emergency", "alert", "critical", "error", "notice", "informational", "debug"])
  return false unless min_severity_validator.valid?(@min_severity)
  return false if !@port.nil? && @port > 65535
  return false if !@port.nil? && @port < 1
  protocol_validator = EnumAttributeValidator.new('String', ["udp", "tcp"])
  return false unless protocol_validator.valid?(@protocol)
  true
end