Class: OCI::Jms::Models::CryptoAnalysisResultSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms/models/crypto_analysis_result_summary.rb

Overview

Summary of a crypto analysis result. The actual output of the analysis is stored in the Object Storage object.

Constant Summary collapse

AGGREGATION_MODE_ENUM = 
[
  AGGREGATION_MODE_JFR = 'JFR'.freeze,
  AGGREGATION_MODE_MANAGED_INSTANCE = 'MANAGED_INSTANCE'.freeze,
  AGGREGATION_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CryptoAnalysisResultSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :work_request_id (String) —

    The value to assign to the #work_request_id property

  • :aggregation_mode (String) —

    The value to assign to the #aggregation_mode property

  • :fleet_id (String) —

    The value to assign to the #fleet_id property

  • :managed_instance_id (String) —

    The value to assign to the #managed_instance_id property

  • :host_name (String) —

    The value to assign to the #host_name property

  • :time_first_event (DateTime) —

    The value to assign to the #time_first_event property

  • :time_last_event (DateTime) —

    The value to assign to the #time_last_event property

  • :total_event_count (Integer) —

    The value to assign to the #total_event_count property

  • :summarized_event_count (Integer) —

    The value to assign to the #summarized_event_count property

  • :finding_count (Integer) —

    The value to assign to the #finding_count property

  • :non_compliant_finding_count (Integer) —

    The value to assign to the #non_compliant_finding_count property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :crypto_roadmap_version (String) —

    The value to assign to the #crypto_roadmap_version property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :bucket_name (String) —

    The value to assign to the #bucket_name property

  • :object_name (String) —

    The value to assign to the #object_name property



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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 162

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

  self.work_request_id = attributes[:'workRequestId'] if attributes[:'workRequestId']

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

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

  self.aggregation_mode = attributes[:'aggregationMode'] if attributes[:'aggregationMode']

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

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

  self.fleet_id = attributes[:'fleetId'] if attributes[:'fleetId']

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

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

  self.managed_instance_id = attributes[:'managedInstanceId'] if attributes[:'managedInstanceId']

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

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

  self.host_name = attributes[:'hostName'] if attributes[:'hostName']

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

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

  self.time_first_event = attributes[:'timeFirstEvent'] if attributes[:'timeFirstEvent']

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

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

  self.time_last_event = attributes[:'timeLastEvent'] if attributes[:'timeLastEvent']

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

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

  self.total_event_count = attributes[:'totalEventCount'] if attributes[:'totalEventCount']

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

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

  self.summarized_event_count = attributes[:'summarizedEventCount'] if attributes[:'summarizedEventCount']

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

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

  self.finding_count = attributes[:'findingCount'] if attributes[:'findingCount']

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

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

  self.non_compliant_finding_count = attributes[:'nonCompliantFindingCount'] if attributes[:'nonCompliantFindingCount']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.crypto_roadmap_version = attributes[:'cryptoRoadmapVersion'] if attributes[:'cryptoRoadmapVersion']

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

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

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

  self.bucket_name = attributes[:'bucketName'] if attributes[:'bucketName']

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

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

  self.object_name = attributes[:'objectName'] if attributes[:'objectName']

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

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

Instance Attribute Details

#aggregation_mode ⇒ String

[Required] The result aggregation mode

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 28

def aggregation_mode
  @aggregation_mode
end

#bucket_name ⇒ String

[Required] The Object Storage bucket name of this analysis result.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 83

def bucket_name
  @bucket_name
end

#crypto_roadmap_version ⇒ String

[Required] The Crypto Roadmap version used to perform the analysis.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 75

def crypto_roadmap_version
  @crypto_roadmap_version
end

#finding_count ⇒ Integer

[Required] Total number of findings with the analysis.

Returns:

  • (Integer) 


60
61
62
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 60

def finding_count
  @finding_count
end

#fleet_id ⇒ String

[Required] The fleet OCID.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 32

def fleet_id
  @fleet_id
end

#host_name ⇒ String

The hostname of the managed instance.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 40

def host_name
  @host_name
end

#id ⇒ String

[Required] The OCID to identify this analysis results.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 20

def id
  @id
end

#managed_instance_id ⇒ String

The managed instance OCID.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 36

def managed_instance_id
  @managed_instance_id
end

#namespace ⇒ String

[Required] The Object Storage namespace of this analysis result.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 79

def namespace
  @namespace
end

#non_compliant_finding_count ⇒ Integer

[Required] Total number of non-compliant findings with the analysis. A non-compliant finding means the application won't work properly with the changes introduced by the Crypto Roadmap version used by the analysis.

Returns:

  • (Integer) 


67
68
69
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 67

def non_compliant_finding_count
  @non_compliant_finding_count
end

#object_name ⇒ String

[Required] The Object Storage object name of this analysis result.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 87

def object_name
  @object_name
end

#summarized_event_count ⇒ Integer

[Required] Total number of summarized events. Summarized events are deduplicated events of interest.

Returns:

  • (Integer) 


56
57
58
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 56

def summarized_event_count
  @summarized_event_count
end

#time_created ⇒ DateTime

The time the result is compiled.

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 71

def time_created
  @time_created
end

#time_first_event ⇒ DateTime

Time of the first event in the analysis.

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 44

def time_first_event
  @time_first_event
end

#time_last_event ⇒ DateTime

Time of the last event in the analysis.

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 48

def time_last_event
  @time_last_event
end

#total_event_count ⇒ Integer

[Required] Total number of events in the analysis.

Returns:

  • (Integer) 


52
53
54
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 52

def total_event_count
  @total_event_count
end

#work_request_id ⇒ String

The OCID of the work request to start the analysis.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 24

def work_request_id
  @work_request_id
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 90

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'work_request_id': :'workRequestId',
    'aggregation_mode': :'aggregationMode',
    'fleet_id': :'fleetId',
    'managed_instance_id': :'managedInstanceId',
    'host_name': :'hostName',
    'time_first_event': :'timeFirstEvent',
    'time_last_event': :'timeLastEvent',
    'total_event_count': :'totalEventCount',
    'summarized_event_count': :'summarizedEventCount',
    'finding_count': :'findingCount',
    'non_compliant_finding_count': :'nonCompliantFindingCount',
    'time_created': :'timeCreated',
    'crypto_roadmap_version': :'cryptoRoadmapVersion',
    'namespace': :'namespace',
    'bucket_name': :'bucketName',
    'object_name': :'objectName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 115

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'work_request_id': :'String',
    'aggregation_mode': :'String',
    'fleet_id': :'String',
    'managed_instance_id': :'String',
    'host_name': :'String',
    'time_first_event': :'DateTime',
    'time_last_event': :'DateTime',
    'total_event_count': :'Integer',
    'summarized_event_count': :'Integer',
    'finding_count': :'Integer',
    'non_compliant_finding_count': :'Integer',
    'time_created': :'DateTime',
    'crypto_roadmap_version': :'String',
    'namespace': :'String',
    'bucket_name': :'String',
    'object_name': :'String'
    # 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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 283

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

  self.class == other.class &&
    id == other.id &&
    work_request_id == other.work_request_id &&
    aggregation_mode == other.aggregation_mode &&
    fleet_id == other.fleet_id &&
    managed_instance_id == other.managed_instance_id &&
    host_name == other.host_name &&
    time_first_event == other.time_first_event &&
    time_last_event == other.time_last_event &&
    total_event_count == other.total_event_count &&
    summarized_event_count == other.summarized_event_count &&
    finding_count == other.finding_count &&
    non_compliant_finding_count == other.non_compliant_finding_count &&
    time_created == other.time_created &&
    crypto_roadmap_version == other.crypto_roadmap_version &&
    namespace == other.namespace &&
    bucket_name == other.bucket_name &&
    object_name == other.object_name
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 329

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


309
310
311
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 309

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



318
319
320
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 318

def hash
  [id, work_request_id, aggregation_mode, fleet_id, managed_instance_id, host_name, time_first_event, time_last_event, total_event_count, summarized_event_count, finding_count, non_compliant_finding_count, time_created, crypto_roadmap_version, namespace, bucket_name, object_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 362

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



356
357
358
 
# File 'lib/oci/jms/models/crypto_analysis_result_summary.rb', line 356

def to_s
  to_hash.to_s
end