Class: OCI::DataSafe::Models::CreateUnifiedAuditPolicyDetails

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

Overview

The details required to create a new unified audit policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateUnifiedAuditPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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/create_unified_audit_policy_details.rb', line 101

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

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

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

  self.unified_audit_policy_definition_id = attributes[:'unifiedAuditPolicyDefinitionId'] if attributes[:'unifiedAuditPolicyDefinitionId']

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

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

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

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

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

  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

#compartment_id ⇒ String

[Required] The OCID of the compartment in which to create the unified audit policy.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 21

def compartment_id
  @compartment_id
end

#conditions ⇒ Array<OCI::DataSafe::Models::PolicyCondition>

[Required] Lists the audit policy provisioning conditions.

Returns:



37
38
39
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 37

def conditions
  @conditions
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>>) 


50
51
52
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 50

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the unified audit policy in Data Safe.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

The display name of the unified audit policy in Data Safe. The name is modifiable and does not need to be unique.

Returns:

  • (String) 


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

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>) 


44
45
46
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 44

def freeform_tags
  @freeform_tags
end

#security_policy_id ⇒ String

[Required] The OCID of the security policy corresponding to the unified audit policy.

Returns:

  • (String) 


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

def security_policy_id
  @security_policy_id
end

#status ⇒ String

[Required] Indicates whether the unified audit policy has been enabled or disabled.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 33

def status
  @status
end

#unified_audit_policy_definition_id ⇒ String

[Required] The OCID of the associated unified audit policy definition.

Returns:

  • (String) 


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

def unified_audit_policy_definition_id
  @unified_audit_policy_definition_id
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'security_policy_id': :'securityPolicyId',
    'unified_audit_policy_definition_id': :'unifiedAuditPolicyDefinitionId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'status': :'status',
    'conditions': :'conditions',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'security_policy_id': :'String',
    'unified_audit_policy_definition_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'status': :'String',
    'conditions': :'Array<OCI::DataSafe::Models::PolicyCondition>',
    '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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 157

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

  self.class == other.class &&
    security_policy_id == other.security_policy_id &&
    unified_audit_policy_definition_id == other.unified_audit_policy_definition_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    status == other.status &&
    conditions == other.conditions &&
    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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 195

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


175
176
177
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 175

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



184
185
186
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 184

def hash
  [security_policy_id, unified_audit_policy_definition_id, compartment_id, display_name, description, status, conditions, 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



228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 228

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



222
223
224
 
# File 'lib/oci/data_safe/models/create_unified_audit_policy_details.rb', line 222

def to_s
  to_hash.to_s
end