Class: OCI::DataSafe::Models::SqlFirewallAllowedSqlSummary

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

Overview

The resource represents a SQL firewall allowed SQL in Data Safe.

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
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ SqlFirewallAllowedSqlSummary

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

  • :sql_firewall_policy_id (String) —

    The value to assign to the #sql_firewall_policy_id property

  • :current_user (String) —

    The value to assign to the #current_user property

  • :db_user_name (String) —

    The value to assign to the #db_user_name property

  • :sql_text (String) —

    The value to assign to the #sql_text property

  • :sql_level (String) —

    The value to assign to the #sql_level property

  • :sql_accessed_objects (Array<String>) —

    The value to assign to the #sql_accessed_objects property

  • :version (Float) —

    The value to assign to the #version property

  • :time_collected (DateTime) —

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

  • :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



177
178
179
180
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
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
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 177

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

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

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

  self.current_user = attributes[:'currentUser'] if attributes[:'currentUser']

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

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

  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_text = attributes[:'sqlText'] if attributes[:'sqlText']

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

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

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

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

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

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

  self.time_collected = attributes[:'timeCollected'] if attributes[:'timeCollected']

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

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

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

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the SQL firewall allowed SQL.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 31

def compartment_id
  @compartment_id
end

#current_user ⇒ String

The name of the user that SQL was executed as.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 47

def current_user
  @current_user
end

#db_user_name ⇒ String

[Required] The database user name.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 51

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


96
97
98
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 96

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the SQL firewall allowed SQL.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 39

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 35

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the SQL firewall allowed SQL.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 27

def id
  @id
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 82

def lifecycle_state
  @lifecycle_state
end

#sql_accessed_objects ⇒ Array<String>

The objects accessed by the SQL.

Returns:

  • (Array<String>) 


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

def sql_accessed_objects
  @sql_accessed_objects
end

#sql_firewall_policy_id ⇒ String

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

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 43

def sql_firewall_policy_id
  @sql_firewall_policy_id
end

#sql_level ⇒ String

[Required] 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) 


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

def sql_level
  @sql_level
end

#sql_text ⇒ String

[Required] The SQL text of the SQL firewall allowed SQL.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 55

def sql_text
  @sql_text
end

#system_tags ⇒ Hash<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>>) 


102
103
104
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 102

def system_tags
  @system_tags
end

#time_collected ⇒ DateTime

[Required] The time the the SQL firewall allowed SQL was collected from the target database, in the format defined by RFC3339.

Returns:

  • (DateTime) 


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

def time_collected
  @time_collected
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#version ⇒ Float

[Required] Version of the associated SQL firewall policy. This identifies whether the allowed SQLs were added in the same batch or not.

Returns:

  • (Float) 


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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 105

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'sql_firewall_policy_id': :'sqlFirewallPolicyId',
    'current_user': :'currentUser',
    'db_user_name': :'dbUserName',
    'sql_text': :'sqlText',
    'sql_level': :'sqlLevel',
    'sql_accessed_objects': :'sqlAccessedObjects',
    'version': :'version',
    'time_collected': :'timeCollected',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 130

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'sql_firewall_policy_id': :'String',
    'current_user': :'String',
    'db_user_name': :'String',
    'sql_text': :'String',
    'sql_level': :'String',
    'sql_accessed_objects': :'Array<String>',
    'version': :'Float',
    'time_collected': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 307

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 &&
    sql_firewall_policy_id == other.sql_firewall_policy_id &&
    current_user == other.current_user &&
    db_user_name == other.db_user_name &&
    sql_text == other.sql_text &&
    sql_level == other.sql_level &&
    sql_accessed_objects == other.sql_accessed_objects &&
    version == other.version &&
    time_collected == other.time_collected &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 353

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


333
334
335
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 333

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



342
343
344
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 342

def hash
  [id, compartment_id, display_name, description, sql_firewall_policy_id, current_user, db_user_name, sql_text, sql_level, sql_accessed_objects, version, time_collected, time_updated, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



386
387
388
389
390
391
392
393
394
395
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 386

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



380
381
382
 
# File 'lib/oci/data_safe/models/sql_firewall_allowed_sql_summary.rb', line 380

def to_s
  to_hash.to_s
end