Class: OCI::DataSafe::Models::StartAuditTrailDetails

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

Overview

The details used to start an audit trail.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StartAuditTrailDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 58

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_collection_start_time = attributes[:'auditCollectionStartTime'] if attributes[:'auditCollectionStartTime']

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

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

  self.is_auto_purge_enabled = attributes[:'isAutoPurgeEnabled'] unless attributes[:'isAutoPurgeEnabled'].nil?
  self.is_auto_purge_enabled = false if is_auto_purge_enabled.nil? && !attributes.key?(:'isAutoPurgeEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_auto_purge_enabled = attributes[:'is_auto_purge_enabled'] unless attributes[:'is_auto_purge_enabled'].nil?
  self.is_auto_purge_enabled = false if is_auto_purge_enabled.nil? && !attributes.key?(:'isAutoPurgeEnabled') && !attributes.key?(:'is_auto_purge_enabled') # rubocop:disable Style/StringLiterals

  self.can_update_last_archive_time_on_target = attributes[:'canUpdateLastArchiveTimeOnTarget'] unless attributes[:'canUpdateLastArchiveTimeOnTarget'].nil?
  self.can_update_last_archive_time_on_target = true if can_update_last_archive_time_on_target.nil? && !attributes.key?(:'canUpdateLastArchiveTimeOnTarget') # rubocop:disable Style/StringLiterals

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

  self.can_update_last_archive_time_on_target = attributes[:'can_update_last_archive_time_on_target'] unless attributes[:'can_update_last_archive_time_on_target'].nil?
  self.can_update_last_archive_time_on_target = true if can_update_last_archive_time_on_target.nil? && !attributes.key?(:'canUpdateLastArchiveTimeOnTarget') && !attributes.key?(:'can_update_last_archive_time_on_target') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#audit_collection_start_timeDateTime

[Required] The date from which the audit trail must start collecting data, in the format defined by RFC3339.

Returns:

  • (DateTime)


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

def audit_collection_start_time
  @audit_collection_start_time
end

#can_update_last_archive_time_on_targetBOOLEAN

Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true.

Returns:

  • (BOOLEAN)


25
26
27
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 25

def can_update_last_archive_time_on_target
  @can_update_last_archive_time_on_target
end

#is_auto_purge_enabledBOOLEAN

Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large.

Returns:

  • (BOOLEAN)


19
20
21
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 19

def is_auto_purge_enabled
  @is_auto_purge_enabled
end

Class Method Details

.attribute_mapObject

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



28
29
30
31
32
33
34
35
36
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'audit_collection_start_time': :'auditCollectionStartTime',
    'is_auto_purge_enabled': :'isAutoPurgeEnabled',
    'can_update_last_archive_time_on_target': :'canUpdateLastArchiveTimeOnTarget'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



39
40
41
42
43
44
45
46
47
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'audit_collection_start_time': :'DateTime',
    'is_auto_purge_enabled': :'BOOLEAN',
    'can_update_last_archive_time_on_target': :'BOOLEAN'
    # 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



94
95
96
97
98
99
100
101
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 94

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

  self.class == other.class &&
    audit_collection_start_time == other.audit_collection_start_time &&
    is_auto_purge_enabled == other.is_auto_purge_enabled &&
    can_update_last_archive_time_on_target == other.can_update_last_archive_time_on_target
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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 126

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


106
107
108
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 106

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

def hash
  [audit_collection_start_time, is_auto_purge_enabled, can_update_last_archive_time_on_target].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 159

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



153
154
155
# File 'lib/oci/data_safe/models/start_audit_trail_details.rb', line 153

def to_s
  to_hash.to_s
end