Class: DatadogAPIClient::V1::ListStreamQuery

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/list_stream_query.rb

Overview

Updated list stream widget.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 51

def additional_properties
  @additional_properties
end

#clustering_pattern_field_path ⇒ Object

Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.



25
26
27
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 25

def clustering_pattern_field_path
  @clustering_pattern_field_path
end

#compute ⇒ Object

Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source.



28
29
30
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 28

def compute
  @compute
end

#data_source ⇒ Object

Source from which to query items to display in the stream.



31
32
33
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 31

def data_source
  @data_source
end

#event_size ⇒ Object

Size to use to display an event.



34
35
36
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 34

def event_size
  @event_size
end

#group_by ⇒ Object

Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source.



37
38
39
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 37

def group_by
  @group_by
end

#indexes ⇒ Object

List of indexes.



28
29
30
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 28

def indexes
  @indexes
end

#query_string ⇒ Object

Widget query.



31
32
33
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 31

def query_string
  @query_string
end

#sort ⇒ Object

Which column and order to sort by



46
47
48
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 46

def sort
  @sort
end

#storage ⇒ Object

Option for storage location. Feature in Private Beta.



49
50
51
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 49

def storage
  @storage
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 43

def self.acceptable_attributes
  attribute_map.values
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



142
143
144
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 142

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 57

def self.openapi_nullable
  Set.new([
  ])
end

Instance Method Details

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 172

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)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V1::UnparsedObject
      self._unparsed = true
    end
    res
  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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 250

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 149

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


129
130
131
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 129

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 96

def list_invalid_properties
  invalid_properties = Array.new
  if @data_source.nil?
    invalid_properties.push('invalid value for "data_source", data_source cannot be nil.')
  end

  if @query_string.nil?
    invalid_properties.push('invalid value for "query_string", query_string cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 226

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



220
221
222
 
# File 'lib/datadog_api_client/v1/models/list_stream_query.rb', line 220

def to_s
  to_hash.to_s
end