UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDefaultDetails¶

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

Bases: oci.database_tools_runtime.models.update_database_tools_database_api_gateway_config_global_details.UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails

The content of the Database Tools database API gateway config global sub resource to be updated.

Attributes

`DATABASE_API_STATUS_DISABLED`	str(object=’’) -> str
`DATABASE_API_STATUS_ENABLED`	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 UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
`certificate_bundle`	Gets the certificate_bundle of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
`database_api_status`	Gets the database_api_status of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
`document_root`	Gets the document_root of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
`http_port`	Gets the http_port of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
`https_port`	Gets the https_port of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
`pool_route`	Gets the pool_route of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
`pool_routing_header`	Gets the pool_routing_header of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
`type`	[Required] Gets the type of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.

Methods

`__init__`(**kwargs)	Initializes a new UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDefaultDetails 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'¶

POOL_ROUTE_HEADER = 'HEADER'¶

POOL_ROUTE_PATH = 'PATH'¶

TYPE_DEFAULT = 'DEFAULT'¶

__init__(**kwargs)¶

Initializes a new UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDefaultDetails 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:

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

advanced_properties¶

Gets the advanced_properties of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails. Advanced global properties.

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

certificate_bundle¶

Gets the certificate_bundle of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.

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

database_api_status¶

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

Allowed values for this property are: “ENABLED”, “DISABLED”

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

document_root¶

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

Returns:	The document_root of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
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 UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
Return type:	int

https_port¶

Gets the https_port of this UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails.
Return type:	int

pool_route¶

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

Allowed values for this property are: “PATH”, “HEADER”

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

pool_routing_header¶

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

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

type¶

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

Allowed values for this property are: “DEFAULT”

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