Class: Fastly::LoggingSplunk
- Inherits:
-
Object
- Object
- Fastly::LoggingSplunk
- Defined in:
- lib/fastly/models/logging_splunk.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#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.
-
#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.
-
#request_max_entries ⇒ Object
The maximum number of logs sent in one request.
-
#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.
-
#token ⇒ Object
A Splunk token for use in posting logs over HTTP to your collector.
-
#url ⇒ Object
The URL to post logs to.
-
#use_tls ⇒ Object
Returns the value of attribute use_tls.
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 = {}) ⇒ LoggingSplunk
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 = {}) ⇒ LoggingSplunk
Initializes the object
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 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 |
# File 'lib/fastly/models/logging_splunk.rb', line 148 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingSplunk` 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::LoggingSplunk`. 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?(:'request_max_entries') self.request_max_entries = attributes[:'request_max_entries'] else self.request_max_entries = 0 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?(:'url') self.url = attributes[:'url'] end if attributes.key?(:'token') self.token = attributes[:'token'] end if attributes.key?(:'use_tls') self.use_tls = attributes[:'use_tls'] else self.use_tls = LoggingUseTls::no_tls end end |
Instance Attribute Details
#format ⇒ Object
A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats).
29 30 31 |
# File 'lib/fastly/models/logging_splunk.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_splunk.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_splunk.rb', line 17 def name @name 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_splunk.rb', line 20 def placement @placement end |
#request_max_bytes ⇒ Object
The maximum number of bytes sent in one request. Defaults ‘0` for unbounded.
47 48 49 |
# File 'lib/fastly/models/logging_splunk.rb', line 47 def request_max_bytes @request_max_bytes end |
#request_max_entries ⇒ Object
The maximum number of logs sent in one request. Defaults ‘0` for unbounded.
44 45 46 |
# File 'lib/fastly/models/logging_splunk.rb', line 44 def request_max_entries @request_max_entries 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_splunk.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_splunk.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_splunk.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_splunk.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_splunk.rb', line 41 def tls_hostname @tls_hostname end |
#token ⇒ Object
A Splunk token for use in posting logs over HTTP to your collector.
53 54 55 |
# File 'lib/fastly/models/logging_splunk.rb', line 53 def token @token end |
#url ⇒ Object
The URL to post logs to.
50 51 52 |
# File 'lib/fastly/models/logging_splunk.rb', line 50 def url @url end |
#use_tls ⇒ Object
Returns the value of attribute use_tls.
55 56 57 |
# File 'lib/fastly/models/logging_splunk.rb', line 55 def use_tls @use_tls end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
100 101 102 |
# File 'lib/fastly/models/logging_splunk.rb', line 100 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/fastly/models/logging_splunk.rb', line 80 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', :'request_max_entries' => :'request_max_entries', :'request_max_bytes' => :'request_max_bytes', :'url' => :'url', :'token' => :'token', :'use_tls' => :'use_tls' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
309 310 311 |
# File 'lib/fastly/models/logging_splunk.rb', line 309 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.fastly_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3)
137 138 139 140 141 142 143 144 |
# File 'lib/fastly/models/logging_splunk.rb', line 137 def self.fastly_all_of [ :'LoggingCommon', :'LoggingRequestCapsCommon', :'LoggingSplunkAllOf', :'LoggingTlsCommon' ] end |
.fastly_nullable ⇒ Object
List of attributes with nullable: true
125 126 127 128 129 130 131 132 133 134 |
# File 'lib/fastly/models/logging_splunk.rb', line 125 def self.fastly_nullable Set.new([ :'placement', :'response_condition', :'tls_ca_cert', :'tls_client_cert', :'tls_client_key', :'tls_hostname', ]) end |
.fastly_types ⇒ Object
Attribute type mapping.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/fastly/models/logging_splunk.rb', line 105 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', :'request_max_entries' => :'Integer', :'request_max_bytes' => :'Integer', :'url' => :'String', :'token' => :'String', :'use_tls' => :'LoggingUseTls' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/fastly/models/logging_splunk.rb', line 275 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 && request_max_entries == o.request_max_entries && request_max_bytes == o.request_max_bytes && url == o.url && token == o.token && use_tls == o.use_tls end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
# File 'lib/fastly/models/logging_splunk.rb', line 339 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
410 411 412 413 414 415 416 417 418 419 420 421 422 |
# File 'lib/fastly/models/logging_splunk.rb', line 410 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
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/fastly/models/logging_splunk.rb', line 316 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
296 297 298 |
# File 'lib/fastly/models/logging_splunk.rb', line 296 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
302 303 304 |
# File 'lib/fastly/models/logging_splunk.rb', line 302 def hash [name, placement, format_version, response_condition, format, tls_ca_cert, tls_client_cert, tls_client_key, tls_hostname, request_max_entries, request_max_bytes, url, token, use_tls].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
238 239 240 241 |
# File 'lib/fastly/models/logging_splunk.rb', line 238 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
386 387 388 |
# File 'lib/fastly/models/logging_splunk.rb', line 386 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/fastly/models/logging_splunk.rb', line 392 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
380 381 382 |
# File 'lib/fastly/models/logging_splunk.rb', line 380 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
245 246 247 248 249 250 251 |
# File 'lib/fastly/models/logging_splunk.rb', line 245 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) true end |