Class: OCI::KeyManagement::Models::HsmClusterAuditLoggingInfo

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

Overview

Status of management audit logging for the cluster.

Constant Summary collapse

AUDIT_LOG_LIFECYCLE_STATE_ENUM = 
[
  AUDIT_LOG_LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  AUDIT_LOG_LIFECYCLE_STATE_WAITING_FOR_CUSTOMER = 'WAITING_FOR_CUSTOMER'.freeze,
  AUDIT_LOG_LIFECYCLE_STATE_VERIFYING = 'VERIFYING'.freeze,
  AUDIT_LOG_LIFECYCLE_STATE_DISABLING_IN_PROGRESS = 'DISABLING_IN_PROGRESS'.freeze,
  AUDIT_LOG_LIFECYCLE_STATE_DISABLING_BROKEN = 'DISABLING_BROKEN'.freeze,
  AUDIT_LOG_LIFECYCLE_STATE_DISABLED_VALIDATED = 'DISABLED_VALIDATED'.freeze,
  AUDIT_LOG_LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  AUDIT_LOG_LIFECYCLE_STATE_ENABLED = 'ENABLED'.freeze,
  AUDIT_LOG_LIFECYCLE_STATE_DISABLED = 'DISABLED'.freeze,
  AUDIT_LOG_LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HsmClusterAuditLoggingInfo

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

  • :dynamic_group_name (String) —

    The value to assign to the #dynamic_group_name property

  • :audit_log_lifecycle_state (String) —

    The value to assign to the #audit_log_lifecycle_state property



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
126
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 89

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']

  self.dynamic_group_name = attributes[:'dynamicGroupName'] if attributes[:'dynamicGroupName']

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

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

  self.audit_log_lifecycle_state = attributes[:'auditLogLifecycleState'] if attributes[:'auditLogLifecycleState']

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

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

Instance Attribute Details

#audit_log_lifecycle_state ⇒ String

[Required] The current lifecycle state of the audit logs.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 47

def audit_log_lifecycle_state
  @audit_log_lifecycle_state
end

#bucket_name ⇒ String

[Required] Audit logs bucket name.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 31

def bucket_name
  @bucket_name
end

#compartment_id ⇒ String

[Required] Compartment of the bucket.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 39

def compartment_id
  @compartment_id
end

#dynamic_group_name ⇒ String

[Required] Name of dynamic group used for audit log upload.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 43

def dynamic_group_name
  @dynamic_group_name
end

#is_enabled ⇒ BOOLEAN

[Required] Whether audit logging is enabled.

Returns:

  • (BOOLEAN) 


27
28
29
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 27

def is_enabled
  @is_enabled
end

#namespace ⇒ String

[Required] Bucket namespace.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 35

def namespace
  @namespace
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 50

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

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 64

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



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 148

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 &&
    dynamic_group_name == other.dynamic_group_name &&
    audit_log_lifecycle_state == other.audit_log_lifecycle_state
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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 183

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


163
164
165
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 163

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 172

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 216

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



210
211
212
 
# File 'lib/oci/key_management/models/hsm_cluster_audit_logging_info.rb', line 210

def to_s
  to_hash.to_s
end