DatabaseToolsDatabaseApiGatewayConfigGlobal¶
- class oci.database_tools_runtime.models.DatabaseToolsDatabaseApiGatewayConfigGlobal(**kwargs)¶
Bases:
objectThe content of a Database Tools database API gateway config global resource.
Attributes:
A constant which can be used with the database_api_status property of a DatabaseToolsDatabaseApiGatewayConfigGlobal.
A constant which can be used with the database_api_status property of a DatabaseToolsDatabaseApiGatewayConfigGlobal.
A constant which can be used with the metadata_source property of a DatabaseToolsDatabaseApiGatewayConfigGlobal.
A constant which can be used with the metadata_source property of a DatabaseToolsDatabaseApiGatewayConfigGlobal.
A constant which can be used with the pool_route property of a DatabaseToolsDatabaseApiGatewayConfigGlobal.
A constant which can be used with the pool_route property of a DatabaseToolsDatabaseApiGatewayConfigGlobal.
A constant which can be used with the type property of a DatabaseToolsDatabaseApiGatewayConfigGlobal.
Gets the advanced_properties of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Gets the certificate_bundle of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Gets the database_api_status of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Gets the document_root of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Gets the http_port of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Gets the https_port of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
[Required] Gets the key of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Gets the metadata_source of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Gets the pool_route of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Gets the pool_routing_header of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
Methods:
__init__(**kwargs)Initializes a new DatabaseToolsDatabaseApiGatewayConfigGlobal 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'¶
A constant which can be used with the database_api_status property of a DatabaseToolsDatabaseApiGatewayConfigGlobal. This constant has a value of “DISABLED”
- DATABASE_API_STATUS_ENABLED = 'ENABLED'¶
A constant which can be used with the database_api_status property of a DatabaseToolsDatabaseApiGatewayConfigGlobal. This constant has a value of “ENABLED”
- METADATA_SOURCE_CLOUD = 'CLOUD'¶
A constant which can be used with the metadata_source property of a DatabaseToolsDatabaseApiGatewayConfigGlobal. This constant has a value of “CLOUD”
- METADATA_SOURCE_DATABASE = 'DATABASE'¶
A constant which can be used with the metadata_source property of a DatabaseToolsDatabaseApiGatewayConfigGlobal. This constant has a value of “DATABASE”
- POOL_ROUTE_HEADER = 'HEADER'¶
A constant which can be used with the pool_route property of a DatabaseToolsDatabaseApiGatewayConfigGlobal. This constant has a value of “HEADER”
- POOL_ROUTE_PATH = 'PATH'¶
A constant which can be used with the pool_route property of a DatabaseToolsDatabaseApiGatewayConfigGlobal. This constant has a value of “PATH”
- TYPE_DEFAULT = 'DEFAULT'¶
A constant which can be used with the type property of a DatabaseToolsDatabaseApiGatewayConfigGlobal. This constant has a value of “DEFAULT”
- __init__(**kwargs)¶
Initializes a new DatabaseToolsDatabaseApiGatewayConfigGlobal object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
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 DatabaseToolsDatabaseApiGatewayConfigGlobal.
type (str) – The value to assign to the type property of this DatabaseToolsDatabaseApiGatewayConfigGlobal. Allowed values for this property are: “DEFAULT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
pool_route (str) – The value to assign to the pool_route property of this DatabaseToolsDatabaseApiGatewayConfigGlobal. 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’.
pool_routing_header (str) – The value to assign to the pool_routing_header property of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
database_api_status (str) – The value to assign to the database_api_status property of this DatabaseToolsDatabaseApiGatewayConfigGlobal. 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’.
metadata_source (str) – The value to assign to the metadata_source property of this DatabaseToolsDatabaseApiGatewayConfigGlobal. 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’.
http_port (int) – The value to assign to the http_port property of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
https_port (int) – The value to assign to the https_port property of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
certificate_bundle (oci.database_tools_runtime.models.DatabaseApiGatewayConfigCertificateBundle) – The value to assign to the certificate_bundle property of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
document_root (str) – The value to assign to the document_root property of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
advanced_properties (dict(str, str)) – The value to assign to the advanced_properties property of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
- property advanced_properties¶
Gets the advanced_properties of this DatabaseToolsDatabaseApiGatewayConfigGlobal. Advanced global properties.
- Returns
The advanced_properties of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
- Return type
dict(str, str)
- property certificate_bundle¶
Gets the certificate_bundle of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
- Returns
The certificate_bundle of this DatabaseToolsDatabaseApiGatewayConfigGlobal.
- Return type
oci.database_tools_runtime.models.DatabaseApiGatewayConfigCertificateBundle
- property 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
- property 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.
- property 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
- property 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
- property 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
- property 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
- property 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
- property 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
- property 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
- property 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
- property 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