Metadata-Version: 2.4
Name: ionoscloud_dbaas_inmemorydb
Version: 1.0.0
Summary: IONOS CLOUD DBaaS In-Memory DB
License: NoLicense
License-File: LICENSE
Keywords: OpenAPI,OpenAPI-Generator,IONOS CLOUD DBaaS In-Memory DB
Author: OpenAPI Generator Community
Author-email: team@openapitools.org
Requires-Python: >=3.9,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: pydantic (>=2)
Requires-Dist: python-dateutil (>=2.8.2)
Requires-Dist: typing-extensions (>=4.7.1)
Requires-Dist: urllib3 (>=2.1.0,<3.0.0)
Project-URL: Repository, https://github.com/ionos-cloud/sdk-python
Description-Content-Type: text/markdown

# ionoscloud-dbaas-inmemorydb
IONOS CLOUD Database as a Service (DBaaS) In-Memory DB v2 lets you provision and
manage in-memory clusters through a REST API.
For product information, see [IONOS CLOUD In-Memory DB Guide](https://docs.ionos.com/cloud/databases/in-memory-db).


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.0.0
- Package version: 1.0.0
- Generator version: 7.13.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/ionos-cloud/sdk-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ionos-cloud/sdk-python.git`)

Then import the package:
```python
import ionoscloud_dbaas_inmemorydb
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import ionoscloud_dbaas_inmemorydb
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import ionoscloud_dbaas_inmemorydb
from ionoscloud_dbaas_inmemorydb.rest import ApiException
from pprint import pprint
import os

# Defining the host is optional and defaults to https://in-memory-db.de-fra.ionos.com/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_dbaas_inmemorydb.Configuration(
    host = "https://in-memory-db.de-fra.ionos.com/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): tokenAuth
configuration = ionoscloud_dbaas_inmemorydb.Configuration(
    token = os.environ["IONOS_TOKEN"]
)


# Enter a context with an instance of the API client
with ionoscloud_dbaas_inmemorydb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_inmemorydb.ClustersApi(api_client)
    cluster_id = 'e69b22a5-8fee-56b1-b6fb-4a07e4205ead' # str | The ID (UUID) of the Cluster.

    try:
        # Delete Cluster
        api_instance.clusters_delete(cluster_id)
    except ApiException as e:
        print("Exception when calling ClustersApi->clusters_delete: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://in-memory-db.de-fra.ionos.com/v2*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ClustersApi* | [**clusters_delete**](docs/api/ClustersApi.md#clusters_delete) | **DELETE** /clusters/{clusterId} | Delete Cluster
*ClustersApi* | [**clusters_find_by_id**](docs/api/ClustersApi.md#clusters_find_by_id) | **GET** /clusters/{clusterId} | Retrieve Cluster
*ClustersApi* | [**clusters_get**](docs/api/ClustersApi.md#clusters_get) | **GET** /clusters | Retrieve all Clusters
*ClustersApi* | [**clusters_post**](docs/api/ClustersApi.md#clusters_post) | **POST** /clusters | Create Cluster
*ClustersApi* | [**clusters_put**](docs/api/ClustersApi.md#clusters_put) | **PUT** /clusters/{clusterId} | Ensure Cluster
*SnapshotLocationsApi* | [**snapshotlocations_find_by_id**](docs/api/SnapshotLocationsApi.md#snapshotlocations_find_by_id) | **GET** /snapshot-locations/{snapshotLocationId} | Retrieve SnapshotLocation
*SnapshotLocationsApi* | [**snapshotlocations_get**](docs/api/SnapshotLocationsApi.md#snapshotlocations_get) | **GET** /snapshot-locations | Retrieve all SnapshotLocations
*SnapshotsApi* | [**snapshots_find_by_id**](docs/api/SnapshotsApi.md#snapshots_find_by_id) | **GET** /snapshots/{snapshotId} | Retrieve Snapshot
*SnapshotsApi* | [**snapshots_get**](docs/api/SnapshotsApi.md#snapshots_get) | **GET** /snapshots | Retrieve all Snapshots
*VersionsApi* | [**versions_find_by_id**](docs/api/VersionsApi.md#versions_find_by_id) | **GET** /versions/{versionId} | Retrieve Version
*VersionsApi* | [**versions_get**](docs/api/VersionsApi.md#versions_get) | **GET** /versions | Retrieve all Versions


## Documentation For Models

 - [Cluster](docs/models/Cluster.md)
 - [ClusterConnection](docs/models/ClusterConnection.md)
 - [ClusterCreate](docs/models/ClusterCreate.md)
 - [ClusterCreateProperties](docs/models/ClusterCreateProperties.md)
 - [ClusterEnsure](docs/models/ClusterEnsure.md)
 - [ClusterMetadata](docs/models/ClusterMetadata.md)
 - [ClusterRead](docs/models/ClusterRead.md)
 - [ClusterReadList](docs/models/ClusterReadList.md)
 - [ClusterRestoreFromSnapshot](docs/models/ClusterRestoreFromSnapshot.md)
 - [ClusterState](docs/models/ClusterState.md)
 - [DayOfTheWeek](docs/models/DayOfTheWeek.md)
 - [Error](docs/models/Error.md)
 - [ErrorMessagesInner](docs/models/ErrorMessagesInner.md)
 - [EvictionPolicy](docs/models/EvictionPolicy.md)
 - [HashedPassword](docs/models/HashedPassword.md)
 - [InPlaceRestoreClusterFromSnapshot](docs/models/InPlaceRestoreClusterFromSnapshot.md)
 - [InstanceConfiguration](docs/models/InstanceConfiguration.md)
 - [Links](docs/models/Links.md)
 - [MaintenanceWindow](docs/models/MaintenanceWindow.md)
 - [Metadata](docs/models/Metadata.md)
 - [Pagination](docs/models/Pagination.md)
 - [PersistenceMode](docs/models/PersistenceMode.md)
 - [RestoreClusterFromSnapshot](docs/models/RestoreClusterFromSnapshot.md)
 - [Snapshot](docs/models/Snapshot.md)
 - [SnapshotConfiguration](docs/models/SnapshotConfiguration.md)
 - [SnapshotLocation](docs/models/SnapshotLocation.md)
 - [SnapshotLocationRead](docs/models/SnapshotLocationRead.md)
 - [SnapshotLocationReadList](docs/models/SnapshotLocationReadList.md)
 - [SnapshotRead](docs/models/SnapshotRead.md)
 - [SnapshotReadList](docs/models/SnapshotReadList.md)
 - [SupportedVersion](docs/models/SupportedVersion.md)
 - [User](docs/models/User.md)
 - [VersionRead](docs/models/VersionRead.md)
 - [VersionReadList](docs/models/VersionReadList.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="tokenAuth"></a>
### tokenAuth

- **Type**: Bearer authentication (JWT)


## Author





