Class: OCI::DataSafe::Models::UpdateAuditTrailDetails

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

Overview

The details used to update an audit trail.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateAuditTrailDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :is_auto_purge_enabled (BOOLEAN) —

    The value to assign to the #is_auto_purge_enabled property

  • :can_update_last_archive_time_on_target (BOOLEAN) —

    The value to assign to the #can_update_last_archive_time_on_target property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 84

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#can_update_last_archive_time_on_target ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


29
30
31
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 29

def can_update_last_archive_time_on_target
  @can_update_last_archive_time_on_target
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


42
43
44
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 42

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the audit trail.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

The display name of the audit trail. The name does not have to be unique, and it's updatable.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 17

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


36
37
38
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 36

def freeform_tags
  @freeform_tags
end

#is_auto_purge_enabled ⇒ BOOLEAN

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) 


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

def is_auto_purge_enabled
  @is_auto_purge_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'display_name': :'displayName',
    'is_auto_purge_enabled': :'isAutoPurgeEnabled',
    'can_update_last_archive_time_on_target': :'canUpdateLastArchiveTimeOnTarget',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'display_name': :'String',
    'is_auto_purge_enabled': :'BOOLEAN',
    'can_update_last_archive_time_on_target': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 134

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

  self.class == other.class &&
    description == other.description &&
    display_name == other.display_name &&
    is_auto_purge_enabled == other.is_auto_purge_enabled &&
    can_update_last_archive_time_on_target == other.can_update_last_archive_time_on_target &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



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

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


149
150
151
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 158

def hash
  [description, display_name, is_auto_purge_enabled, can_update_last_archive_time_on_target, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 202

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



196
197
198
 
# File 'lib/oci/data_safe/models/update_audit_trail_details.rb', line 196

def to_s
  to_hash.to_s
end