Class: OCI::DataSafe::Models::SqlFirewallPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/sql_firewall_policy.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 = {}) ⇒ SqlFirewallPolicy

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

  • :allowed_client_ips (Array<String>)

    The value to assign to the #allowed_client_ips property

  • :allowed_client_os_usernames (Array<String>)

    The value to assign to the #allowed_client_os_usernames property

  • :allowed_client_programs (Array<String>)

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

  • :system_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #system_tags property



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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 236

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

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

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

  self.allowed_client_os_usernames = attributes[:'allowedClientOsUsernames'] if attributes[:'allowedClientOsUsernames']

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

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

  self.allowed_client_programs = attributes[:'allowedClientPrograms'] if attributes[:'allowedClientPrograms']

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

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#allowed_client_ipsArray<String>

The list of allowed ip addresses for the SQL Firewall policy.

Returns:

  • (Array<String>)


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

def allowed_client_ips
  @allowed_client_ips
end

#allowed_client_os_usernamesArray<String>

The list of allowed operating system user names for the SQL Firewall policy.

Returns:

  • (Array<String>)


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

def allowed_client_os_usernames
  @allowed_client_os_usernames
end

#allowed_client_programsArray<String>

The list of allowed client programs for the SQL Firewall policy.

Returns:

  • (Array<String>)


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

def allowed_client_programs
  @allowed_client_programs
end

#compartment_idString

[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.rb', line 62

def compartment_id
  @compartment_id
end

#db_user_nameString

[Required] The database user name.

Returns:

  • (String)


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

def db_user_name
  @db_user_name
end

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


143
144
145
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 143

def defined_tags
  @defined_tags
end

#descriptionString

The description of the SQL Firewall policy.

Returns:

  • (String)


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

def description
  @description
end

#display_nameString

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

Returns:

  • (String)


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

def display_name
  @display_name
end

#enforcement_scopeString

Specifies the SQL Firewall policy enforcement option.

Returns:

  • (String)


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

def enforcement_scope
  @enforcement_scope
end

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


136
137
138
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 136

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the SQL Firewall policy.

Returns:

  • (String)


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

def id
  @id
end

#lifecycle_detailsString

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

Returns:

  • (String)


129
130
131
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 129

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

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

Returns:

  • (String)


125
126
127
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 125

def lifecycle_state
  @lifecycle_state
end

#security_policy_idString

[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.rb', line 74

def security_policy_id
  @security_policy_id
end

#sql_levelString

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.rb', line 85

def sql_level
  @sql_level
end

#statusString

[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.rb', line 89

def status
  @status
end

#system_tagsHash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


149
150
151
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 149

def system_tags
  @system_tags
end

#time_createdDateTime

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_updatedDateTime

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

Returns:

  • (DateTime)


121
122
123
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 121

def time_updated
  @time_updated
end

#violation_actionString

Specifies the mode in which the SQL Firewall policy is enabled.

Returns:

  • (String)


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

def violation_action
  @violation_action
end

#violation_auditString

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

def violation_audit
  @violation_audit
end

Class Method Details

.attribute_mapObject

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 152

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',
    'allowed_client_ips': :'allowedClientIps',
    'allowed_client_os_usernames': :'allowedClientOsUsernames',
    'allowed_client_programs': :'allowedClientPrograms',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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',
    'allowed_client_ips': :'Array<String>',
    'allowed_client_os_usernames': :'Array<String>',
    'allowed_client_programs': :'Array<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>>',
    'system_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



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 442

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 &&
    allowed_client_ips == other.allowed_client_ips &&
    allowed_client_os_usernames == other.allowed_client_os_usernames &&
    allowed_client_programs == other.allowed_client_programs &&
    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 &&
    system_tags == other.system_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



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 492

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


472
473
474
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 472

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



481
482
483
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 481

def hash
  [id, compartment_id, display_name, description, security_policy_id, db_user_name, sql_level, status, enforcement_scope, violation_action, violation_audit, allowed_client_ips, allowed_client_os_usernames, allowed_client_programs, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



525
526
527
528
529
530
531
532
533
534
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 525

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



519
520
521
# File 'lib/oci/data_safe/models/sql_firewall_policy.rb', line 519

def to_s
  to_hash.to_s
end