Class: OCI::DataSafe::Models::CreateSqlCollectionDetails

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

Overview

Details for SQL collection creation.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_DISABLED = 'DISABLED'.freeze
].freeze
SQL_LEVEL_ENUM = 
[
  SQL_LEVEL_USER_ISSUED_SQL = 'USER_ISSUED_SQL'.freeze,
  SQL_LEVEL_ALL_SQL = 'ALL_SQL'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSqlCollectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

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

  • :sql_level (String) —

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



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 114

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.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.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.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.status = "ENABLED" if status.nil? && !attributes.key?(:'status') # rubocop:disable Style/StringLiterals

  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']
  self.sql_level = "ALL_SQL" if sql_level.nil? && !attributes.key?(:'sqlLevel') # rubocop:disable Style/StringLiterals

  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_level = "ALL_SQL" if sql_level.nil? && !attributes.key?(:'sqlLevel') && !attributes.key?(:'sql_level') # rubocop:disable Style/StringLiterals

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#db_user_name ⇒ String

[Required] The database user name.

Returns:

  • (String) 


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

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


63
64
65
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 63

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the SQL collection.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

The display name of the SQL collection. The name does not have to be unique, and it is changeable.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 23

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


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

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


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

def sql_level
  @sql_level
end

#status ⇒ String

Specifies if the SqlCollection has to be started after creation. Enabled indicates that the SqlCollection will be started after creation.

Returns:

  • (String) 


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

def status
  @status
end

#target_id ⇒ String

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

Returns:

  • (String) 


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

def target_id
  @target_id
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'target_id': :'targetId',
    'status': :'status',
    'db_user_name': :'dbUserName',
    'sql_level': :'sqlLevel',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 83

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 193

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    target_id == other.target_id &&
    status == other.status &&
    db_user_name == other.db_user_name &&
    sql_level == other.sql_level &&
    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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 231

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


211
212
213
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 211

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 220

def hash
  [display_name, description, compartment_id, target_id, status, db_user_name, sql_level, 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



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 264

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



258
259
260
 
# File 'lib/oci/data_safe/models/create_sql_collection_details.rb', line 258

def to_s
  to_hash.to_s
end