class OCI::CloudGuard::Models::SecurityScoreTrendAggregation

Provides the dimensions and their corresponding time and security score.

Constants

SECURITY_RATING_ENUM

Attributes

dimensions_map[RW]

[Required] The key-value pairs of dimensions and their names. @return [Hash<String, String>]

duration_in_seconds[RW]

[Required] Duration @return [Integer]

security_rating[R]

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

security_score[RW]

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

start_timestamp[RW]

[Required] Start Time in epoch seconds @return [Float]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 41
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Hash<String, String>] :dimensions_map The value to assign to the {#dimensions_map} property @option attributes [Float] :start_timestamp The value to assign to the {#start_timestamp} property @option attributes [Integer] :duration_in_seconds The value to assign to the {#duration_in_seconds} property @option attributes [String] :security_rating The value to assign to the {#security_rating} property @option attributes [Integer] :security_score The value to assign to the {#security_score} property

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 77
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 54
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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 134
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 168
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 148
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 157
def hash
  [dimensions_map, start_timestamp, duration_in_seconds, security_rating, security_score].hash
end
security_rating=(security_rating) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] security_rating Object to be assigned

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 118
def security_rating=(security_rating)
  # rubocop:disable Style/ConditionalAssignment
  if security_rating && !SECURITY_RATING_ENUM.include?(security_rating)
    OCI.logger.debug("Unknown value for 'security_rating' [" + security_rating + "]. Mapping to 'SECURITY_RATING_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @security_rating = SECURITY_RATING_UNKNOWN_ENUM_VALUE
  else
    @security_rating = security_rating
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 201
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 195
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/cloud_guard/models/security_score_trend_aggregation.rb, line 218
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end