Class: OCI::Loggingingestion::Models::LogEntryBatch

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/loggingingestion/models/log_entry_batch.rb

Overview

A single batch of Log Entries.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogEntryBatch

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 79

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.entries = attributes[:'entries'] if attributes[:'entries']

  self.source = attributes[:'source'] if attributes[:'source']

  self.type = attributes[:'type'] if attributes[:'type']

  self.subject = attributes[:'subject'] if attributes[:'subject']

  self.defaultlogentrytime = attributes[:'defaultlogentrytime'] if attributes[:'defaultlogentrytime']
end

Instance Attribute Details

#defaultlogentrytime ⇒ DateTime

[Required] The timestamp for all log entries in this batch. This can be considered as the default timestamp for each entry, unless it is overwritten by the entry time. An RFC3339-formatted date-time string with milliseconds precision.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 40

def defaultlogentrytime
  @defaultlogentrytime
end

#entries ⇒ Array<OCI::Loggingingestion::Models::LogEntry>

[Required] List of data entries.

Returns:



13
14
15
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 13

def entries
  @entries
end

#source ⇒ String

[Required] Source of the logs that generated the message. This could be the instance name, hostname, or the source used to read the event. For example, "ServerA".

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 19

def source
  @source
end

#subject ⇒ String

This optional field is useful for specifying the specific sub-resource or input file used to read the event. For example: "/var/log/application.log".

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 32

def subject
  @subject
end

#type ⇒ String

[Required] This field signifies the type of logs being ingested. For example: ServerA.requestLogs.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 25

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'entries': :'entries',
    'source': :'source',
    'type': :'type',
    'subject': :'subject',
    'defaultlogentrytime': :'defaultlogentrytime'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'entries': :'Array<OCI::Loggingingestion::Models::LogEntry>',
    'source': :'String',
    'type': :'String',
    'subject': :'String',
    'defaultlogentrytime': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 103

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    entries == other.entries &&
    source == other.source &&
    type == other.type &&
    subject == other.subject &&
    defaultlogentrytime == other.defaultlogentrytime
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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 137

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


117
118
119
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



126
127
128
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 126

def hash
  [entries, source, type, subject, defaultlogentrytime].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 170

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



164
165
166
 
# File 'lib/oci/loggingingestion/models/log_entry_batch.rb', line 164

def to_s
  to_hash.to_s
end