class DatadogAPIClient::V1::LogsListRequest
Object to send with the request to retrieve a list of logs from your Organization
.
Attributes
The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified.
Number of logs return in the response.
The search query - following the log search syntax.
Hash identifier of the first log to return in the list, available in a log `id` attribute. This parameter is used for the pagination feature. Note: This parameter is ignored if the corresponding log is out of the scope of the specified time window.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 51 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 39 def self.attribute_map { :'index' => :'index', :'limit' => :'limit', :'query' => :'query', :'sort' => :'sort', :'start_at' => :'startAt', :'time' => :'time' } end
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/logs_list_request.rb, line 174 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 75 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::LogsListRequest` 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::LogsListRequest`. 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?(:'index') self.index = attributes[:'index'] end if attributes.key?(:'limit') self.limit = attributes[:'limit'] end if attributes.key?(:'query') self.query = attributes[:'query'] end if attributes.key?(:'sort') self.sort = attributes[:'sort'] end if attributes.key?(:'start_at') self.start_at = attributes[:'start_at'] end if attributes.key?(:'time') self.time = attributes[:'time'] end end
List of attributes with nullable: true
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 68 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 56 def self.openapi_types { :'index' => :'String', :'limit' => :'Integer', :'query' => :'String', :'sort' => :'LogsSort', :'start_at' => :'String', :'time' => :'LogsListRequestTime' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 148 def ==(o) return true if self.equal?(o) self.class == o.class && index == o.index && limit == o.limit && query == o.query && sort == o.sort && start_at == o.start_at && time == o.time end
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/logs_list_request.rb, line 204 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
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/logs_list_request.rb, line 278 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
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/logs_list_request.rb, line 181 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
@see the `==` method @param [Object] Object to be compared
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 161 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 167 def hash [index, limit, query, sort, start_at, time].hash end
Custom attribute writer method with validation @param [Object] limit Value to be assigned
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 138 def limit=(limit) if !limit.nil? && limit > 1000 fail ArgumentError, 'invalid value for "limit", must be smaller than or equal to 1000.' end @limit = limit end
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/logs_list_request.rb, line 115 def list_invalid_properties invalid_properties = Array.new if !@limit.nil? && @limit > 1000 invalid_properties.push('invalid value for "limit", must be smaller than or equal to 1000.') end if @time.nil? invalid_properties.push('invalid value for "time", time cannot be nil.') end invalid_properties end
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/logs_list_request.rb, line 260 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/datadog_api_client/v1/models/logs_list_request.rb, line 248 def to_s to_hash.to_s end
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/logs_list_request.rb, line 130 def valid? return false if !@limit.nil? && @limit > 1000 return false if @time.nil? true end