class DatadogAPIClient::V1::LogStreamWidgetDefinition

The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.

Attributes

columns[RW]

Which columns to display on the widget.

indexes[RW]

An array of index names to query in the stream. Use [] to query all indexes at once.

logset[RW]

ID of the log set to use.

message_display[RW]
query[RW]

Query to filter the log stream with.

show_date_column[RW]

Whether to show the date column or not

show_message_column[RW]

Whether to show the message column or not

sort[RW]
time[RW]
title[RW]

Title of the widget.

title_align[RW]
title_size[RW]

Size of the title.

type[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 76
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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 57
def self.attribute_map
  {
    :'columns' => :'columns',
    :'indexes' => :'indexes',
    :'logset' => :'logset',
    :'message_display' => :'message_display',
    :'query' => :'query',
    :'show_date_column' => :'show_date_column',
    :'show_message_column' => :'show_message_column',
    :'sort' => :'sort',
    :'time' => :'time',
    :'title' => :'title',
    :'title_align' => :'title_align',
    :'title_size' => :'title_size',
    :'type' => :'type'
  }
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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 232
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 107
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::LogStreamWidgetDefinition` 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 `DatadogAPIClient::V1::LogStreamWidgetDefinition`. 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?(:'columns')
    if (value = attributes[:'columns']).is_a?(Array)
      self.columns = value
    end
  end

  if attributes.key?(:'indexes')
    if (value = attributes[:'indexes']).is_a?(Array)
      self.indexes = value
    end
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'log_stream'
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 100
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 81
def self.openapi_types
  {
    :'columns' => :'Array<String>',
    :'indexes' => :'Array<String>',
    :'logset' => :'String',
    :'message_display' => :'WidgetMessageDisplay',
    :'query' => :'String',
    :'show_date_column' => :'Boolean',
    :'show_message_column' => :'Boolean',
    :'sort' => :'WidgetFieldSort',
    :'time' => :'WidgetTime',
    :'title' => :'String',
    :'title_align' => :'WidgetTextAlign',
    :'title_size' => :'String',
    :'type' => :'LogStreamWidgetDefinitionType'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 199
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      columns == o.columns &&
      indexes == o.indexes &&
      logset == o.logset &&
      message_display == o.message_display &&
      query == o.query &&
      show_date_column == o.show_date_column &&
      show_message_column == o.show_message_column &&
      sort == o.sort &&
      time == o.time &&
      title == o.title &&
      title_align == o.title_align &&
      title_size == o.title_size &&
      type == o.type
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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 262
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 :Array
    # generic array, 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 = DatadogAPIClient::V1.const_get(type)
    klass.respond_to?(:openapi_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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 336
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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 239
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_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) click to toggle source

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

# File lib/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 219
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 225
def hash
  [columns, indexes, logset, message_display, query, show_date_column, show_message_column, sort, time, title, title_align, title_size, type].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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 181
def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  invalid_properties
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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 312
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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 318
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 306
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/datadog_api_client/v1/models/log_stream_widget_definition.rb, line 192
def valid?
  return false if @type.nil?
  true
end