Class: OCI::LogAnalytics::Models::RecalledData

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

Overview

This is the information about recalled data

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 = {}) ⇒ RecalledData

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_data_ended (DateTime) —

    The value to assign to the #time_data_ended property

  • :time_data_started (DateTime) —

    The value to assign to the #time_data_started property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :status (String) —

    The value to assign to the #status property

  • :recall_count (Integer) —

    The value to assign to the #recall_count property

  • :storage_usage_in_bytes (Integer) —

    The value to assign to the #storage_usage_in_bytes property

  • :not_recalled_data_in_bytes (Integer) —

    The value to assign to the #not_recalled_data_in_bytes 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

  • :created_by (String) —

    The value to assign to the #created_by 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

  • :percentage_complete (Integer) —

    The value to assign to the #percentage_complete property



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 149

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

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

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

  self.time_data_started = attributes[:'timeDataStarted'] if attributes[:'timeDataStarted']

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

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

  self.recall_count = attributes[:'recallCount'] if attributes[:'recallCount']

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

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

  self.storage_usage_in_bytes = attributes[:'storageUsageInBytes'] if attributes[:'storageUsageInBytes']

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

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

  self.not_recalled_data_in_bytes = attributes[:'notRecalledDataInBytes'] if attributes[:'notRecalledDataInBytes']

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

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

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

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

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

  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']

  self.percentage_complete = attributes[:'percentageComplete'] if attributes[:'percentageComplete']

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

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

Instance Attribute Details

#collection_id ⇒ Integer

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

Returns:

  • (Integer) 


68
69
70
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 68

def collection_id
  @collection_id
end

#created_by ⇒ String

[Required] This is the user who initiated the recall request

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 64

def created_by
  @created_by
end

#log_sets ⇒ String

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

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 60

def log_sets
  @log_sets
end

#not_recalled_data_in_bytes ⇒ Integer

[Required] This is the size of the archival data not recalled yet within the specified time range

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 48

def not_recalled_data_in_bytes
  @not_recalled_data_in_bytes
end

#percentage_complete ⇒ Integer

This is the current progress percentage for the recalled data

Returns:

  • (Integer) 


80
81
82
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 80

def percentage_complete
  @percentage_complete
end

#purpose ⇒ String

[Required] This is the purpose of the recall

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 52

def purpose
  @purpose
end

#query_string ⇒ String

[Required] This is the query associated with the recall

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 56

def query_string
  @query_string
end

#recall_count ⇒ Integer

[Required] This is the number of recall operations for this recall. Note one RecalledData can be merged from the results of several recall operations if the time duration of the results of the recall operations overlap.

Returns:

  • (Integer) 


40
41
42
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 40

def recall_count
  @recall_count
end

#status ⇒ String

[Required] This is the status of the recall

Returns:

  • (String) 


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

def status
  @status
end

#storage_usage_in_bytes ⇒ Integer

[Required] This is the size in bytes

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 44

def storage_usage_in_bytes
  @storage_usage_in_bytes
end

#time_data_ended ⇒ DateTime

[Required] This is the end of the time range of the related data

Returns:

  • (DateTime) 


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

def time_data_ended
  @time_data_ended
end

#time_data_started ⇒ DateTime

[Required] This is the start of the time range of the related data

Returns:

  • (DateTime) 


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

def time_data_started
  @time_data_started
end

#time_recalled_data_ended ⇒ DateTime

[Required] This is the recalled data end time

Returns:

  • (DateTime) 


76
77
78
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 76

def time_recalled_data_ended
  @time_recalled_data_ended
end

#time_recalled_data_started ⇒ DateTime

[Required] This is the recalled date start time

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 72

def time_recalled_data_started
  @time_recalled_data_started
end

#time_started ⇒ DateTime

[Required] This is the time when the first recall operation was started for this RecalledData

Returns:

  • (DateTime) 


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

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_data_ended': :'timeDataEnded',
    'time_data_started': :'timeDataStarted',
    'time_started': :'timeStarted',
    'status': :'status',
    'recall_count': :'recallCount',
    'storage_usage_in_bytes': :'storageUsageInBytes',
    'not_recalled_data_in_bytes': :'notRecalledDataInBytes',
    'purpose': :'purpose',
    'query_string': :'queryString',
    'log_sets': :'logSets',
    'created_by': :'createdBy',
    'collection_id': :'collectionId',
    'time_recalled_data_started': :'timeRecalledDataStarted',
    'time_recalled_data_ended': :'timeRecalledDataEnded',
    'percentage_complete': :'percentageComplete'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 106

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 258

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

  self.class == other.class &&
    time_data_ended == other.time_data_ended &&
    time_data_started == other.time_data_started &&
    time_started == other.time_started &&
    status == other.status &&
    recall_count == other.recall_count &&
    storage_usage_in_bytes == other.storage_usage_in_bytes &&
    not_recalled_data_in_bytes == other.not_recalled_data_in_bytes &&
    purpose == other.purpose &&
    query_string == other.query_string &&
    log_sets == other.log_sets &&
    created_by == other.created_by &&
    collection_id == other.collection_id &&
    time_recalled_data_started == other.time_recalled_data_started &&
    time_recalled_data_ended == other.time_recalled_data_ended &&
    percentage_complete == other.percentage_complete
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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 302

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


282
283
284
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 282

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



291
292
293
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 291

def hash
  [time_data_ended, time_data_started, time_started, status, recall_count, storage_usage_in_bytes, not_recalled_data_in_bytes, purpose, query_string, log_sets, created_by, collection_id, time_recalled_data_started, time_recalled_data_ended, percentage_complete].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 335

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



329
330
331
 
# File 'lib/oci/log_analytics/models/recalled_data.rb', line 329

def to_s
  to_hash.to_s
end