class Fastly::LoggingAzureblobResponse

Attributes

account_name[RW]

The unique Azure Blob Storage namespace in which your data objects are stored. Required.

compression_codec[RW]

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.

container[RW]

The name of the Azure Blob Storage container in which to store logs. Required.

created_at[RW]

Date and time in ISO 8601 format.

deleted_at[RW]

Date and time in ISO 8601 format.

file_max_bytes[RW]

The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)

format[RW]
format_version[RW]

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

gzip_level[RW]

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.

message_type[RW]

How the message should be formatted.

name[RW]

The name for the real-time logging configuration.

path[RW]

The path to upload logs to.

period[RW]

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

placement[RW]

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

public_key[RW]

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

response_condition[RW]

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

sas_token[RW]

The Azure shared access signature providing write access to the blob service objects. Be sure to update your token before it expires or the logging functionality will not work. Required.

service_id[RW]
timestamp_format[RW]

A timestamp format

updated_at[RW]

Date and time in ISO 8601 format.

version[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/logging_azureblob_response.rb, line 127
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/fastly/models/logging_azureblob_response.rb, line 100
def self.attribute_map
  {
    :'name' => :'name',
    :'placement' => :'placement',
    :'response_condition' => :'response_condition',
    :'format' => :'format',
    :'format_version' => :'format_version',
    :'message_type' => :'message_type',
    :'timestamp_format' => :'timestamp_format',
    :'compression_codec' => :'compression_codec',
    :'period' => :'period',
    :'gzip_level' => :'gzip_level',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'service_id' => :'service_id',
    :'version' => :'version',
    :'path' => :'path',
    :'account_name' => :'account_name',
    :'container' => :'container',
    :'sas_token' => :'sas_token',
    :'public_key' => :'public_key',
    :'file_max_bytes' => :'file_max_bytes'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/fastly/models/logging_azureblob_response.rb, line 416
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
fastly_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/fastly/models/logging_azureblob_response.rb, line 173
def self.fastly_all_of
  [
  :'LoggingAzureblobAdditional',
  :'LoggingCommonResponse',
  :'LoggingGenericCommonResponse',
  :'ServiceIdAndVersionString',
  :'Timestamps'
  ]
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fastly/models/logging_azureblob_response.rb, line 159
def self.fastly_nullable
  Set.new([
    :'placement',
    :'response_condition',
    :'timestamp_format',
    :'created_at',
    :'deleted_at',
    :'updated_at',
    :'path',
    :'public_key',
  ])
end
fastly_types() click to toggle source

Attribute type mapping.

# File lib/fastly/models/logging_azureblob_response.rb, line 132
def self.fastly_types
  {
    :'name' => :'String',
    :'placement' => :'String',
    :'response_condition' => :'String',
    :'format' => :'String',
    :'format_version' => :'String',
    :'message_type' => :'String',
    :'timestamp_format' => :'String',
    :'compression_codec' => :'String',
    :'period' => :'String',
    :'gzip_level' => :'String',
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'service_id' => :'String',
    :'version' => :'String',
    :'path' => :'String',
    :'account_name' => :'String',
    :'container' => :'String',
    :'sas_token' => :'String',
    :'public_key' => :'String',
    :'file_max_bytes' => :'Integer'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/fastly/models/logging_azureblob_response.rb, line 185
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::LoggingAzureblobResponse` 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::LoggingAzureblobResponse`. 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?(:'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?(:'format_version')
    self.format_version = attributes[:'format_version']
  else
    self.format_version = '2'
  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?(:'compression_codec')
    self.compression_codec = attributes[:'compression_codec']
  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?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

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

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

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

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

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

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

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

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

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

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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/fastly/models/logging_azureblob_response.rb, line 375
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      placement == o.placement &&
      response_condition == o.response_condition &&
      format == o.format &&
      format_version == o.format_version &&
      message_type == o.message_type &&
      timestamp_format == o.timestamp_format &&
      compression_codec == o.compression_codec &&
      period == o.period &&
      gzip_level == o.gzip_level &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      service_id == o.service_id &&
      version == o.version &&
      path == o.path &&
      account_name == o.account_name &&
      container == o.container &&
      sas_token == o.sas_token &&
      public_key == o.public_key &&
      file_max_bytes == o.file_max_bytes
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/fastly/models/logging_azureblob_response.rb, line 446
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/fastly/models/logging_azureblob_response.rb, line 517
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/fastly/models/logging_azureblob_response.rb, line 423
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
compression_codec=(compression_codec) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] compression_codec Object to be assigned

# File lib/fastly/models/logging_azureblob_response.rb, line 355
def compression_codec=(compression_codec)
  validator = EnumAttributeValidator.new('String', ["zstd", "snappy", "gzip"])
  unless validator.valid?(compression_codec)
    fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{validator.allowable_values}."
  end
  @compression_codec = compression_codec
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/fastly/models/logging_azureblob_response.rb, line 403
def eql?(o)
  self == o
end
file_max_bytes=(file_max_bytes) click to toggle source

Custom attribute writer method with validation @param [Object] file_max_bytes Value to be assigned

# File lib/fastly/models/logging_azureblob_response.rb, line 365
def file_max_bytes=(file_max_bytes)
  if !file_max_bytes.nil? && file_max_bytes < 1048576
    fail ArgumentError, 'invalid value for "file_max_bytes", must be greater than or equal to 1048576.'
  end

  @file_max_bytes = file_max_bytes
end
format_version=(format_version) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] format_version Object to be assigned

# File lib/fastly/models/logging_azureblob_response.rb, line 335
def format_version=(format_version)
  validator = EnumAttributeValidator.new('String', ["1", "2"])
  unless validator.valid?(format_version)
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{validator.allowable_values}."
  end
  @format_version = format_version
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/fastly/models/logging_azureblob_response.rb, line 409
def hash
  [name, placement, response_condition, format, format_version, message_type, timestamp_format, compression_codec, period, gzip_level, created_at, deleted_at, updated_at, service_id, version, path, account_name, container, sas_token, public_key, file_max_bytes].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/fastly/models/logging_azureblob_response.rb, line 299
def list_invalid_properties
  invalid_properties = Array.new
  if !@file_max_bytes.nil? && @file_max_bytes < 1048576
    invalid_properties.push('invalid value for "file_max_bytes", must be greater than or equal to 1048576.')
  end

  invalid_properties
end
message_type=(message_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] message_type Object to be assigned

# File lib/fastly/models/logging_azureblob_response.rb, line 345
def message_type=(message_type)
  validator = EnumAttributeValidator.new('String', ["classic", "loggly", "logplex", "blank"])
  unless validator.valid?(message_type)
    fail ArgumentError, "invalid value for \"message_type\", must be one of #{validator.allowable_values}."
  end
  @message_type = message_type
end
placement=(placement) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] placement Object to be assigned

# File lib/fastly/models/logging_azureblob_response.rb, line 325
def placement=(placement)
  validator = EnumAttributeValidator.new('String', ["none", "waf_debug", "null"])
  unless validator.valid?(placement)
    fail ArgumentError, "invalid value for \"placement\", must be one of #{validator.allowable_values}."
  end
  @placement = placement
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/fastly/models/logging_azureblob_response.rb, line 493
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/fastly/models/logging_azureblob_response.rb, line 499
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/fastly/models/logging_azureblob_response.rb, line 487
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/fastly/models/logging_azureblob_response.rb, line 310
def valid?
  placement_validator = EnumAttributeValidator.new('String', ["none", "waf_debug", "null"])
  return false unless placement_validator.valid?(@placement)
  format_version_validator = EnumAttributeValidator.new('String', ["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)
  return false if !@file_max_bytes.nil? && @file_max_bytes < 1048576
  true
end