Class: OCI::DatabaseToolsRuntime::Models::UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails

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

Overview

The content of the Database Tools database API gateway config global 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
POOL_ROUTE_ENUM = 
[
  POOL_ROUTE_PATH = 'PATH'.freeze,
  POOL_ROUTE_HEADER = 'HEADER'.freeze
].freeze
DATABASE_API_STATUS_ENUM = 
[
  DATABASE_API_STATUS_ENABLED = 'ENABLED'.freeze,
  DATABASE_API_STATUS_DISABLED = 'DISABLED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 125

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

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

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

  self.pool_routing_header = attributes[:'poolRoutingHeader'] if attributes[:'poolRoutingHeader']

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

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

  self.database_api_status = attributes[:'databaseApiStatus'] if attributes[:'databaseApiStatus']

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

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

  self.http_port = attributes[:'httpPort'] if attributes[:'httpPort']

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

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

  self.https_port = attributes[:'httpsPort'] if attributes[:'httpsPort']

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

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

  self.certificate_bundle = attributes[:'certificateBundle'] if attributes[:'certificateBundle']

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

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

  self.document_root = attributes[:'documentRoot'] if attributes[:'documentRoot']

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

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

  self.advanced_properties = attributes[:'advancedProperties'] if attributes[:'advancedProperties']

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

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

Instance Attribute Details

#advanced_properties ⇒ Hash<String, String>

Advanced global properties.

Returns:

  • (Hash<String, String>) 


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

def advanced_properties
  @advanced_properties
end

#certificate_bundle ⇒ OCI::DatabaseToolsRuntime::Models::DatabaseApiGatewayConfigCertificateBundle

Returns:



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

def certificate_bundle
  @certificate_bundle
end

#database_api_status ⇒ String

ORDS database API is a database management and monitoring REST API. Database Actions requires this feature.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 40

def database_api_status
  @database_api_status
end

#document_root ⇒ String

The location of the static resources to be served under the / root server path.

Returns:

  • (String) 


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

def document_root
  @document_root
end

#http_port ⇒ Integer

Specifies the HTTP listen port. 0 disables HTTP. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024u201365535) is recommended.

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 44

def http_port
  @http_port
end

#https_port ⇒ Integer

Specifies the HTTPS listen port. 0 disables HTTPS. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024u201365535) is recommended. ORDS will use a self-signed certificate if a certificate bundle is not provided.

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 48

def https_port
  @https_port
end

#pool_route ⇒ String

How the target pool route value is determined for a HTTP request.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 32

def pool_route
  @pool_route
end

#pool_routing_header ⇒ String

The request header name providing the pool route value.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 36

def pool_routing_header
  @pool_routing_header
end

#type ⇒ String

[Required] The type of the Database Tools database API gateway config global settings resource.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 28

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'pool_route': :'poolRoute',
    'pool_routing_header': :'poolRoutingHeader',
    'database_api_status': :'databaseApiStatus',
    'http_port': :'httpPort',
    'https_port': :'httpsPort',
    'certificate_bundle': :'certificateBundle',
    'document_root': :'documentRoot',
    'advanced_properties': :'advancedProperties'
    # 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.



100
101
102
103
104
105
106
107
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 100

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

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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'pool_route': :'String',
    'pool_routing_header': :'String',
    'database_api_status': :'String',
    'http_port': :'Integer',
    'https_port': :'Integer',
    'certificate_bundle': :'OCI::DatabaseToolsRuntime::Models::DatabaseApiGatewayConfigCertificateBundle',
    'document_root': :'String',
    'advanced_properties': :'Hash<String, 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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 213

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

  self.class == other.class &&
    type == other.type &&
    pool_route == other.pool_route &&
    pool_routing_header == other.pool_routing_header &&
    database_api_status == other.database_api_status &&
    http_port == other.http_port &&
    https_port == other.https_port &&
    certificate_bundle == other.certificate_bundle &&
    document_root == other.document_root &&
    advanced_properties == other.advanced_properties
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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 251

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


231
232
233
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 231

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



240
241
242
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 240

def hash
  [type, pool_route, pool_routing_header, database_api_status, http_port, https_port, certificate_bundle, document_root, advanced_properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



284
285
286
287
288
289
290
291
292
293
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 284

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



278
279
280
 
# File 'lib/oci/database_tools_runtime/models/update_database_tools_database_api_gateway_config_global_details.rb', line 278

def to_s
  to_hash.to_s
end