Class: OCI::DataSafe::Models::SqlCollection

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

Overview

The resource represents SQL collection for a specific database user in a target. SqlCollection encapsulates the SQL commands issued in the useru2019s database sessions, and its execution context.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_COLLECTING = 'COLLECTING'.freeze,
  LIFECYCLE_STATE_COMPLETED = 'COMPLETED'.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 = {}) ⇒ SqlCollection

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

  • :target_id (String) —

    The value to assign to the #target_id property

  • :status (String) —

    The value to assign to the #status property

  • :db_user_name (String) —

    The value to assign to the #db_user_name property

  • :time_last_started (DateTime) —

    The value to assign to the #time_last_started property

  • :time_last_stopped (DateTime) —

    The value to assign to the #time_last_stopped property

  • :sql_level (String) —

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



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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 191

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

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

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

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

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

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

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

  self.time_last_stopped = attributes[:'timeLastStopped'] if attributes[:'timeLastStopped']

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

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

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

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the SQL collection.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 45

def compartment_id
  @compartment_id
end

#db_user_name ⇒ String

[Required] The database user name.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 65

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


110
111
112
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 110

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the SQL collection.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 53

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the SQL collection.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 49

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


103
104
105
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 103

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the SQL collection.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 41

def id
  @id
end

#lifecycle_details ⇒ String

Details about the current state of the SQL collection in Data Safe.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the SQL collection.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 92

def lifecycle_state
  @lifecycle_state
end

#sql_level ⇒ String

Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 80

def sql_level
  @sql_level
end

#status ⇒ String

[Required] Specifies if the status of the SqlCollection. Enabled indicates that the collecting is in progress.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 61

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


116
117
118
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 116

def system_tags
  @system_tags
end

#target_id ⇒ String

[Required] The OCID of the target corresponding to the security policy deployment.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 57

def target_id
  @target_id
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 84

def time_created
  @time_created
end

#time_last_started ⇒ DateTime

The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339.

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 69

def time_last_started
  @time_last_started
end

#time_last_stopped ⇒ DateTime

The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339.

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 73

def time_last_stopped
  @time_last_stopped
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


88
89
90
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 88

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 119

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'target_id': :'targetId',
    'status': :'status',
    'db_user_name': :'dbUserName',
    'time_last_started': :'timeLastStarted',
    'time_last_stopped': :'timeLastStopped',
    'sql_level': :'sqlLevel',
    '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_types ⇒ Object

Attribute type mapping.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 144

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'target_id': :'String',
    'status': :'String',
    'db_user_name': :'String',
    'time_last_started': :'DateTime',
    'time_last_stopped': :'DateTime',
    'sql_level': :'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



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

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 &&
    target_id == other.target_id &&
    status == other.status &&
    db_user_name == other.db_user_name &&
    time_last_started == other.time_last_started &&
    time_last_stopped == other.time_last_stopped &&
    sql_level == other.sql_level &&
    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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 380

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


360
361
362
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 360

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



369
370
371
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 369

def hash
  [id, compartment_id, display_name, description, target_id, status, db_user_name, time_last_started, time_last_stopped, sql_level, time_created, time_updated, lifecycle_state, lifecycle_details, 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



413
414
415
416
417
418
419
420
421
422
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 413

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



407
408
409
 
# File 'lib/oci/data_safe/models/sql_collection.rb', line 407

def to_s
  to_hash.to_s
end