Class: Fastly::LoggingKafka
- Inherits:
-
Object
- Object
- Fastly::LoggingKafka
- Defined in:
- lib/fastly/models/logging_kafka.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#auth_method ⇒ Object
SASL authentication method.
-
#brokers ⇒ Object
A comma-separated list of IP addresses or hostnames of Kafka brokers.
-
#compression_codec ⇒ Object
The codec used for compression of your logs.
-
#format ⇒ Object
A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats).
-
#format_version ⇒ Object
The version of the custom logging format used for the configured endpoint.
-
#name ⇒ Object
The name for the real-time logging configuration.
-
#parse_log_keyvals ⇒ Object
Enables parsing of key=value tuples from the beginning of a logline, turning them into [record headers](cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers).
-
#password ⇒ Object
SASL password.
-
#placement ⇒ Object
Where in the generated VCL the logging call should be placed.
-
#request_max_bytes ⇒ Object
The maximum number of bytes sent in one request.
-
#required_acks ⇒ Object
The number of acknowledgements a leader must receive before a write is considered successful.
-
#response_condition ⇒ Object
The name of an existing condition in the configured endpoint, or leave blank to always execute.
-
#tls_ca_cert ⇒ Object
A secure certificate to authenticate a server with.
-
#tls_client_cert ⇒ Object
The client certificate used to make authenticated requests.
-
#tls_client_key ⇒ Object
The client private key used to make authenticated requests.
-
#tls_hostname ⇒ Object
The hostname to verify the server’s certificate.
-
#topic ⇒ Object
The Kafka topic to send logs to.
-
#use_tls ⇒ Object
Returns the value of attribute use_tls.
-
#user ⇒ Object
SASL user.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.fastly_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3).
-
.fastly_nullable ⇒ Object
List of attributes with nullable: true.
-
.fastly_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ LoggingKafka
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ LoggingKafka
Initializes the object
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 272 273 274 275 276 277 278 279 |
# File 'lib/fastly/models/logging_kafka.rb', line 173 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingKafka` 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::LoggingKafka`. 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?(:'tls_ca_cert') self.tls_ca_cert = attributes[:'tls_ca_cert'] else self.tls_ca_cert = 'null' end if attributes.key?(:'tls_client_cert') self.tls_client_cert = attributes[:'tls_client_cert'] else self.tls_client_cert = 'null' end if attributes.key?(:'tls_client_key') self.tls_client_key = attributes[:'tls_client_key'] else self.tls_client_key = 'null' end if attributes.key?(:'tls_hostname') self.tls_hostname = attributes[:'tls_hostname'] else self.tls_hostname = 'null' end if attributes.key?(:'topic') self.topic = attributes[:'topic'] end if attributes.key?(:'brokers') self.brokers = attributes[:'brokers'] end if attributes.key?(:'compression_codec') self.compression_codec = attributes[:'compression_codec'] end if attributes.key?(:'required_acks') self.required_acks = attributes[:'required_acks'] else self.required_acks = REQUIRED_ACKS::one end if attributes.key?(:'request_max_bytes') self.request_max_bytes = attributes[:'request_max_bytes'] else self.request_max_bytes = 0 end if attributes.key?(:'parse_log_keyvals') self.parse_log_keyvals = attributes[:'parse_log_keyvals'] end if attributes.key?(:'auth_method') self.auth_method = attributes[:'auth_method'] end if attributes.key?(:'user') self.user = attributes[:'user'] end if attributes.key?(:'password') self.password = attributes[:'password'] end if attributes.key?(:'use_tls') self.use_tls = attributes[:'use_tls'] else self.use_tls = LoggingUseTls::no_tls end end |
Instance Attribute Details
#auth_method ⇒ Object
SASL authentication method.
62 63 64 |
# File 'lib/fastly/models/logging_kafka.rb', line 62 def auth_method @auth_method end |
#brokers ⇒ Object
A comma-separated list of IP addresses or hostnames of Kafka brokers. Required.
47 48 49 |
# File 'lib/fastly/models/logging_kafka.rb', line 47 def brokers @brokers end |
#compression_codec ⇒ Object
The codec used for compression of your logs.
50 51 52 |
# File 'lib/fastly/models/logging_kafka.rb', line 50 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_kafka.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_kafka.rb', line 23 def format_version @format_version end |
#name ⇒ Object
The name for the real-time logging configuration.
17 18 19 |
# File 'lib/fastly/models/logging_kafka.rb', line 17 def name @name end |
#parse_log_keyvals ⇒ Object
Enables parsing of key=value tuples from the beginning of a logline, turning them into [record headers](cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers).
59 60 61 |
# File 'lib/fastly/models/logging_kafka.rb', line 59 def parse_log_keyvals @parse_log_keyvals end |
#password ⇒ Object
SASL password.
68 69 70 |
# File 'lib/fastly/models/logging_kafka.rb', line 68 def password @password 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_kafka.rb', line 20 def placement @placement end |
#request_max_bytes ⇒ Object
The maximum number of bytes sent in one request. Defaults ‘0` (no limit).
56 57 58 |
# File 'lib/fastly/models/logging_kafka.rb', line 56 def request_max_bytes @request_max_bytes end |
#required_acks ⇒ Object
The number of acknowledgements a leader must receive before a write is considered successful.
53 54 55 |
# File 'lib/fastly/models/logging_kafka.rb', line 53 def required_acks @required_acks 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_kafka.rb', line 26 def response_condition @response_condition end |
#tls_ca_cert ⇒ Object
A secure certificate to authenticate a server with. Must be in PEM format.
32 33 34 |
# File 'lib/fastly/models/logging_kafka.rb', line 32 def tls_ca_cert @tls_ca_cert end |
#tls_client_cert ⇒ Object
The client certificate used to make authenticated requests. Must be in PEM format.
35 36 37 |
# File 'lib/fastly/models/logging_kafka.rb', line 35 def tls_client_cert @tls_client_cert end |
#tls_client_key ⇒ Object
The client private key used to make authenticated requests. Must be in PEM format.
38 39 40 |
# File 'lib/fastly/models/logging_kafka.rb', line 38 def tls_client_key @tls_client_key end |
#tls_hostname ⇒ Object
The hostname to verify the server’s certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported.
41 42 43 |
# File 'lib/fastly/models/logging_kafka.rb', line 41 def tls_hostname @tls_hostname end |
#topic ⇒ Object
The Kafka topic to send logs to. Required.
44 45 46 |
# File 'lib/fastly/models/logging_kafka.rb', line 44 def topic @topic end |
#use_tls ⇒ Object
Returns the value of attribute use_tls.
70 71 72 |
# File 'lib/fastly/models/logging_kafka.rb', line 70 def use_tls @use_tls end |
#user ⇒ Object
SASL user.
65 66 67 |
# File 'lib/fastly/models/logging_kafka.rb', line 65 def user @user end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
120 121 122 |
# File 'lib/fastly/models/logging_kafka.rb', line 120 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/fastly/models/logging_kafka.rb', line 95 def self.attribute_map { :'name' => :'name', :'placement' => :'placement', :'format_version' => :'format_version', :'response_condition' => :'response_condition', :'format' => :'format', :'tls_ca_cert' => :'tls_ca_cert', :'tls_client_cert' => :'tls_client_cert', :'tls_client_key' => :'tls_client_key', :'tls_hostname' => :'tls_hostname', :'topic' => :'topic', :'brokers' => :'brokers', :'compression_codec' => :'compression_codec', :'required_acks' => :'required_acks', :'request_max_bytes' => :'request_max_bytes', :'parse_log_keyvals' => :'parse_log_keyvals', :'auth_method' => :'auth_method', :'user' => :'user', :'password' => :'password', :'use_tls' => :'use_tls' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
395 396 397 |
# File 'lib/fastly/models/logging_kafka.rb', line 395 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.fastly_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3)
163 164 165 166 167 168 169 |
# File 'lib/fastly/models/logging_kafka.rb', line 163 def self.fastly_all_of [ :'LoggingCommon', :'LoggingKafkaAllOf', :'LoggingTlsCommon' ] end |
.fastly_nullable ⇒ Object
List of attributes with nullable: true
150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/fastly/models/logging_kafka.rb', line 150 def self.fastly_nullable Set.new([ :'placement', :'response_condition', :'tls_ca_cert', :'tls_client_cert', :'tls_client_key', :'tls_hostname', :'compression_codec', ]) end |
.fastly_types ⇒ Object
Attribute type mapping.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/fastly/models/logging_kafka.rb', line 125 def self.fastly_types { :'name' => :'String', :'placement' => :'String', :'format_version' => :'Integer', :'response_condition' => :'String', :'format' => :'String', :'tls_ca_cert' => :'String', :'tls_client_cert' => :'String', :'tls_client_key' => :'String', :'tls_hostname' => :'String', :'topic' => :'String', :'brokers' => :'String', :'compression_codec' => :'String', :'required_acks' => :'Integer', :'request_max_bytes' => :'Integer', :'parse_log_keyvals' => :'Boolean', :'auth_method' => :'String', :'user' => :'String', :'password' => :'String', :'use_tls' => :'LoggingUseTls' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 |
# File 'lib/fastly/models/logging_kafka.rb', line 356 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 && tls_ca_cert == o.tls_ca_cert && tls_client_cert == o.tls_client_cert && tls_client_key == o.tls_client_key && tls_hostname == o.tls_hostname && topic == o.topic && brokers == o.brokers && compression_codec == o.compression_codec && required_acks == o.required_acks && request_max_bytes == o.request_max_bytes && parse_log_keyvals == o.parse_log_keyvals && auth_method == o.auth_method && user == o.user && password == o.password && use_tls == o.use_tls end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 |
# File 'lib/fastly/models/logging_kafka.rb', line 425 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
496 497 498 499 500 501 502 503 504 505 506 507 508 |
# File 'lib/fastly/models/logging_kafka.rb', line 496 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
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 |
# File 'lib/fastly/models/logging_kafka.rb', line 402 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
382 383 384 |
# File 'lib/fastly/models/logging_kafka.rb', line 382 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
388 389 390 |
# File 'lib/fastly/models/logging_kafka.rb', line 388 def hash [name, placement, format_version, response_condition, format, tls_ca_cert, tls_client_cert, tls_client_key, tls_hostname, topic, brokers, compression_codec, required_acks, request_max_bytes, parse_log_keyvals, auth_method, user, password, use_tls].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
283 284 285 286 |
# File 'lib/fastly/models/logging_kafka.rb', line 283 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
472 473 474 |
# File 'lib/fastly/models/logging_kafka.rb', line 472 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
478 479 480 481 482 483 484 485 486 487 488 489 490 |
# File 'lib/fastly/models/logging_kafka.rb', line 478 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
466 467 468 |
# File 'lib/fastly/models/logging_kafka.rb', line 466 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/fastly/models/logging_kafka.rb', line 290 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) compression_codec_validator = EnumAttributeValidator.new('String', ["gzip", "snappy", "lz4", "null"]) return false unless compression_codec_validator.valid?(@compression_codec) required_acks_validator = EnumAttributeValidator.new('Integer', [1, 0, -1]) return false unless required_acks_validator.valid?(@required_acks) auth_method_validator = EnumAttributeValidator.new('String', ["plain", "scram-sha-256", "scram-sha-512"]) return false unless auth_method_validator.valid?(@auth_method) true end |