DatabaseToolsClient¶

class oci.database_tools.DatabaseToolsClient(config, **kwargs)¶

Use the Database Tools API to manage connections, private endpoints, and work requests in the Database Tools service.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`add_database_tools_connection_lock`(…)	Adds a lock to a DatabaseToolsConnection resource.
`add_database_tools_private_endpoint_lock`(…)	Adds a lock to a DatabaseToolsPrivateEndpoint resource.
`change_database_tools_connection_compartment`(…)	Moves the specified Database Tools connection to a different compartment in the same tenancy.
`change_database_tools_private_endpoint_compartment`(…)	Moves a Database Tools private endpoint into a different compartment in the same tenancy.
`create_database_tools_connection`(…)	Creates a new Database Tools connection.
`create_database_tools_private_endpoint`(…)	Creates a new Database Tools private endpoint.
`delete_database_tools_connection`(…)	Deletes the specified Database Tools connection resource.
`delete_database_tools_private_endpoint`(…)	Deletes the specified Database Tools private endpoint.
`get_database_tools_connection`(…)	Gets details of the specified Database Tools connection.
`get_database_tools_endpoint_service`(…)	Gets details for the specified Database Tools endpoint service.
`get_database_tools_private_endpoint`(…)	Gets details of a specified Database Tools private endpoint.
`get_work_request`(work_request_id, **kwargs)	Gets the status of the specified work request.
`list_database_tools_connections`(…)	Returns a list of Database Tools connections.
`list_database_tools_endpoint_services`(…)	Returns a list of Database Tools endpoint services.
`list_database_tools_private_endpoints`(…)	Returns a list of Database Tools private endpoints.
`list_work_request_errors`(work_request_id, …)	Returns a paginated list of errors for the specified work request.
`list_work_request_logs`(work_request_id, **kwargs)	Returns a paginated list of logs for the specified work request.
`list_work_requests`(compartment_id, **kwargs)	Lists the work requests in a compartment.
`remove_database_tools_connection_lock`(…)	Removes a lock from a DatabaseToolsConnection resource.
`remove_database_tools_private_endpoint_lock`(…)	Removes a lock from a DatabaseToolsPrivateEndpoint resource.
`update_database_tools_connection`(…)	Updates the specified Database Tools connection.
`update_database_tools_private_endpoint`(…)	Updates the specified Database Tools private endpoint.
`validate_database_tools_connection`(…)	Validates the Database Tools connection details by establishing a connection to the database.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

add_database_tools_connection_lock(database_tools_connection_id, add_resource_lock_details, **kwargs)¶

Adds a lock to a DatabaseToolsConnection resource.

Parameters:	database_tools_connection_id (str) – (required) The OCID of a Database Tools connection. add_resource_lock_details (oci.database_tools.models.AddResourceLockDetails) – (required) AddResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsConnection`
Return type:	`Response`
Example:

Click here to see an example of how to use add_database_tools_connection_lock API.

add_database_tools_private_endpoint_lock(database_tools_private_endpoint_id, add_resource_lock_details, **kwargs)¶

Adds a lock to a DatabaseToolsPrivateEndpoint resource.

Parameters:	database_tools_private_endpoint_id (str) – (required) The OCID of a Database Tools private endpoint. add_resource_lock_details (oci.database_tools.models.AddResourceLockDetails) – (required) AddResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsPrivateEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use add_database_tools_private_endpoint_lock API.

change_database_tools_connection_compartment(database_tools_connection_id, change_database_tools_connection_compartment_details, **kwargs)¶

Moves the specified Database Tools connection to a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:	database_tools_connection_id (str) – (required) The OCID of a Database Tools connection. change_database_tools_connection_compartment_details (oci.database_tools.models.ChangeDatabaseToolsConnectionCompartmentDetails) – (required) Request to change the compartment of the DatabaseToolsConnection. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_database_tools_connection_compartment API.

change_database_tools_private_endpoint_compartment(database_tools_private_endpoint_id, change_database_tools_private_endpoint_compartment_details, **kwargs)¶

Moves a Database Tools private endpoint into a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:	database_tools_private_endpoint_id (str) – (required) The OCID of a Database Tools private endpoint. change_database_tools_private_endpoint_compartment_details (oci.database_tools.models.ChangeDatabaseToolsPrivateEndpointCompartmentDetails) – (required) Request to change the compartment of the DatabaseToolsPrivateEndpoint. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_database_tools_private_endpoint_compartment API.

create_database_tools_connection(create_database_tools_connection_details, **kwargs)¶

Creates a new Database Tools connection.

Parameters:	create_database_tools_connection_details (oci.database_tools.models.CreateDatabaseToolsConnectionDetails) – (required) Details for the new DatabaseToolsConnection. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE “_”) and dash (U+002D HYPHEN-MINUS “-“) opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsConnection`
Return type:	`Response`
Example:

Click here to see an example of how to use create_database_tools_connection API.

create_database_tools_private_endpoint(create_database_tools_private_endpoint_details, **kwargs)¶

Creates a new Database Tools private endpoint.

Parameters:	create_database_tools_private_endpoint_details (oci.database_tools.models.CreateDatabaseToolsPrivateEndpointDetails) – (required) Details for the new DatabaseToolsPrivateEndpoint. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE “_”) and dash (U+002D HYPHEN-MINUS “-“) opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsPrivateEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use create_database_tools_private_endpoint API.

delete_database_tools_connection(database_tools_connection_id, **kwargs)¶

Deletes the specified Database Tools connection resource.

Parameters:	database_tools_connection_id (str) – (required) The OCID of a Database Tools connection. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_database_tools_connection API.

