Class: Akeyless::GatewayUpdateLogForwardingSyslog

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/gateway_update_log_forwarding_syslog.rb

Overview

gatewayUpdateLogForwardingSyslog is a command that updates log forwarding config (syslog target)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayUpdateLogForwardingSyslog

Initializes the object

Parameters:

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

    Model attributes in the form of hash



104
105
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 104

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

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

  if attributes.key?(:'formatter')
    self.formatter = attributes[:'formatter']
  else
    self.formatter = 'text'
  end

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

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

  if attributes.key?(:'network')
    self.network = attributes[:'network']
  else
    self.network = 'tcp'
  end

  if attributes.key?(:'output_format')
    self.output_format = attributes[:'output_format']
  else
    self.output_format = 'text'
  end

  if attributes.key?(:'pull_interval')
    self.pull_interval = attributes[:'pull_interval']
  else
    self.pull_interval = '10'
  end

  if attributes.key?(:'target_tag')
    self.target_tag = attributes[:'target_tag']
  else
    self.target_tag = 'use-existing'
  end

  if attributes.key?(:'tls_certificate')
    self.tls_certificate = attributes[:'tls_certificate']
  else
    self.tls_certificate = 'use-existing'
  end

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

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

Instance Attribute Details

#enable ⇒ Object

Enable Log Forwarding [true/false]



20
21
22
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 20

def enable
  @enable
end

#enable_tls ⇒ Object

Enable tls relevant only for network type TCP



23
24
25
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 23

def enable_tls
  @enable_tls
end

#formatter ⇒ Object

Syslog formatter [text/cef]



26
27
28
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 26

def formatter
  @formatter
end

#host ⇒ Object

Syslog host



29
30
31
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 29

def host
  @host
end

#json ⇒ Object

Set output format to JSON



32
33
34
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 32

def json
  @json
end

#network ⇒ Object

Syslog network [tcp/udp]



35
36
37
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 35

def network
  @network
end

#output_format ⇒ Object

Logs format [text/json]



38
39
40
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 38

def output_format
  @output_format
end

#pull_interval ⇒ Object

Pull interval in seconds



41
42
43
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 41

def pull_interval
  @pull_interval
end

#target_tag ⇒ Object

Syslog target tag



44
45
46
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 44

def target_tag
  @target_tag
end

#tls_certificate ⇒ Object

Syslog tls certificate



47
48
49
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 47

def tls_certificate
  @tls_certificate
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



50
51
52
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 50

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



53
54
55
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 53

def uid_token
  @uid_token
end

Class Method Details

._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



255
256
257
258
259
260
261
262
263
264
265
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
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 255

def self._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 = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 56

def self.attribute_map
  {
    :'enable' => :'enable',
    :'enable_tls' => :'enable-tls',
    :'formatter' => :'formatter',
    :'host' => :'host',
    :'json' => :'json',
    :'network' => :'network',
    :'output_format' => :'output-format',
    :'pull_interval' => :'pull-interval',
    :'target_tag' => :'target-tag',
    :'tls_certificate' => :'tls-certificate',
    :'token' => :'token',
    :'uid_token' => :'uid-token'
  }
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 231

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

List of attributes with nullable: true



97
98
99
100
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 79

def self.openapi_types
  {
    :'enable' => :'String',
    :'enable_tls' => :'Boolean',
    :'formatter' => :'String',
    :'host' => :'String',
    :'json' => :'Boolean',
    :'network' => :'String',
    :'output_format' => :'String',
    :'pull_interval' => :'String',
    :'target_tag' => :'String',
    :'tls_certificate' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enable == o.enable &&
      enable_tls == o.enable_tls &&
      formatter == o.formatter &&
      host == o.host &&
      json == o.json &&
      network == o.network &&
      output_format == o.output_format &&
      pull_interval == o.pull_interval &&
      target_tag == o.target_tag &&
      tls_certificate == o.tls_certificate &&
      token == o.token &&
      uid_token == o.uid_token
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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 326

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


218
219
220
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



224
225
226
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 224

def hash
  [enable, enable_tls, formatter, host, json, network, output_format, pull_interval, target_tag, tls_certificate, token, uid_token].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



184
185
186
187
188
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 184

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



302
303
304
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 302

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 308

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



296
297
298
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 296

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



192
193
194
195
 
# File 'lib/akeyless/models/gateway_update_log_forwarding_syslog.rb', line 192

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end