DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary¶

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

Bases: object

Description of a database API gateway config setting to be provided as an advanced property.

Attributes

`CONFIG_TYPES_GLOBAL`	A constant which can be used with the config_types property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`CONFIG_TYPES_POOL`	A constant which can be used with the config_types property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`DATABASE_TOOLS_CONNECTION_TYPES_MYSQL`	A constant which can be used with the database_tools_connection_types property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`DATABASE_TOOLS_CONNECTION_TYPES_ORACLE_DATABASE`	A constant which can be used with the database_tools_connection_types property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`DATA_TYPE_BOOLEAN`	A constant which can be used with the data_type property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`DATA_TYPE_DURATION`	A constant which can be used with the data_type property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`DATA_TYPE_NUMBER`	A constant which can be used with the data_type property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`DATA_TYPE_STRING`	A constant which can be used with the data_type property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`category_display_name`	Gets the category_display_name of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`category_key`	Gets the category_key of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`config_types`	Gets the config_types of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`data_type`	[Required] Gets the data_type of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`database_tools_connection_types`	Gets the database_tools_connection_types of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`default_value`	Gets the default_value of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`description`	Gets the description of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`display_name`	[Required] Gets the display_name of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`documentation_url`	Gets the documentation_url of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`hint_text`	Gets the hint_text of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`key`	[Required] Gets the key of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`list_of_values`	Gets the list_of_values of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`max_value`	Gets the max_value of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
`min_value`	Gets the min_value of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.

Methods

__init__(**kwargs) Initializes a new DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary object with values from keyword arguments.

CONFIG_TYPES_GLOBAL = 'GLOBAL'¶: A constant which can be used with the config_types property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. This constant has a value of “GLOBAL”

CONFIG_TYPES_POOL = 'POOL'¶: A constant which can be used with the config_types property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. This constant has a value of “POOL”

DATABASE_TOOLS_CONNECTION_TYPES_MYSQL = 'MYSQL'¶: A constant which can be used with the database_tools_connection_types property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. This constant has a value of “MYSQL”

DATABASE_TOOLS_CONNECTION_TYPES_ORACLE_DATABASE = 'ORACLE_DATABASE'¶: A constant which can be used with the database_tools_connection_types property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. This constant has a value of “ORACLE_DATABASE”

DATA_TYPE_BOOLEAN = 'BOOLEAN'¶: A constant which can be used with the data_type property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. This constant has a value of “BOOLEAN”

DATA_TYPE_DURATION = 'DURATION'¶: A constant which can be used with the data_type property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. This constant has a value of “DURATION”

DATA_TYPE_NUMBER = 'NUMBER'¶: A constant which can be used with the data_type property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. This constant has a value of “NUMBER”

DATA_TYPE_STRING = 'STRING'¶: A constant which can be used with the data_type property of a DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. This constant has a value of “STRING”

__init__(**kwargs)¶

Initializes a new DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary object with values from keyword arguments. 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 DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
display_name (str) – The value to assign to the display_name property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
data_type (str) – The value to assign to the data_type property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. Allowed values for this property are: “STRING”, “NUMBER”, “DURATION”, “BOOLEAN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
config_types (list[str]) – The value to assign to the config_types property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. Allowed values for items in this list are: “GLOBAL”, “POOL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
category_key (str) – The value to assign to the category_key property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
category_display_name (str) – The value to assign to the category_display_name property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
database_tools_connection_types (list[str]) – The value to assign to the database_tools_connection_types property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. Allowed values for items in this list are: “ORACLE_DATABASE”, “MYSQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
documentation_url (str) – The value to assign to the documentation_url property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
description (str) – The value to assign to the description property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
default_value (str) – The value to assign to the default_value property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
min_value (int) – The value to assign to the min_value property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
max_value (int) – The value to assign to the max_value property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
list_of_values (list[str]) – The value to assign to the list_of_values property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
hint_text (str) – The value to assign to the hint_text property of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.

category_display_name¶

Gets the category_display_name of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. A user-friendly name of a category.

Returns:	The category_display_name of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	str

category_key¶

Gets the category_key of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. The category of the Database Tools database API gateway config global setting.

Returns:	The category_key of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	str

config_types¶

Gets the config_types of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. The config types that support this advanced property. The supported types are GLOBAL and POOL.

Allowed values for items in this list are: “GLOBAL”, “POOL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The config_types of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	list[str]

data_type¶

[Required] Gets the data_type of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. The data type of a database API gateway config setting.

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

Returns:	The data_type of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	str

database_tools_connection_types¶

Gets the database_tools_connection_types of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. The type of database (as determined by a type of Database Tools connection) to which this setting applies. The advancedProperty applies to all types of Database Tools connection when null. This is only applicable when configTypes includes POOL.

Allowed values for items in this list are: “ORACLE_DATABASE”, “MYSQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The database_tools_connection_types of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	list[str]

default_value¶

Gets the default_value of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. The default value (if applicable) of a database API gateway config setting.

Returns:	The default_value of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	str

description¶

Gets the description of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. A user-friendly description of a database API gateway config setting.

Returns:	The description of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	str

display_name¶

[Required] Gets the display_name of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. A user-friendly name.

Returns:	The display_name of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	str

documentation_url¶

Gets the documentation_url of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. Uniform resource locator (URL) of documentation related to this setting.

Returns:	The documentation_url of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	str

hint_text¶

Gets the hint_text of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. Hint text for a database API gateway config setting.

Returns:	The hint_text of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	str

key¶

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

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

list_of_values¶

Gets the list_of_values of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. A list of string values (if applicable) supported by this database API gateway config setting.

Returns:	The list_of_values of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	list[str]

max_value¶

Gets the max_value of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. A maximum numeric value (if applicable) of a database API gateway config setting.

Returns:	The max_value of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	int

min_value¶

Gets the min_value of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary. A minimum numeric value (if applicable) of a database API gateway config setting.

Returns:	The min_value of this DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.
Return type:	int