DatabaseToolsDatabaseApiGatewayConfigPoolDefault¶
- class oci.database_tools_runtime.models.DatabaseToolsDatabaseApiGatewayConfigPoolDefault(**kwargs)¶
Bases:
DatabaseToolsDatabaseApiGatewayConfigPoolThe content of a Database Tools database API gateway config pool sub resource.
Attributes:
A constant which can be used with the database_actions_status property of a DatabaseToolsDatabaseApiGatewayConfigPool.
A constant which can be used with the database_actions_status property of a DatabaseToolsDatabaseApiGatewayConfigPool.
A constant which can be used with the rest_enabled_sql_status property of a DatabaseToolsDatabaseApiGatewayConfigPool.
A constant which can be used with the rest_enabled_sql_status property of a DatabaseToolsDatabaseApiGatewayConfigPool.
A constant which can be used with the type property of a DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the advanced_properties of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the database_actions_status of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the database_tools_connection_id of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the display_name of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the initial_pool_size of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the jwt_profile_audience of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the jwt_profile_issuer of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the jwt_profile_jwk_url of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the jwt_profile_role_claim_name of this DatabaseToolsDatabaseApiGatewayConfigPool.
[Required] Gets the key of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the max_pool_size of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the min_pool_size of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the pool_route_value of this DatabaseToolsDatabaseApiGatewayConfigPool.
Gets the rest_enabled_sql_status of this DatabaseToolsDatabaseApiGatewayConfigPool.
[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfigPool.
[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfigPool.
[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfigPool.
Methods:
__init__(**kwargs)Initializes a new DatabaseToolsDatabaseApiGatewayConfigPoolDefault 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_ACTIONS_STATUS_DISABLED = 'DISABLED'¶
A constant which can be used with the database_actions_status property of a DatabaseToolsDatabaseApiGatewayConfigPool. This constant has a value of “DISABLED”
- DATABASE_ACTIONS_STATUS_ENABLED = 'ENABLED'¶
A constant which can be used with the database_actions_status property of a DatabaseToolsDatabaseApiGatewayConfigPool. This constant has a value of “ENABLED”
- REST_ENABLED_SQL_STATUS_DISABLED = 'DISABLED'¶
A constant which can be used with the rest_enabled_sql_status property of a DatabaseToolsDatabaseApiGatewayConfigPool. This constant has a value of “DISABLED”
- REST_ENABLED_SQL_STATUS_ENABLED = 'ENABLED'¶
A constant which can be used with the rest_enabled_sql_status property of a DatabaseToolsDatabaseApiGatewayConfigPool. This constant has a value of “ENABLED”
- TYPE_DEFAULT = 'DEFAULT'¶
A constant which can be used with the type property of a DatabaseToolsDatabaseApiGatewayConfigPool. This constant has a value of “DEFAULT”
- __init__(**kwargs)¶
Initializes a new DatabaseToolsDatabaseApiGatewayConfigPoolDefault object with values from keyword arguments. The default value of the
typeattribute of this class isDEFAULTand 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 DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
type (str) – The value to assign to the type property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault. Allowed values for this property are: “DEFAULT”
display_name (str) – The value to assign to the display_name property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
pool_route_value (str) – The value to assign to the pool_route_value property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
database_tools_connection_id (str) – The value to assign to the database_tools_connection_id property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
max_pool_size (int) – The value to assign to the max_pool_size property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
min_pool_size (int) – The value to assign to the min_pool_size property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
initial_pool_size (int) – The value to assign to the initial_pool_size property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
jwt_profile_jwk_url (str) – The value to assign to the jwt_profile_jwk_url property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
jwt_profile_issuer (str) – The value to assign to the jwt_profile_issuer property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
jwt_profile_audience (str) – The value to assign to the jwt_profile_audience property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
jwt_profile_role_claim_name (str) – The value to assign to the jwt_profile_role_claim_name property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
database_actions_status (str) – The value to assign to the database_actions_status property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault. Allowed values for this property are: “ENABLED”, “DISABLED”
rest_enabled_sql_status (str) – The value to assign to the rest_enabled_sql_status property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault. Allowed values for this property are: “ENABLED”, “DISABLED”
advanced_properties (dict(str, str)) – The value to assign to the advanced_properties property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsDatabaseApiGatewayConfigPoolDefault.
- property advanced_properties¶
Gets the advanced_properties of this DatabaseToolsDatabaseApiGatewayConfigPool. Advanced pool properties.
- Returns
The advanced_properties of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
dict(str, str)
- property database_actions_status¶
Gets the database_actions_status of this DatabaseToolsDatabaseApiGatewayConfigPool. Specifies to enable the Database Actions 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_actions_status of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str
- property database_tools_connection_id¶
Gets the database_tools_connection_id of this DatabaseToolsDatabaseApiGatewayConfigPool. The OCID of the related Database Tools connection. Specifies the OCI database tools connection ocid to build the connection pool from.
- Returns
The database_tools_connection_id of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str
- property display_name¶
Gets the display_name of this DatabaseToolsDatabaseApiGatewayConfigPool. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this DatabaseToolsDatabaseApiGatewayConfigPool.
- 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 initial_pool_size¶
Gets the initial_pool_size of this DatabaseToolsDatabaseApiGatewayConfigPool. Specifies the initial size for the number of database connections that will be created for the pool.
- Returns
The initial_pool_size of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
int
- property jwt_profile_audience¶
Gets the jwt_profile_audience of this DatabaseToolsDatabaseApiGatewayConfigPool. Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
- Returns
The jwt_profile_audience of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str
- property jwt_profile_issuer¶
Gets the jwt_profile_issuer of this DatabaseToolsDatabaseApiGatewayConfigPool. Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
- Returns
The jwt_profile_issuer of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str
- property jwt_profile_jwk_url¶
Gets the jwt_profile_jwk_url of this DatabaseToolsDatabaseApiGatewayConfigPool. Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
- Returns
The jwt_profile_jwk_url of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str
- property jwt_profile_role_claim_name¶
Gets the jwt_profile_role_claim_name of this DatabaseToolsDatabaseApiGatewayConfigPool. Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
- Returns
The jwt_profile_role_claim_name of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str
- property key¶
[Required] Gets the key of this DatabaseToolsDatabaseApiGatewayConfigPool. A system generated string that uniquely identifies a pool sub resource.
- Returns
The key of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str
- property max_pool_size¶
Gets the max_pool_size of this DatabaseToolsDatabaseApiGatewayConfigPool. Specifies the maximum number of database connections allowed for the pool.
- Returns
The max_pool_size of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
int
- property min_pool_size¶
Gets the min_pool_size of this DatabaseToolsDatabaseApiGatewayConfigPool. Specifies the minimum number of database connections allowed for the pool.
- Returns
The min_pool_size of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
int
- property pool_route_value¶
Gets the pool_route_value of this DatabaseToolsDatabaseApiGatewayConfigPool. The pool route value provided in requests to target this pool.
- Returns
The pool_route_value of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str
- property rest_enabled_sql_status¶
Gets the rest_enabled_sql_status of this DatabaseToolsDatabaseApiGatewayConfigPool. Specifies whether the REST-Enabled SQL service is active.
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 rest_enabled_sql_status of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this DatabaseToolsDatabaseApiGatewayConfigPool. The time the resource was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this DatabaseToolsDatabaseApiGatewayConfigPool. The time the resource was updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
datetime
- property type¶
[Required] Gets the type of this DatabaseToolsDatabaseApiGatewayConfigPool. The type of the Database Tools database API gateway config pool sub 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 DatabaseToolsDatabaseApiGatewayConfigPool.
- Return type
str