Class: OCI::DataSafe::Models::SqlFirewallPolicySummary

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

Overview

The SQL firewall policy resource contains the firewall policy metadata for a single user.

Constant Summary collapse

SQL_LEVEL_ENUM = 
[
  SQL_LEVEL_USER_ISSUED_SQL = 'USER_ISSUED_SQL'.freeze,
  SQL_LEVEL_ALL_SQL = 'ALL_SQL'.freeze,
  SQL_LEVEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ENFORCEMENT_SCOPE_ENUM = 
[
  ENFORCEMENT_SCOPE_ENFORCE_CONTEXT = 'ENFORCE_CONTEXT'.freeze,
  ENFORCEMENT_SCOPE_ENFORCE_SQL = 'ENFORCE_SQL'.freeze,
  ENFORCEMENT_SCOPE_ENFORCE_ALL = 'ENFORCE_ALL'.freeze,
  ENFORCEMENT_SCOPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
VIOLATION_ACTION_ENUM = 
[
  VIOLATION_ACTION_BLOCK = 'BLOCK'.freeze,
  VIOLATION_ACTION_OBSERVE = 'OBSERVE'.freeze,
  VIOLATION_ACTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
VIOLATION_AUDIT_ENUM = 
[
  VIOLATION_AUDIT_ENABLED = 'ENABLED'.freeze,
  VIOLATION_AUDIT_DISABLED = 'DISABLED'.freeze,
  VIOLATION_AUDIT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  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 = {}) ⇒ SqlFirewallPolicySummary

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :security_policy_id (String) —

    The value to assign to the #security_policy_id property

  • :db_user_name (String) —

    The value to assign to the #db_user_name property

  • :sql_level (String) —

    The value to assign to the #sql_level property

  • :status (String) —

    The value to assign to the #status property

  • :enforcement_scope (String) —

    The value to assign to the #enforcement_scope property

  • :violation_action (String) —

    The value to assign to the #violation_action property

  • :violation_audit (String) —

    The value to assign to the #violation_audit property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details 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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 206

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

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

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

  self.sql_level = attributes[:'sqlLevel'] if attributes[:'sqlLevel']

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

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

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

  self.enforcement_scope = attributes[:'enforcementScope'] if attributes[:'enforcementScope']

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

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

  self.violation_action = attributes[:'violationAction'] if attributes[:'violationAction']

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

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

  self.violation_audit = attributes[:'violationAudit'] if attributes[:'violationAudit']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  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 containing the SQL firewall policy.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 62

def compartment_id
  @compartment_id
end

#db_user_name ⇒ String

[Required] The database user name.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 78

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


131
132
133
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 131

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the SQL firewall policy.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 70

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the SQL firewall policy.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 66

def display_name
  @display_name
end

#enforcement_scope ⇒ String

Specifies the SQL firewall policy enforcement option.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 93

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


124
125
126
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 124

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the SQL firewall policy.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 58

def id
  @id
end

#lifecycle_details ⇒ String

Details about the current state of the SQL firewall policy in Data Safe.

Returns:

  • (String) 


117
118
119
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 117

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the SQL firewall policy.

Returns:

  • (String) 


113
114
115
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 113

def lifecycle_state
  @lifecycle_state
end

#security_policy_id ⇒ String

[Required] The OCID of the security policy corresponding to the SQL firewall policy.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 74

def security_policy_id
  @security_policy_id
end

#sql_level ⇒ String

Specifies the level of SQL included for this SQL firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 85

def sql_level
  @sql_level
end

#status ⇒ String

[Required] Specifies whether the SQL firewall policy is enabled or disabled.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 89

def status
  @status
end

#time_created ⇒ DateTime

[Required] The time that the SQL firewall policy was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


105
106
107
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 105

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the SQL firewall policy was last updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


109
110
111
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 109

def time_updated
  @time_updated
end

#violation_action ⇒ String

Specifies the SQL firewall action based on detection of SQL firewall violations.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 97

def violation_action
  @violation_action
end

#violation_audit ⇒ String

Specifies whether a unified audit policy should be enabled for auditing the SQL firewall policy violations.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 101

def violation_audit
  @violation_audit
end

Class Method Details

.attribute_map ⇒ Object

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 134

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'security_policy_id': :'securityPolicyId',
    'db_user_name': :'dbUserName',
    'sql_level': :'sqlLevel',
    'status': :'status',
    'enforcement_scope': :'enforcementScope',
    'violation_action': :'violationAction',
    'violation_audit': :'violationAudit',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 159

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'security_policy_id': :'String',
    'db_user_name': :'String',
    'sql_level': :'String',
    'status': :'String',
    'enforcement_scope': :'String',
    'violation_action': :'String',
    'violation_audit': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    '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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 388

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    security_policy_id == other.security_policy_id &&
    db_user_name == other.db_user_name &&
    sql_level == other.sql_level &&
    status == other.status &&
    enforcement_scope == other.enforcement_scope &&
    violation_action == other.violation_action &&
    violation_audit == other.violation_audit &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 434

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


414
415
416
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 414

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



423
424
425
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 423

def hash
  [id, compartment_id, display_name, description, security_policy_id, db_user_name, sql_level, status, enforcement_scope, violation_action, violation_audit, time_created, time_updated, lifecycle_state, lifecycle_details, 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



467
468
469
470
471
472
473
474
475
476
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 467

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



461
462
463
 
# File 'lib/oci/data_safe/models/sql_firewall_policy_summary.rb', line 461

def to_s
  to_hash.to_s
end