DatabaseToolsDatabaseApiGatewayConfigGlobalDefault¶

class oci.database_tools_runtime.models.DatabaseToolsDatabaseApiGatewayConfigGlobalDefault(**kwargs)¶

Bases: oci.database_tools_runtime.models.database_tools_database_api_gateway_config_global.DatabaseToolsDatabaseApiGatewayConfigGlobal

The content of a Database Tools database API gateway config global resource.

Attributes

`DATABASE_API_STATUS_DISABLED`	str(object=’’) -> str
`DATABASE_API_STATUS_ENABLED`	str(object=’’) -> str
`METADATA_SOURCE_CLOUD`	str(object=’’) -> str
`METADATA_SOURCE_DATABASE`	str(object=’’) -> str
`POOL_ROUTE_HEADER`	str(object=’’) -> str
`POOL_ROUTE_PATH`	str(object=’’) -> str
`TYPE_DEFAULT`	str(object=’’) -> str
`advanced_properties`	Gets the advanced_properties of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`certificate_bundle`	Gets the certificate_bundle of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`database_api_status`	Gets the database_api_status of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`document_root`	Gets the document_root of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`http_port`	Gets the http_port of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`https_port`	Gets the https_port of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`key`	[Required] Gets the key of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`metadata_source`	Gets the metadata_source of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`pool_route`	Gets the pool_route of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`pool_routing_header`	Gets the pool_routing_header of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`time_created`	[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`time_updated`	[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
`type`	[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfigGlobal.

Methods

`__init__`(**kwargs)	Initializes a new DatabaseToolsDatabaseApiGatewayConfigGlobalDefault object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

DATABASE_API_STATUS_DISABLED = 'DISABLED'¶

DATABASE_API_STATUS_ENABLED = 'ENABLED'¶

METADATA_SOURCE_CLOUD = 'CLOUD'¶

METADATA_SOURCE_DATABASE = 'DATABASE'¶

POOL_ROUTE_HEADER = 'HEADER'¶

POOL_ROUTE_PATH = 'PATH'¶

TYPE_DEFAULT = 'DEFAULT'¶

__init__(**kwargs)¶

Initializes a new DatabaseToolsDatabaseApiGatewayConfigGlobalDefault object with values from keyword arguments. The default value of the type attribute of this class is DEFAULT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

key (str) – The value to assign to the key property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault.
type (str) – The value to assign to the type property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault. Allowed values for this property are: “DEFAULT”
pool_route (str) – The value to assign to the pool_route property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault. Allowed values for this property are: “PATH”, “HEADER”
pool_routing_header (str) – The value to assign to the pool_routing_header property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault.
database_api_status (str) – The value to assign to the database_api_status property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault. Allowed values for this property are: “ENABLED”, “DISABLED”
metadata_source (str) – The value to assign to the metadata_source property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault. Allowed values for this property are: “DATABASE”, “CLOUD”
http_port (int) – The value to assign to the http_port property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault.
https_port (int) – The value to assign to the https_port property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault.
certificate_bundle (oci.database_tools_runtime.models.DatabaseApiGatewayConfigCertificateBundle) – The value to assign to the certificate_bundle property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault.
document_root (str) – The value to assign to the document_root property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault.
advanced_properties (dict(str, str)) – The value to assign to the advanced_properties property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsDatabaseApiGatewayConfigGlobalDefault.

advanced_properties¶

Gets the advanced_properties of this DatabaseToolsDatabaseApiGatewayConfigGlobal. Advanced global properties.

Returns:	The advanced_properties of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	dict(str, str)

certificate_bundle¶

Gets the certificate_bundle of this DatabaseToolsDatabaseApiGatewayConfigGlobal.

Returns:	The certificate_bundle of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	oci.database_tools_runtime.models.DatabaseApiGatewayConfigCertificateBundle

database_api_status¶

Gets the database_api_status of this DatabaseToolsDatabaseApiGatewayConfigGlobal. ORDS database API is a database management and monitoring REST API. Database Actions requires this feature.

Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The database_api_status of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	str

document_root¶

Gets the document_root of this DatabaseToolsDatabaseApiGatewayConfigGlobal. The location of the static resources to be served under the / root server path.

Returns:	The document_root of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

http_port¶

Gets the http_port of this DatabaseToolsDatabaseApiGatewayConfigGlobal. 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 (1024–65535) is recommended.

Returns:	The http_port of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	int

https_port¶

Gets the https_port of this DatabaseToolsDatabaseApiGatewayConfigGlobal. 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 (1024–65535) is recommended. ORDS will use a self-signed certificate if a certificate bundle is not provided.

Returns:	The https_port of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	int

key¶

[Required] Gets the key of this DatabaseToolsDatabaseApiGatewayConfigGlobal. A string that uniquely identifies a Database Tools database API gateway config global settings resource.

Returns:	The key of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	str

metadata_source¶

Gets the metadata_source of this DatabaseToolsDatabaseApiGatewayConfigGlobal. The RESTful service definition location.

Allowed values for this property are: “DATABASE”, “CLOUD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The metadata_source of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	str

pool_route¶

Gets the pool_route of this DatabaseToolsDatabaseApiGatewayConfigGlobal. How the target pool route value is determined for a HTTP request.

Allowed values for this property are: “PATH”, “HEADER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The pool_route of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	str

pool_routing_header¶

Gets the pool_routing_header of this DatabaseToolsDatabaseApiGatewayConfigGlobal. The request header name providing the pool route value.

Returns:	The pool_routing_header of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	str

time_created¶

[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfigGlobal. The time the resource was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfigGlobal. The time the resource was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	datetime

type¶

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

Allowed values for this property are: “DEFAULT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Return type:	str