Class: OCI::KeyManagement::Models::EnableAuditMgmtLogging

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

Overview

Audit Log resource for tracking status and details of audit logging operations on HSM clusters.

Constant Summary collapse

AUDIT_LOGGING_STATUS_ENUM = 
[
  AUDIT_LOGGING_STATUS_CREATING = 'CREATING'.freeze,
  AUDIT_LOGGING_STATUS_WAITING_FOR_CUSTOMER = 'WAITING_FOR_CUSTOMER'.freeze,
  AUDIT_LOGGING_STATUS_VERIFYING = 'VERIFYING'.freeze,
  AUDIT_LOGGING_STATUS_DISABLING_IN_PROGRESS = 'DISABLING_IN_PROGRESS'.freeze,
  AUDIT_LOGGING_STATUS_DISABLED_VALIDATED = 'DISABLED_VALIDATED'.freeze,
  AUDIT_LOGGING_STATUS_ENABLED = 'ENABLED'.freeze,
  AUDIT_LOGGING_STATUS_DISABLED = 'DISABLED'.freeze,
  AUDIT_LOGGING_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnableAuditMgmtLogging

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :hsm_cluster_id (String) —

    The value to assign to the #hsm_cluster_id property

  • :customer_bucket_name (String) —

    The value to assign to the #customer_bucket_name property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :cluster_compartment_id (String) —

    The value to assign to the #cluster_compartment_id property

  • :audit_logging_status (String) —

    The value to assign to the #audit_logging_status property



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

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

  self.hsm_cluster_id = attributes[:'hsmClusterId'] if attributes[:'hsmClusterId']

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

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

  self.customer_bucket_name = attributes[:'customerBucketName'] if attributes[:'customerBucketName']

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

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

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

  self.cluster_compartment_id = attributes[:'clusterCompartmentId'] if attributes[:'clusterCompartmentId']

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

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

  self.audit_logging_status = attributes[:'auditLoggingStatus'] if attributes[:'auditLoggingStatus']

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

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

Instance Attribute Details

#audit_logging_status ⇒ String

[Required] Status of the audit logging.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 46

def audit_logging_status
  @audit_logging_status
end

#cluster_compartment_id ⇒ String

[Required] Compartment OCID for the HSM cluster (bucket compartment).

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 42

def cluster_compartment_id
  @cluster_compartment_id
end

#customer_bucket_name ⇒ String

[Required] Name of the audit log's associated customer bucket.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 34

def customer_bucket_name
  @customer_bucket_name
end

#hsm_cluster_id ⇒ String

[Required] OCID of the HSM Cluster.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 30

def hsm_cluster_id
  @hsm_cluster_id
end

#id ⇒ String

[Required] Workflow request identifier.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 26

def id
  @id
end

#namespace ⇒ String

[Required] Object Storage namespace of the bucket.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 38

def namespace
  @namespace
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'hsm_cluster_id': :'hsmClusterId',
    'customer_bucket_name': :'customerBucketName',
    'namespace': :'namespace',
    'cluster_compartment_id': :'clusterCompartmentId',
    'audit_logging_status': :'auditLoggingStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'hsm_cluster_id': :'String',
    'customer_bucket_name': :'String',
    'namespace': :'String',
    'cluster_compartment_id': :'String',
    'audit_logging_status': :'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



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 143

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

  self.class == other.class &&
    id == other.id &&
    hsm_cluster_id == other.hsm_cluster_id &&
    customer_bucket_name == other.customer_bucket_name &&
    namespace == other.namespace &&
    cluster_compartment_id == other.cluster_compartment_id &&
    audit_logging_status == other.audit_logging_status
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 178

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


158
159
160
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 158

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 167

def hash
  [id, hsm_cluster_id, customer_bucket_name, namespace, cluster_compartment_id, audit_logging_status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 211

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



205
206
207
 
# File 'lib/oci/key_management/models/enable_audit_mgmt_logging.rb', line 205

def to_s
  to_hash.to_s
end