Class: OCI::KeyManagement::Models::AuditLoggingConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/key_management/models/audit_logging_config.rb

Overview

Configuration for management audit logging for the cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuditLoggingConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :is_enabled (BOOLEAN)

    The value to assign to the #is_enabled property

  • :bucket_name (String)

    The value to assign to the #bucket_name property

  • :namespace (String)

    The value to assign to the #namespace property

  • :compartment_id (String)

    The value to assign to the #compartment_id property



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
86
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 61

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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?

  self.bucket_name = attributes[:'bucketName'] if attributes[:'bucketName']

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

Instance Attribute Details

#bucket_nameString

Name of the object store bucket for audit logs.

Returns:

  • (String)


17
18
19
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 17

def bucket_name
  @bucket_name
end

#compartment_idString

OCID of the compartment for the bucket.

Returns:

  • (String)


25
26
27
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 25

def compartment_id
  @compartment_id
end

#is_enabledBOOLEAN

Indicates if management audit logging is enabled.

Returns:

  • (BOOLEAN)


13
14
15
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 13

def is_enabled
  @is_enabled
end

#namespaceString

Object storage namespace for the bucket.

Returns:

  • (String)


21
22
23
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 21

def namespace
  @namespace
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
37
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'isEnabled',
    'bucket_name': :'bucketName',
    'namespace': :'namespace',
    'compartment_id': :'compartmentId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'BOOLEAN',
    'bucket_name': :'String',
    'namespace': :'String',
    'compartment_id': :'String'
    # 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



95
96
97
98
99
100
101
102
103
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 95

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

  self.class == other.class &&
    is_enabled == other.is_enabled &&
    bucket_name == other.bucket_name &&
    namespace == other.namespace &&
    compartment_id == other.compartment_id
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



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

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


108
109
110
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 108

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



117
118
119
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 117

def hash
  [is_enabled, bucket_name, namespace, compartment_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 161

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



155
156
157
# File 'lib/oci/key_management/models/audit_logging_config.rb', line 155

def to_s
  to_hash.to_s
end