Class: OCI::LogAnalytics::Models::RecalledInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/recalled_info.rb

Overview

This is the information about data recalled

Constant Summary collapse

STATUS_ENUM =
[
  STATUS_RECALLED = 'RECALLED'.freeze,
  STATUS_PENDING = 'PENDING'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_PARTIAL_RECALLED = 'PARTIAL_RECALLED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecalledInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :status (String)

    The value to assign to the #status property

  • :purpose (String)

    The value to assign to the #purpose property

  • :query_string (String)

    The value to assign to the #query_string property

  • :log_sets (String)

    The value to assign to the #log_sets property

  • :collection_id (Integer)

    The value to assign to the #collection_id property

  • :time_recalled_data_started (DateTime)

    The value to assign to the #time_recalled_data_started property

  • :time_recalled_data_ended (DateTime)

    The value to assign to the #time_recalled_data_ended property



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 91

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.status = attributes[:'status'] if attributes[:'status']

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

  self.query_string = attributes[:'queryString'] if attributes[:'queryString']

  raise 'You cannot provide both :queryString and :query_string' if attributes.key?(:'queryString') && attributes.key?(:'query_string')

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

  self.log_sets = attributes[:'logSets'] if attributes[:'logSets']

  raise 'You cannot provide both :logSets and :log_sets' if attributes.key?(:'logSets') && attributes.key?(:'log_sets')

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

  self.collection_id = attributes[:'collectionId'] if attributes[:'collectionId']

  raise 'You cannot provide both :collectionId and :collection_id' if attributes.key?(:'collectionId') && attributes.key?(:'collection_id')

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

  self.time_recalled_data_started = attributes[:'timeRecalledDataStarted'] if attributes[:'timeRecalledDataStarted']

  raise 'You cannot provide both :timeRecalledDataStarted and :time_recalled_data_started' if attributes.key?(:'timeRecalledDataStarted') && attributes.key?(:'time_recalled_data_started')

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

  self.time_recalled_data_ended = attributes[:'timeRecalledDataEnded'] if attributes[:'timeRecalledDataEnded']

  raise 'You cannot provide both :timeRecalledDataEnded and :time_recalled_data_ended' if attributes.key?(:'timeRecalledDataEnded') && attributes.key?(:'time_recalled_data_ended')

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

Instance Attribute Details

#collection_idInteger

[Required] This is the id for the recalled data collection

Returns:

  • (Integer)


38
39
40
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 38

def collection_id
  @collection_id
end

#log_setsString

[Required] This is the list of logsets associated with the recall

Returns:

  • (String)


34
35
36
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 34

def log_sets
  @log_sets
end

#purposeString

[Required] This is the purpose of the recall

Returns:

  • (String)


26
27
28
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 26

def purpose
  @purpose
end

#query_stringString

[Required] This is the query associated with the recall

Returns:

  • (String)


30
31
32
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 30

def query_string
  @query_string
end

#statusString

[Required] This is the status of the recall

Returns:

  • (String)


22
23
24
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 22

def status
  @status
end

#time_recalled_data_endedDateTime

[Required] This is the recalled data end time

Returns:

  • (DateTime)


46
47
48
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 46

def time_recalled_data_ended
  @time_recalled_data_ended
end

#time_recalled_data_startedDateTime

[Required] This is the recalled date start time

Returns:

  • (DateTime)


42
43
44
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 42

def time_recalled_data_started
  @time_recalled_data_started
end

Class Method Details

.attribute_mapObject

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



49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'status',
    'purpose': :'purpose',
    'query_string': :'queryString',
    'log_sets': :'logSets',
    'collection_id': :'collectionId',
    'time_recalled_data_started': :'timeRecalledDataStarted',
    'time_recalled_data_ended': :'timeRecalledDataEnded'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'String',
    'purpose': :'String',
    'query_string': :'String',
    'log_sets': :'String',
    'collection_id': :'Integer',
    'time_recalled_data_started': :'DateTime',
    'time_recalled_data_ended': :'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



152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 152

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

  self.class == other.class &&
    status == other.status &&
    purpose == other.purpose &&
    query_string == other.query_string &&
    log_sets == other.log_sets &&
    collection_id == other.collection_id &&
    time_recalled_data_started == other.time_recalled_data_started &&
    time_recalled_data_ended == other.time_recalled_data_ended
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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 188

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


168
169
170
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 168

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



177
178
179
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 177

def hash
  [status, purpose, query_string, log_sets, collection_id, time_recalled_data_started, time_recalled_data_ended].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



221
222
223
224
225
226
227
228
229
230
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 221

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



215
216
217
# File 'lib/oci/log_analytics/models/recalled_info.rb', line 215

def to_s
  to_hash.to_s
end