Class: OCI::CloudGuard::Models::SecurityScoreTrendAggregation

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/security_score_trend_aggregation.rb

Overview

Provides the dimensions and their corresponding time and security score.

Constant Summary collapse

SECURITY_RATING_ENUM =
[
  SECURITY_RATING_EXCELLENT = 'EXCELLENT'.freeze,
  SECURITY_RATING_GOOD = 'GOOD'.freeze,
  SECURITY_RATING_FAIR = 'FAIR'.freeze,
  SECURITY_RATING_POOR = 'POOR'.freeze,
  SECURITY_RATING_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecurityScoreTrendAggregation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :dimensions_map (Hash<String, String>)

    The value to assign to the #dimensions_map property

  • :start_timestamp (Float)

    The value to assign to the #start_timestamp property

  • :duration_in_seconds (Integer)

    The value to assign to the #duration_in_seconds property

  • :security_rating (String)

    The value to assign to the #security_rating property

  • :security_score (Integer)

    The value to assign to the #security_score property



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 76

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

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

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

  self.start_timestamp = attributes[:'startTimestamp'] if attributes[:'startTimestamp']

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

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

  self.duration_in_seconds = attributes[:'durationInSeconds'] if attributes[:'durationInSeconds']

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

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

  self.security_rating = attributes[:'securityRating'] if attributes[:'securityRating']

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

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

  self.security_score = attributes[:'securityScore'] if attributes[:'securityScore']

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

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

Instance Attribute Details

#dimensions_mapHash<String, String>

[Required] The key-value pairs of dimensions and their names.

Returns:

  • (Hash<String, String>)


21
22
23
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 21

def dimensions_map
  @dimensions_map
end

#duration_in_secondsInteger

[Required] Duration

Returns:

  • (Integer)


29
30
31
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 29

def duration_in_seconds
  @duration_in_seconds
end

#security_ratingString

[Required] The security rating with given dimensions and time range

Returns:

  • (String)


33
34
35
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 33

def security_rating
  @security_rating
end

#security_scoreInteger

[Required] The security score with given dimensions and time range

Returns:

  • (Integer)


37
38
39
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 37

def security_score
  @security_score
end

#start_timestampFloat

[Required] Start Time in epoch seconds

Returns:

  • (Float)


25
26
27
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 25

def start_timestamp
  @start_timestamp
end

Class Method Details

.attribute_mapObject

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



40
41
42
43
44
45
46
47
48
49
50
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 40

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'dimensions_map': :'dimensionsMap',
    'start_timestamp': :'startTimestamp',
    'duration_in_seconds': :'durationInSeconds',
    'security_rating': :'securityRating',
    'security_score': :'securityScore'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'dimensions_map': :'Hash<String, String>',
    'start_timestamp': :'Float',
    'duration_in_seconds': :'Integer',
    'security_rating': :'String',
    'security_score': :'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



133
134
135
136
137
138
139
140
141
142
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 133

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

  self.class == other.class &&
    dimensions_map == other.dimensions_map &&
    start_timestamp == other.start_timestamp &&
    duration_in_seconds == other.duration_in_seconds &&
    security_rating == other.security_rating &&
    security_score == other.security_score
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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 167

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


147
148
149
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 147

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



156
157
158
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 156

def hash
  [dimensions_map, start_timestamp, duration_in_seconds, security_rating, security_score].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



200
201
202
203
204
205
206
207
208
209
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 200

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



194
195
196
# File 'lib/oci/cloud_guard/models/security_score_trend_aggregation.rb', line 194

def to_s
  to_hash.to_s
end