Class: OCI::LogAnalytics::Models::EstimateRecallDataSizeResult

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

Overview

This is the size and time range of data to be recalled

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EstimateRecallDataSizeResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 99

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

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

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

  self.is_overlapping_with_existing_recalls = attributes[:'isOverlappingWithExistingRecalls'] unless attributes[:'isOverlappingWithExistingRecalls'].nil?

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

  self.is_overlapping_with_existing_recalls = attributes[:'is_overlapping_with_existing_recalls'] unless attributes[:'is_overlapping_with_existing_recalls'].nil?

  self.core_group_count = attributes[:'coreGroupCount'] if attributes[:'coreGroupCount']

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

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

  self.core_group_count_limit = attributes[:'coreGroupCountLimit'] if attributes[:'coreGroupCountLimit']

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

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

  self.size_limit_in_bytes = attributes[:'sizeLimitInBytes'] if attributes[:'sizeLimitInBytes']

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

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

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

  self.total_batch_size = attributes[:'totalBatchSize'] if attributes[:'totalBatchSize']

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

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

Instance Attribute Details

#core_group_countInteger

This is the number of core groups estimated for this recall

Returns:

  • (Integer)


32
33
34
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 32

def core_group_count
  @core_group_count
end

#core_group_count_limitInteger

This is the max number of core groups that is available for any recall

Returns:

  • (Integer)


36
37
38
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 36

def core_group_count_limit
  @core_group_count_limit
end

#is_overlapping_with_existing_recallsBOOLEAN

This indicates if the time range of data to be recalled overlaps with existing recalled data

Returns:

  • (BOOLEAN)


28
29
30
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 28

def is_overlapping_with_existing_recalls
  @is_overlapping_with_existing_recalls
end

#messageString

This message shows existing recall overlapping details like collection id, purpose

Returns:

  • (String)


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

def message
  @message
end

#size_in_bytesInteger

[Required] This is the size in bytes

Returns:

  • (Integer)


24
25
26
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 24

def size_in_bytes
  @size_in_bytes
end

#size_limit_in_bytesInteger

This is the size limit in bytes

Returns:

  • (Integer)


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

def size_limit_in_bytes
  @size_limit_in_bytes
end

#time_data_endedDateTime

[Required] This is the end of the time range of data to be recalled. timeDataStarted and timeDataEnded delineate the time range of the archived data to be recalled. They may not be exact the same as the parameters in the request input (EstimateRecallDataSizeDetails).

Returns:

  • (DateTime)


16
17
18
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 16

def time_data_ended
  @time_data_ended
end

#time_data_startedDateTime

[Required] This is the start of the time range of data to be recalled

Returns:

  • (DateTime)


20
21
22
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 20

def time_data_started
  @time_data_started
end

#total_batch_sizeInteger

This is the total number of batches data will be recalled in

Returns:

  • (Integer)


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

def total_batch_size
  @total_batch_size
end

Class Method Details

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_data_ended': :'timeDataEnded',
    'time_data_started': :'timeDataStarted',
    'size_in_bytes': :'sizeInBytes',
    'is_overlapping_with_existing_recalls': :'isOverlappingWithExistingRecalls',
    'core_group_count': :'coreGroupCount',
    'core_group_count_limit': :'coreGroupCountLimit',
    'size_limit_in_bytes': :'sizeLimitInBytes',
    'message': :'message',
    'total_batch_size': :'totalBatchSize'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_data_ended': :'DateTime',
    'time_data_started': :'DateTime',
    'size_in_bytes': :'Integer',
    'is_overlapping_with_existing_recalls': :'BOOLEAN',
    'core_group_count': :'Integer',
    'core_group_count_limit': :'Integer',
    'size_limit_in_bytes': :'Integer',
    'message': :'String',
    'total_batch_size': :'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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 163

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 &&
    size_in_bytes == other.size_in_bytes &&
    is_overlapping_with_existing_recalls == other.is_overlapping_with_existing_recalls &&
    core_group_count == other.core_group_count &&
    core_group_count_limit == other.core_group_count_limit &&
    size_limit_in_bytes == other.size_limit_in_bytes &&
    message == other.message &&
    total_batch_size == other.total_batch_size
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 201

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


181
182
183
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 181

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



190
191
192
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 190

def hash
  [time_data_ended, time_data_started, size_in_bytes, is_overlapping_with_existing_recalls, core_group_count, core_group_count_limit, size_limit_in_bytes, message, total_batch_size].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 234

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



228
229
230
# File 'lib/oci/log_analytics/models/estimate_recall_data_size_result.rb', line 228

def to_s
  to_hash.to_s
end