delete_database_tools_private_endpoint(database_tools_private_endpoint_id, **kwargs)¶

Deletes the specified Database Tools private endpoint.

Parameters:	database_tools_private_endpoint_id (str) – (required) The OCID of a Database Tools private endpoint. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_database_tools_private_endpoint API.

get_database_tools_connection(database_tools_connection_id, **kwargs)¶

Gets details of the specified Database Tools connection.

Parameters:	database_tools_connection_id (str) – (required) The OCID of a Database Tools connection. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsConnection`
Return type:	`Response`
Example:

Click here to see an example of how to use get_database_tools_connection API.

get_database_tools_endpoint_service(database_tools_endpoint_service_id, **kwargs)¶

Gets details for the specified Database Tools endpoint service.

Parameters:	database_tools_endpoint_service_id (str) – (required) The OCID of a Database Tools Endpoint Service. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsEndpointService`
Return type:	`Response`
Example:

Click here to see an example of how to use get_database_tools_endpoint_service API.

get_database_tools_private_endpoint(database_tools_private_endpoint_id, **kwargs)¶

Gets details of a specified Database Tools private endpoint.

Parameters:	database_tools_private_endpoint_id (str) – (required) The OCID of a Database Tools private endpoint. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsPrivateEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use get_database_tools_private_endpoint API.

get_work_request(work_request_id, **kwargs)¶

Gets the status of the specified work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_work_request API.

list_database_tools_connections(compartment_id, **kwargs)¶

Returns a list of Database Tools connections.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the specified lifecycleState. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE” display_name (str) – (optional) A filter to return only resources that match the entire specified display name. type (list[str]) – (optional) A filter to return only resources their type matches the specified type. Allowed values are: “ORACLE_DATABASE”, “MYSQL”, “POSTGRESQL”, “GENERIC_JDBC” runtime_support (list[str]) – (optional) A filter to return only resources with one of the specified runtimeSupport values. Allowed values are: “SUPPORTED”, “UNSUPPORTED” related_resource_identifier (str) – (optional) A filter to return only resources associated to the related resource identifier OCID passed in the query string. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsConnectionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_database_tools_connections API.

list_database_tools_endpoint_services(compartment_id, **kwargs)¶

Returns a list of Database Tools endpoint services.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the specified lifecycleState. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE” display_name (str) – (optional) A filter to return only resources that match the entire specified display name. name (str) – (optional) A filter to return only resources that match the entire specified name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsEndpointServiceCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_database_tools_endpoint_services API.

list_database_tools_private_endpoints(compartment_id, **kwargs)¶

Returns a list of Database Tools private endpoints.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. subnet_id (str) – (optional) A filter to return only resources their subnetId matches the specified subnetId. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. endpoint_service_id (str) – (optional) A filter to return only resources their endpointServiceId matches the specified endpointServiceId. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the specified lifecycleState. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE” display_name (str) – (optional) A filter to return only resources that match the entire specified display name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsPrivateEndpointCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_database_tools_private_endpoints API.

list_work_request_errors(work_request_id, **kwargs)¶

Returns a paginated list of errors for the specified work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestErrorCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)¶

Returns a paginated list of logs for the specified work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: “timeCreated”, “displayName” page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestLogEntryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. resource_identifier (str) – (optional) The OCID of the resource. opc_request_id (str) – (optional) The client request ID for tracing. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default. Allowed values are: “timeAccepted” page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_requests API.

remove_database_tools_connection_lock(database_tools_connection_id, remove_resource_lock_details, **kwargs)¶

Removes a lock from a DatabaseToolsConnection resource.

Parameters:	database_tools_connection_id (str) – (required) The OCID of a Database Tools connection. remove_resource_lock_details (oci.database_tools.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsConnection`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_database_tools_connection_lock API.

remove_database_tools_private_endpoint_lock(database_tools_private_endpoint_id, remove_resource_lock_details, **kwargs)¶

Removes a lock from a DatabaseToolsPrivateEndpoint resource.

Parameters:	database_tools_private_endpoint_id (str) – (required) The OCID of a Database Tools private endpoint. remove_resource_lock_details (oci.database_tools.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseToolsPrivateEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_database_tools_private_endpoint_lock API.

update_database_tools_connection(database_tools_connection_id, update_database_tools_connection_details, **kwargs)¶

Updates the specified Database Tools connection.

Parameters:	database_tools_connection_id (str) – (required) The OCID of a Database Tools connection. update_database_tools_connection_details (oci.database_tools.models.UpdateDatabaseToolsConnectionDetails) – (required) The information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_database_tools_connection API.

update_database_tools_private_endpoint(database_tools_private_endpoint_id, update_database_tools_private_endpoint_details, **kwargs)¶

Updates the specified Database Tools private endpoint.

Parameters:	database_tools_private_endpoint_id (str) – (required) The OCID of a Database Tools private endpoint. update_database_tools_private_endpoint_details (oci.database_tools.models.UpdateDatabaseToolsPrivateEndpointDetails) – (required) The information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_database_tools_private_endpoint API.

validate_database_tools_connection(database_tools_connection_id, validate_database_tools_connection_details, **kwargs)¶

Validates the Database Tools connection details by establishing a connection to the database.

Parameters:	database_tools_connection_id (str) – (required) The OCID of a Database Tools connection. validate_database_tools_connection_details (oci.database_tools.models.ValidateDatabaseToolsConnectionDetails) – (required) Request to validate a DatabaseToolsConnection. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ValidateDatabaseToolsConnectionResult`
Return type:	`Response`
Example:

Click here to see an example of how to use validate_database_tools_connection API.