# here-data-volatile-blob-v1-client
The `volatile-blob` service supports the upload and retrieval of volatile data from the storage of a catalog. Each discrete chunk of data is stored as a blob (Binary Large Object). Each blob has its own unique id (data handle) which is stored as partition metadata. To get a partition's data, you first use `metadata` service to retrieve the partition's metadata (data handle) with the addresses of the relevant blobs. You then use those addresses to pull the data using the `volatile-blob` service. Unlike the `blob` service, data handles can be overwritten. Hence the volatile aspect.

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

- API version: 1.0.2
- Package version: 1.2.105
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python >= 3.6

## 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/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import here_data_volatile_blob_v1_client
```

### 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 here_data_volatile_blob_v1_client
```

## Getting Started

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

```python

import time
import here_data_volatile_blob_v1_client
from pprint import pprint
from here_data_volatile_blob_v1_client.api import volatile_blob_api
from here_data_volatile_blob_v1_client.model.authentication_message import AuthenticationMessage
from here_data_volatile_blob_v1_client.model.authorization_message import AuthorizationMessage
# Defining the host is optional and defaults to http://use.apilookup.for.a.base.url
# See configuration.py for a list of all supported configuration parameters.
configuration = here_data_volatile_blob_v1_client.Configuration(
    host = "http://use.apilookup.for.a.base.url"
)

# 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): Bearer
configuration = here_data_volatile_blob_v1_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)


# Enter a context with an instance of the API client
with here_data_volatile_blob_v1_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volatile_blob_api.VolatileBlobApi(api_client)
    layer_id = "my-volatile-layer" # str | The ID of the layer that the volatile blob belongs to.
data_handle = "5023993" # str | The data handle identifies a specific volatile blob so that you can get that blob's contents.
billing_tag = "myBillingTag" # str | Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters  [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases. (optional)

    try:
        # Checks if a data handle exists
        api_response = api_instance.check_handle_exists(layer_id, data_handle, billing_tag=billing_tag)
        pprint(api_response)
    except here_data_volatile_blob_v1_client.ApiException as e:
        print("Exception when calling VolatileBlobApi->check_handle_exists: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *http://use.apilookup.for.a.base.url*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*VolatileBlobApi* | [**check_handle_exists**](docs/VolatileBlobApi.md#check_handle_exists) | **HEAD** /layers/{layerId}/data/{dataHandle} | Checks if a data handle exists
*VolatileBlobApi* | [**delete_volatile_blob**](docs/VolatileBlobApi.md#delete_volatile_blob) | **DELETE** /layers/{layerId}/data/{dataHandle} | Deletes a volatile data blob
*VolatileBlobApi* | [**get_volatile_blob**](docs/VolatileBlobApi.md#get_volatile_blob) | **GET** /layers/{layerId}/data/{dataHandle} | Gets a volatile blob
*VolatileBlobApi* | [**put_volatile_blob**](docs/VolatileBlobApi.md#put_volatile_blob) | **PUT** /layers/{layerId}/data/{dataHandle} | Publishes a volatile data blob


## Documentation For Models

 - [AuthenticationMessage](docs/AuthenticationMessage.md)
 - [AuthorizationMessage](docs/AuthorizationMessage.md)


## Documentation For Authorization


## Bearer

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


## Author




## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in here_data_volatile_blob_v1_client.apis and here_data_volatile_blob_v1_client.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1:
Use specific imports for apis and models like:
- `from here_data_volatile_blob_v1_client.api.default_api import DefaultApi`
- `from here_data_volatile_blob_v1_client.model.pet import Pet`

Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import here_data_volatile_blob_v1_client
from here_data_volatile_blob_v1_client.apis import *
from here_data_volatile_blob_v1_client.models import *
```

