Class: Fastly::LoggingSftp

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/logging_sftp.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoggingSftp

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/fastly/models/logging_sftp.rb', line 169

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

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

  if attributes.key?(:'format_version')
    self.format_version = attributes[:'format_version']
  else
    self.format_version = FORMAT_VERSION::v2
  end

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

  if attributes.key?(:'format')
    self.format = attributes[:'format']
  else
    self.format = '%h %l %u %t \"%r\" %>s %b'
  end

  if attributes.key?(:'message_type')
    self.message_type = attributes[:'message_type']
  else
    self.message_type = 'classic'
  end

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

  if attributes.key?(:'period')
    self.period = attributes[:'period']
  else
    self.period = 3600
  end

  if attributes.key?(:'gzip_level')
    self.gzip_level = attributes[:'gzip_level']
  else
    self.gzip_level = 0
  end

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

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

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

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

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

  if attributes.key?(:'public_key')
    self.public_key = attributes[:'public_key']
  else
    self.public_key = 'null'
  end

  if attributes.key?(:'secret_key')
    self.secret_key = attributes[:'secret_key']
  else
    self.secret_key = 'null'
  end

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

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

Instance Attribute Details

#address ⇒ Object

A hostname or IPv4 address.



47
48
49
 
# File 'lib/fastly/models/logging_sftp.rb', line 47

def address
  @address
end

#compression_codec ⇒ Object

The codec used for compressing your logs. Valid values are ‘zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.



44
45
46
 
# File 'lib/fastly/models/logging_sftp.rb', line 44

def compression_codec
  @compression_codec
end

#format ⇒ Object

A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats).



29
30
31
 
# File 'lib/fastly/models/logging_sftp.rb', line 29

def format
  @format
end

#format_version ⇒ Object

The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in ‘vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.



23
24
25
 
# File 'lib/fastly/models/logging_sftp.rb', line 23

def format_version
  @format_version
end

#gzip_level ⇒ Object

