Class: OCI::DataSafe::Models::FindingAnalyticsSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/finding_analytics_summary.rb

Overview

The summary of information about the analytics data of findings or top findings. It includes details such as metric name, findinKey, title (topFindingCategory for top finding), severity (topFindingStatus for top finding) and targetId.

Constant Summary collapse

METRIC_NAME_ENUM = 
[
  METRIC_NAME_TOP_FINDING_STATS = 'TOP_FINDING_STATS'.freeze,
  METRIC_NAME_FINDING_STATS = 'FINDING_STATS'.freeze,
  METRIC_NAME_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FindingAnalyticsSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 63

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

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

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

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

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

Instance Attribute Details

#count ⇒ Integer

[Required] The total count for the aggregation metric.

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 30

def count
  @count
end

#dimensions ⇒ OCI::DataSafe::Models::FindingAnalyticsDimensions

Returns:



26
27
28
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 26

def dimensions
  @dimensions
end

#metric_name ⇒ String

[Required] The name of the aggregation metric.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 23

def metric_name
  @metric_name
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_name': :'metricName',
    'dimensions': :'dimensions',
    'count': :'count'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_name': :'String',
    'dimensions': :'OCI::DataSafe::Models::FindingAnalyticsDimensions',
    'count': :'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



100
101
102
103
104
105
106
107
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 100

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

  self.class == other.class &&
    metric_name == other.metric_name &&
    dimensions == other.dimensions &&
    count == other.count
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



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/data_safe/models/finding_analytics_summary.rb', line 132

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


112
113
114
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 112

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 121

def hash
  [metric_name, dimensions, count].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 165

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



159
160
161
 
# File 'lib/oci/data_safe/models/finding_analytics_summary.rb', line 159

def to_s
  to_hash.to_s
end