Class: OCI::DatabaseToolsRuntime::Models::UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails

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

Overview

The content of a Database Tools database API gateway config auto API spec sub resource to be updated. 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
].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
].freeze
OPERATIONS_ENUM = 
[
  OPERATIONS_READ = 'READ'.freeze,
  OPERATIONS_WRITE = 'WRITE'.freeze
].freeze
SECURITY_SCHEMES_ENUM = 
[
  SECURITY_SCHEMES_BASIC = 'BASIC'.freeze,
  SECURITY_SCHEMES_BEARER = 'BEARER'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

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



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 143

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.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']
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) 


58
59
60
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 58

def _alias
  @_alias
end

#database_object_name ⇒ String

The name of the database object.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 46

def database_object_name
  @database_object_name
end

#database_object_type ⇒ String

The type of the database object.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 50

def database_object_type
  @database_object_type
end

#description ⇒ String

Description of the autoApiSpec.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 54

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#operations ⇒ Array<String>

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

Returns:

  • (Array<String>) 


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

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


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

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) 


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

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


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

def security_schemes
  @security_schemes
end

#type ⇒ String

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

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    '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'
    # 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.



117
118
119
120
121
122
123
124
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 117

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

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

  # TODO: Log a warning when the subtype is not found.
  'OCI::DatabaseToolsRuntime::Models::UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    '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>'
    # 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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 243

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

  self.class == other.class &&
    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
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 282

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


262
263
264
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 262

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



271
272
273
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 271

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 315

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



309
310
311
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_pool_auto_api_spec_details.rb', line 309

def to_s
  to_hash.to_s
end