Class: OCI::DataSafe::Models::CollectedAuditVolumeSummary

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

Overview

The volume data point for audit data collected by datasafe.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CollectedAuditVolumeSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 64

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

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

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

  self.month_in_consideration = attributes[:'monthInConsideration'] if attributes[:'monthInConsideration']

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

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

  self.online_volume = attributes[:'onlineVolume'] if attributes[:'onlineVolume']

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

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

  self.archived_volume = attributes[:'archivedVolume'] if attributes[:'archivedVolume']

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

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

Instance Attribute Details

#archived_volume ⇒ Integer

[Required] The audit data volume collected by Data Safe and is available in archive storage.

Returns:

  • (Integer) 


28
29
30
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 28

def archived_volume
  @archived_volume
end

#audit_profile_id ⇒ String

[Required] The OCID of the audit profile resource.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 13

def audit_profile_id
  @audit_profile_id
end

#month_in_consideration ⇒ DateTime

[Required] Represents the month under consideration in which the aggregated audit data volume collected by Data Safe is displayed. This field will be the UTC start of the day of the first day of the month for which the aggregate count corresponds to, in the format defined by RFC3339.. For instance, the value of 01-01-2021T00:00:00Z represents Jan 2021.

Returns:

  • (DateTime) 


20
21
22
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 20

def month_in_consideration
  @month_in_consideration
end

#online_volume ⇒ Integer

[Required] The audit data volume collected by Data Safe and is available online in repository.

Returns:

  • (Integer) 


24
25
26
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 24

def online_volume
  @online_volume
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'audit_profile_id': :'auditProfileId',
    'month_in_consideration': :'monthInConsideration',
    'online_volume': :'onlineVolume',
    'archived_volume': :'archivedVolume'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'audit_profile_id': :'String',
    'month_in_consideration': :'DateTime',
    'online_volume': :'Integer',
    'archived_volume': :'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



102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 102

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

  self.class == other.class &&
    audit_profile_id == other.audit_profile_id &&
    month_in_consideration == other.month_in_consideration &&
    online_volume == other.online_volume &&
    archived_volume == other.archived_volume
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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 135

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


115
116
117
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 124

def hash
  [audit_profile_id, month_in_consideration, online_volume, archived_volume].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 168

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



162
163
164
 
# File 'lib/oci/data_safe/models/collected_audit_volume_summary.rb', line 162

def to_s
  to_hash.to_s
end