Class: Fastly::LoggingScalyr
- Inherits:
-
Object
- Object
- Fastly::LoggingScalyr
- Defined in:
- lib/fastly/models/logging_scalyr.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.
-
#project_id ⇒ Object
The name of the logfile within Scalyr.
-
#region ⇒ Object
The region that log data will be sent to.
-
#response_condition ⇒ Object
The name of an existing condition in the configured endpoint, or leave blank to always execute.
-
#token ⇒ Object
The token to use for authentication ([www.scalyr.com/keys](https://www.scalyr.com/keys)).
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 = {}) ⇒ LoggingScalyr
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 = {}) ⇒ LoggingScalyr
Initializes the object
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 |
# File 'lib/fastly/models/logging_scalyr.rb', line 113 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingScalyr` 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::LoggingScalyr`. 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?(:'region') self.region = attributes[:'region'] else self.region = 'US' end if attributes.key?(:'token') self.token = attributes[:'token'] end if attributes.key?(:'project_id') self.project_id = attributes[:'project_id'] else self.project_id = 'logplex' 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_scalyr.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_scalyr.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_scalyr.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_scalyr.rb', line 20 def placement @placement end |
#project_id ⇒ Object
The name of the logfile within Scalyr.
38 39 40 |
# File 'lib/fastly/models/logging_scalyr.rb', line 38 def project_id @project_id end |
#region ⇒ Object
The region that log data will be sent to.
32 33 34 |
# File 'lib/fastly/models/logging_scalyr.rb', line 32 def region @region 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_scalyr.rb', line 26 def response_condition @response_condition end |
#token ⇒ Object
The token to use for authentication ([www.scalyr.com/keys](https://www.scalyr.com/keys)).
35 36 37 |
# File 'lib/fastly/models/logging_scalyr.rb', line 35 def token @token end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
77 78 79 |
# File 'lib/fastly/models/logging_scalyr.rb', line 77 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 74 |
# File 'lib/fastly/models/logging_scalyr.rb', line 63 def self.attribute_map { :'name' => :'name', :'placement' => :'placement', :'format_version' => :'format_version', :'response_condition' => :'response_condition', :'format' => :'format', :'region' => :'region', :'token' => :'token', :'project_id' => :'project_id' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
246 247 248 |
# File 'lib/fastly/models/logging_scalyr.rb', line 246 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.fastly_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3)
104 105 106 107 108 109 |
# File 'lib/fastly/models/logging_scalyr.rb', line 104 def self.fastly_all_of [ :'LoggingCommon', :'LoggingScalyrAllOf' ] end |
.fastly_nullable ⇒ Object
List of attributes with nullable: true
96 97 98 99 100 101 |
# File 'lib/fastly/models/logging_scalyr.rb', line 96 def self.fastly_nullable Set.new([ :'placement', :'response_condition', ]) end |
.fastly_types ⇒ Object
Attribute type mapping.
82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/fastly/models/logging_scalyr.rb', line 82 def self.fastly_types { :'name' => :'String', :'placement' => :'String', :'format_version' => :'Integer', :'response_condition' => :'String', :'format' => :'String', :'region' => :'String', :'token' => :'String', :'project_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/fastly/models/logging_scalyr.rb', line 218 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 && region == o.region && token == o.token && project_id == o.project_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/fastly/models/logging_scalyr.rb', line 276 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
347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/fastly/models/logging_scalyr.rb', line 347 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
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/fastly/models/logging_scalyr.rb', line 253 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
233 234 235 |
# File 'lib/fastly/models/logging_scalyr.rb', line 233 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
239 240 241 |
# File 'lib/fastly/models/logging_scalyr.rb', line 239 def hash [name, placement, format_version, response_condition, format, region, token, project_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
169 170 171 172 |
# File 'lib/fastly/models/logging_scalyr.rb', line 169 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
323 324 325 |
# File 'lib/fastly/models/logging_scalyr.rb', line 323 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/fastly/models/logging_scalyr.rb', line 329 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
317 318 319 |
# File 'lib/fastly/models/logging_scalyr.rb', line 317 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
176 177 178 179 180 181 182 183 184 |
# File 'lib/fastly/models/logging_scalyr.rb', line 176 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) region_validator = EnumAttributeValidator.new('String', ["US", "EU"]) return false unless region_validator.valid?(@region) true end |