Class: DatadogAPIClient::V2::LogsArchiveCreateRequestAttributes

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

Overview

The attributes associated with the archive.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsedObject

whether the object has unparsed attributes



23
24
25
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 23

def _unparsed
  @_unparsed
end

#destinationObject

An archive's destination.



25
26
27
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 25

def destination
  @destination
end

#include_tagsObject

To store the tags in the archive, set the value "true". If it is set to "false", the tags will be deleted when the logs are sent to the archive.



28
29
30
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 28

def include_tags
  @include_tags
end

#nameObject

The archive name.



31
32
33
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 31

def name
  @name
end

#queryObject

The archive query/filter. Logs matching this query are included in the archive.



34
35
36
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 34

def query
  @query
end

#rehydration_max_scan_size_in_gbObject

Maximum scan size for rehydration from this archive.



38
39
40
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 38

def rehydration_max_scan_size_in_gb
  @rehydration_max_scan_size_in_gb
end

#rehydration_tagsObject

An array of tags to add to rehydrated logs from an archive.



37
38
39
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 37

def rehydration_tags
  @rehydration_tags
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



51
52
53
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 51

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



167
168
169
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 167

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
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



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
235
236
237
238
239
240
241
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 197

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::V2.const_get(type)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V2::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



275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 275

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 174

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


154
155
156
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 154

def eql?(o)
  self == o
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 114

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



251
252
253
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 251

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 257

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



245
246
247
# File 'lib/datadog_api_client/v2/models/logs_archive_create_request_attributes.rb', line 245

def to_s
  to_hash.to_s
end