UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails¶
- class oci.database_tools_runtime.models.UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails(**kwargs)¶
Bases:
objectThe content of a Database Tools database API gateway config pool sub resource to be updated.
Attributes:
A constant which can be used with the database_actions_status property of a UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
A constant which can be used with the database_actions_status property of a UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
A constant which can be used with the rest_enabled_sql_status property of a UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
A constant which can be used with the rest_enabled_sql_status property of a UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
A constant which can be used with the type property of a UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the advanced_properties of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the database_actions_status of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the database_tools_connection_id of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the display_name of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the initial_pool_size of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the jwt_profile_audience of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the jwt_profile_issuer of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the jwt_profile_jwk_url of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the jwt_profile_role_claim_name of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the max_pool_size of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the min_pool_size of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the pool_route_value of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Gets the rest_enabled_sql_status of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
[Required] Gets the type of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
Methods:
__init__(**kwargs)Initializes a new UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. This constant has a value of “ENABLED”
- TYPE_DEFAULT = 'DEFAULT'¶
A constant which can be used with the type property of a UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. This constant has a value of “DEFAULT”
- __init__(**kwargs)¶
Initializes a new UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails 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
type (str) – The value to assign to the type property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Allowed values for this property are: “DEFAULT”
display_name (str) – The value to assign to the display_name property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
pool_route_value (str) – The value to assign to the pool_route_value property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
database_tools_connection_id (str) – The value to assign to the database_tools_connection_id property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
max_pool_size (int) – The value to assign to the max_pool_size property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
min_pool_size (int) – The value to assign to the min_pool_size property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
initial_pool_size (int) – The value to assign to the initial_pool_size property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
jwt_profile_jwk_url (str) – The value to assign to the jwt_profile_jwk_url property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
jwt_profile_issuer (str) – The value to assign to the jwt_profile_issuer property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
jwt_profile_audience (str) – The value to assign to the jwt_profile_audience property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
jwt_profile_role_claim_name (str) – The value to assign to the jwt_profile_role_claim_name property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
database_actions_status (str) – The value to assign to the database_actions_status property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Allowed values for this property are: “ENABLED”, “DISABLED”
advanced_properties (dict(str, str)) – The value to assign to the advanced_properties property of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- property advanced_properties¶
Gets the advanced_properties of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Advanced pool properties.
- Returns
The advanced_properties of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
dict(str, str)
- property database_actions_status¶
Gets the database_actions_status of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies to enable the Database Actions feature.
Allowed values for this property are: “ENABLED”, “DISABLED”
- Returns
The database_actions_status of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
str
- property database_tools_connection_id¶
Gets the database_tools_connection_id of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
str
- property display_name¶
Gets the display_name of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the initial size for the number of database connections that will be created for the pool.
- Returns
The initial_pool_size of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
int
- property jwt_profile_audience¶
Gets the jwt_profile_audience of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
str
- property jwt_profile_issuer¶
Gets the jwt_profile_issuer of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
str
- property jwt_profile_jwk_url¶
Gets the jwt_profile_jwk_url of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
str
- property jwt_profile_role_claim_name¶
Gets the jwt_profile_role_claim_name of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. 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 UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
str
- property max_pool_size¶
Gets the max_pool_size of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the maximum number of database connections allowed for the pool.
- Returns
The max_pool_size of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
int
- property min_pool_size¶
Gets the min_pool_size of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies the minimum number of database connections allowed for the pool.
- Returns
The min_pool_size of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
int
- property pool_route_value¶
Gets the pool_route_value of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. The pool route value provided in requests to target this pool.
- Returns
The pool_route_value of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
str
- property rest_enabled_sql_status¶
Gets the rest_enabled_sql_status of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. Specifies whether the REST-Enabled SQL service is active.
Allowed values for this property are: “ENABLED”, “DISABLED”
- Returns
The rest_enabled_sql_status of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
str
- property type¶
[Required] Gets the type of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails. The type of the Database Tools database API gateway config pool sub resource.
Allowed values for this property are: “DEFAULT”
- Returns
The type of this UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails.
- Return type
str