Class: OCI::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec

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

Overview

The content of a Database Tools database API gateway config auto API spec sub resource defined within a pool. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_DEFAULT = 'DEFAULT'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATABASE_OBJECT_TYPE_ENUM = 
[
  DATABASE_OBJECT_TYPE_FUNCTION = 'FUNCTION'.freeze,
  DATABASE_OBJECT_TYPE_MVIEW = 'MVIEW'.freeze,
  DATABASE_OBJECT_TYPE_PACKAGE = 'PACKAGE'.freeze,
  DATABASE_OBJECT_TYPE_PROCEDURE = 'PROCEDURE'.freeze,
  DATABASE_OBJECT_TYPE_TABLE = 'TABLE'.freeze,
  DATABASE_OBJECT_TYPE_VIEW = 'VIEW'.freeze,
  DATABASE_OBJECT_TYPE_DUALITYVIEW = 'DUALITYVIEW'.freeze,
  DATABASE_OBJECT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OPERATIONS_ENUM = 
[
  OPERATIONS_READ = 'READ'.freeze,
  OPERATIONS_WRITE = 'WRITE'.freeze,
  OPERATIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SECURITY_SCHEMES_ENUM = 
[
  SECURITY_SCHEMES_BASIC = 'BASIC'.freeze,
  SECURITY_SCHEMES_BEARER = 'BEARER'.freeze,
  SECURITY_SCHEMES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec

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

  • :type (String) —

    The value to assign to the #type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :database_object_name (String) —

    The value to assign to the #database_object_name property

  • :database_object_type (String) —

    The value to assign to the #database_object_type property

  • :description (String) —

    The value to assign to the #description property

  • :_alias (String) —

    The value to assign to the #_alias property

  • :operations (Array<String>) —

    The value to assign to the #operations property

  • :security_schemes (Array<String>) —

    The value to assign to the #security_schemes property

  • :scope (String) —

    The value to assign to the #scope property

  • :roles (Array<String>) —

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



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
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 169

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

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

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

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

  self.database_object_type = attributes[:'databaseObjectType'] if attributes[:'databaseObjectType']

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

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

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

  self._alias = attributes[:'alias'] if attributes[:'alias']

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

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

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

  self.security_schemes = attributes[:'securitySchemes'] if attributes[:'securitySchemes']

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

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

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

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

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

Instance Attribute Details

#_alias ⇒ String

Used as the URI path element for this object. When not specified the objectName lowercase is the default value.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 67

def _alias
  @_alias
end

#database_object_name ⇒ String

The name of the database object.

Returns:

  • (String) 


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

def database_object_name
  @database_object_name
end

#database_object_type ⇒ String

The type of the database object.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 59

def database_object_type
  @database_object_type
end

#description ⇒ String

Description of the autoApiSpec.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 63

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and itu2019s changeable. Avoid entering confidential information.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#key ⇒ String

[Required] A system generated string that uniquely identifies an auto API spec sub resource within a given pool.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 43

def key
  @key
end

#operations ⇒ Array<String>

The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].

Returns:

  • (Array<String>) 


71
72
73
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 71

def operations
  @operations
end

#roles ⇒ Array<String>

The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.

Returns:

  • (Array<String>) 


83
84
85
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 83

def roles
  @roles
end

#scope ⇒ String

The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 79

def scope
  @scope
end

#security_schemes ⇒ Array<String>

The security schemes that can access this resource. If not specified then the resource is public.

Returns:

  • (Array<String>) 


75
76
77
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 75

def security_schemes
  @security_schemes
end

#time_created ⇒ DateTime

[Required] The time the resource was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


87
88
89
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 87

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the resource was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


91
92
93
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 91

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of the Database Tools database API gateway config auto API spec sub resource.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'type': :'type',
    'display_name': :'displayName',
    'database_object_name': :'databaseObjectName',
    'database_object_type': :'databaseObjectType',
    'description': :'description',
    '_alias': :'alias',
    'operations': :'operations',
    'security_schemes': :'securitySchemes',
    'scope': :'scope',
    'roles': :'roles',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



140
141
142
143
144
145
146
147
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 140

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDefault' if type == 'DEFAULT'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DatabaseToolsRuntime::Models::DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
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
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 115

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'type': :'String',
    'display_name': :'String',
    'database_object_name': :'String',
    'database_object_type': :'String',
    'description': :'String',
    '_alias': :'String',
    'operations': :'Array<String>',
    'security_schemes': :'Array<String>',
    'scope': :'String',
    'roles': :'Array<String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 303

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

  self.class == other.class &&
    key == other.key &&
    type == other.type &&
    display_name == other.display_name &&
    database_object_name == other.database_object_name &&
    database_object_type == other.database_object_type &&
    description == other.description &&
    _alias == other._alias &&
    operations == other.operations &&
    security_schemes == other.security_schemes &&
    scope == other.scope &&
    roles == other.roles &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



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

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


325
326
327
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 325

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



334
335
336
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 334

def hash
  [key, type, display_name, database_object_name, database_object_type, description, _alias, operations, security_schemes, scope, roles, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 378

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



372
373
374
 
# File 'lib/oci/database_tools_runtime/models/database_tools_database_api_gateway_config_pool_auto_api_spec.rb', line 372

def to_s
  to_hash.to_s
end