Class: OCI::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb

Overview

Description of a database API gateway config setting to be provided as an advanced property.

Constant Summary collapse

DATA_TYPE_ENUM = 
[
  DATA_TYPE_STRING = 'STRING'.freeze,
  DATA_TYPE_NUMBER = 'NUMBER'.freeze,
  DATA_TYPE_DURATION = 'DURATION'.freeze,
  DATA_TYPE_BOOLEAN = 'BOOLEAN'.freeze,
  DATA_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CONFIG_TYPES_ENUM = 
[
  CONFIG_TYPES_GLOBAL = 'GLOBAL'.freeze,
  CONFIG_TYPES_POOL = 'POOL'.freeze,
  CONFIG_TYPES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATABASE_TOOLS_CONNECTION_TYPES_ENUM = 
[
  DATABASE_TOOLS_CONNECTION_TYPES_ORACLE_DATABASE = 'ORACLE_DATABASE'.freeze,
  DATABASE_TOOLS_CONNECTION_TYPES_MYSQL = 'MYSQL'.freeze,
  DATABASE_TOOLS_CONNECTION_TYPES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :data_type (String) —

    The value to assign to the #data_type property

  • :config_types (Array<String>) —

    The value to assign to the #config_types property

  • :category_key (String) —

    The value to assign to the #category_key property

  • :category_display_name (String) —

    The value to assign to the #category_display_name property

  • :database_tools_connection_types (Array<String>) —

    The value to assign to the #database_tools_connection_types property

  • :documentation_url (String) —

    The value to assign to the #documentation_url property

  • :description (String) —

    The value to assign to the #description property

  • :default_value (String) —

    The value to assign to the #default_value property

  • :min_value (Integer) —

    The value to assign to the #min_value property

  • :max_value (Integer) —

    The value to assign to the #max_value property

  • :list_of_values (Array<String>) —

    The value to assign to the #list_of_values property

  • :hint_text (String) —

    The value to assign to the #hint_text property



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
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
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 156

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

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

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

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

  self.config_types = attributes[:'configTypes'] if attributes[:'configTypes']

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

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

  self.category_key = attributes[:'categoryKey'] if attributes[:'categoryKey']

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

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

  self.category_display_name = attributes[:'categoryDisplayName'] if attributes[:'categoryDisplayName']

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

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

  self.database_tools_connection_types = attributes[:'databaseToolsConnectionTypes'] if attributes[:'databaseToolsConnectionTypes']

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

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

  self.documentation_url = attributes[:'documentationUrl'] if attributes[:'documentationUrl']

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

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

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

  self.default_value = attributes[:'defaultValue'] if attributes[:'defaultValue']

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

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

  self.min_value = attributes[:'minValue'] if attributes[:'minValue']

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

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

  self.max_value = attributes[:'maxValue'] if attributes[:'maxValue']

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

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

  self.list_of_values = attributes[:'listOfValues'] if attributes[:'listOfValues']

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

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

  self.hint_text = attributes[:'hintText'] if attributes[:'hintText']

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

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

Instance Attribute Details

#category_display_name ⇒ String

A user-friendly name of a category.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 55

def category_display_name
  @category_display_name
end

#category_key ⇒ String

The category of the Database Tools database API gateway config global setting.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 51

def category_key
  @category_key
end

#config_types ⇒ Array<String>

The config types that support this advanced property. The supported types are GLOBAL and POOL.

Returns:

  • (Array<String>) 


47
48
49
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 47

def config_types
  @config_types
end

#data_type ⇒ String

[Required] The data type of a database API gateway config setting.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 42

def data_type
  @data_type
end

#database_tools_connection_types ⇒ Array<String>

The type of database (as determined by a type of Database Tools connection) to which this setting applies. The advancedProperty applies to all types of Database Tools connection when null. This is only applicable when configTypes includes POOL.

Returns:

  • (Array<String>) 


62
63
64
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 62

def database_tools_connection_types
  @database_tools_connection_types
end

#default_value ⇒ String

The default value (if applicable) of a database API gateway config setting.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 74

def default_value
  @default_value
end

#description ⇒ String

A user-friendly description of a database API gateway config setting.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 70

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 38

def display_name
  @display_name
end

#documentation_url ⇒ String

Uniform resource locator (URL) of documentation related to this setting.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 66

def documentation_url
  @documentation_url
end

#hint_text ⇒ String

Hint text for a database API gateway config setting.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 90

def hint_text
  @hint_text
end

#key ⇒ String

[Required] A string that uniquely identifies a Database Tools database API gateway config global settings resource.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 34

def key
  @key
end

#list_of_values ⇒ Array<String>

A list of string values (if applicable) supported by this database API gateway config setting.

Returns:

  • (Array<String>) 


86
87
88
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 86

def list_of_values
  @list_of_values
end

#max_value ⇒ Integer

A maximum numeric value (if applicable) of a database API gateway config setting.

Returns:

  • (Integer) 


82
83
84
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 82

def max_value
  @max_value
end

#min_value ⇒ Integer

A minimum numeric value (if applicable) of a database API gateway config setting.

Returns:

  • (Integer) 


78
79
80
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 78

def min_value
  @min_value
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'data_type': :'dataType',
    'config_types': :'configTypes',
    'category_key': :'categoryKey',
    'category_display_name': :'categoryDisplayName',
    'database_tools_connection_types': :'databaseToolsConnectionTypes',
    'documentation_url': :'documentationUrl',
    'description': :'description',
    'default_value': :'defaultValue',
    'min_value': :'minValue',
    'max_value': :'maxValue',
    'list_of_values': :'listOfValues',
    'hint_text': :'hintText'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 115

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'data_type': :'String',
    'config_types': :'Array<String>',
    'category_key': :'String',
    'category_display_name': :'String',
    'database_tools_connection_types': :'Array<String>',
    'documentation_url': :'String',
    'description': :'String',
    'default_value': :'String',
    'min_value': :'Integer',
    'max_value': :'Integer',
    'list_of_values': :'Array<String>',
    'hint_text': :'String'
    # 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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 299

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

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    data_type == other.data_type &&
    config_types == other.config_types &&
    category_key == other.category_key &&
    category_display_name == other.category_display_name &&
    database_tools_connection_types == other.database_tools_connection_types &&
    documentation_url == other.documentation_url &&
    description == other.description &&
    default_value == other.default_value &&
    min_value == other.min_value &&
    max_value == other.max_value &&
    list_of_values == other.list_of_values &&
    hint_text == other.hint_text
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 342

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


322
323
324
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 322

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



331
332
333
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 331

def hash
  [key, display_name, data_type, config_types, category_key, category_display_name, database_tools_connection_types, documentation_url, description, default_value, min_value, max_value, list_of_values, hint_text].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



375
376
377
378
379
380
381
382
383
384
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 375

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



369
370
371
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_advanced_property_summary.rb', line 369

def to_s
  to_hash.to_s
end