The level of gzip encoding when sending logs (default ‘0`, no compression). Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.



41
42
43
 
# File 'lib/fastly/models/logging_sftp.rb', line 41

def gzip_level
  @gzip_level
end

#message_type ⇒ Object

How the message should be formatted.



32
33
34
 
# File 'lib/fastly/models/logging_sftp.rb', line 32

def message_type
  @message_type
end

#name ⇒ Object

The name for the real-time logging configuration.



17
18
19
 
# File 'lib/fastly/models/logging_sftp.rb', line 17

def name
  @name
end

#password ⇒ Object

The password for the server. If both ‘password` and `secret_key` are passed, `secret_key` will be used in preference.



53
54
55
 
# File 'lib/fastly/models/logging_sftp.rb', line 53

def password
  @password
end

#path ⇒ Object

The path to upload logs to.



56
57
58
 
# File 'lib/fastly/models/logging_sftp.rb', line 56

def path
  @path
end

#period ⇒ Object

How frequently log files are finalized so they can be available for reading (in seconds).



38
39
40
 
# File 'lib/fastly/models/logging_sftp.rb', line 38

def period
  @period
end

#placement ⇒ Object

Where in the generated VCL the logging call should be placed. If not set, endpoints with ‘format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.



20
21
22
 
# File 'lib/fastly/models/logging_sftp.rb', line 20

def placement
  @placement
end

#port ⇒ Object

The port number.



50
51
52
 
# File 'lib/fastly/models/logging_sftp.rb', line 50

def port
  @port
end

#public_key ⇒ Object

A PGP public key that Fastly will use to encrypt your log files before writing them to disk.



59
60
61
 
# File 'lib/fastly/models/logging_sftp.rb', line 59

def public_key
  @public_key
end

#response_condition ⇒ Object

The name of an existing condition in the configured endpoint, or leave blank to always execute.



26
27
28
 
# File 'lib/fastly/models/logging_sftp.rb', line 26

def response_condition
  @response_condition
end

#secret_key ⇒ Object

The SSH private key for the server. If both ‘password` and `secret_key` are passed, `secret_key` will be used in preference.



62
63
64
 
# File 'lib/fastly/models/logging_sftp.rb', line 62

def secret_key
  @secret_key
end

#ssh_known_hosts ⇒ Object

A list of host keys for all hosts we can connect to over SFTP.



65
66
67
 
# File 'lib/fastly/models/logging_sftp.rb', line 65

def ssh_known_hosts
  @ssh_known_hosts
end

#timestamp_format ⇒ Object

A timestamp format



35
36
37
 
# File 'lib/fastly/models/logging_sftp.rb', line 35

def timestamp_format
  @timestamp_format
end

#user ⇒ Object

The username for the server.



68
69
70
 
# File 'lib/fastly/models/logging_sftp.rb', line 68

def user
  @user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



117
118
119
 
# File 'lib/fastly/models/logging_sftp.rb', line 117

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/fastly/models/logging_sftp.rb', line 93

def self.attribute_map
  {
    :'name' => :'name',
    :'placement' => :'placement',
    :'format_version' => :'format_version',
    :'response_condition' => :'response_condition',
    :'format' => :'format',
    :'message_type' => :'message_type',
    :'timestamp_format' => :'timestamp_format',
    :'period' => :'period',
    :'gzip_level' => :'gzip_level',
    :'compression_codec' => :'compression_codec',
    :'address' => :'address',
    :'port' => :'port',
    :'password' => :'password',
    :'path' => :'path',
    :'public_key' => :'public_key',
    :'secret_key' => :'secret_key',
    :'ssh_known_hosts' => :'ssh_known_hosts',
    :'user' => :'user'
  }
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



374
375
376
 
# File 'lib/fastly/models/logging_sftp.rb', line 374

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

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



158
159
160
161
162
163
164
165
 
# File 'lib/fastly/models/logging_sftp.rb', line 158

def self.fastly_all_of
  [
  :'LoggingAddressAndPort',
  :'LoggingCommon',
  :'LoggingGenericCommon',
  :'LoggingSftpAllOf'
  ]
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/fastly/models/logging_sftp.rb', line 146

def self.fastly_nullable
  Set.new([
    :'placement',
    :'response_condition',
    :'timestamp_format',
    :'path',
    :'public_key',
    :'secret_key',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/fastly/models/logging_sftp.rb', line 122

def self.fastly_types
  {
    :'name' => :'String',
    :'placement' => :'String',
    :'format_version' => :'Integer',
    :'response_condition' => :'String',
    :'format' => :'String',
    :'message_type' => :'String',
    :'timestamp_format' => :'String',
    :'period' => :'Integer',
    :'gzip_level' => :'Integer',
    :'compression_codec' => :'String',
    :'address' => :'String',
    :'port' => :'Integer',
    :'password' => :'String',
    :'path' => :'String',
    :'public_key' => :'String',
    :'secret_key' => :'String',
    :'ssh_known_hosts' => :'String',
    :'user' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/fastly/models/logging_sftp.rb', line 336

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      placement == o.placement &&
      format_version == o.format_version &&
      response_condition == o.response_condition &&
      format == o.format &&
      message_type == o.message_type &&
      timestamp_format == o.timestamp_format &&
      period == o.period &&
      gzip_level == o.gzip_level &&
      compression_codec == o.compression_codec &&
      address == o.address &&
      port == o.port &&
      password == o.password &&
      path == o.path &&
      public_key == o.public_key &&
      secret_key == o.secret_key &&
      ssh_known_hosts == o.ssh_known_hosts &&
      user == o.user
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



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/fastly/models/logging_sftp.rb', line 404

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 = Fastly.const_get(type)
    klass.respond_to?(:fastly_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



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/fastly/models/logging_sftp.rb', line 475

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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/fastly/models/logging_sftp.rb', line 381

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


361
362
363
 
# File 'lib/fastly/models/logging_sftp.rb', line 361

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



367
368
369
 
# File 'lib/fastly/models/logging_sftp.rb', line 367

def hash
  [name, placement, format_version, response_condition, format, message_type, timestamp_format, period, gzip_level, compression_codec, address, port, password, path, public_key, secret_key, ssh_known_hosts, user].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



275
276
277
278
 
# File 'lib/fastly/models/logging_sftp.rb', line 275

def list_invalid_properties
  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



451
452
453
 
# File 'lib/fastly/models/logging_sftp.rb', line 451

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



457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/fastly/models/logging_sftp.rb', line 457

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



445
446
447
 
# File 'lib/fastly/models/logging_sftp.rb', line 445

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



282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/fastly/models/logging_sftp.rb', line 282

def valid?
  placement_validator = EnumAttributeValidator.new('String', ["none", "waf_debug", "null"])
  return false unless placement_validator.valid?(@placement)
  format_version_validator = EnumAttributeValidator.new('Integer', [1, 2])
  return false unless format_version_validator.valid?(@format_version)
  message_type_validator = EnumAttributeValidator.new('String', ["classic", "loggly", "logplex", "blank"])
  return false unless message_type_validator.valid?(@message_type)
  compression_codec_validator = EnumAttributeValidator.new('String', ["zstd", "snappy", "gzip"])
  return false unless compression_codec_validator.valid?(@compression_codec)
  true
end