# collibra-catalog_sampling_100
<p>The Catalog Sampling API offers functionality related to the Collibra Data Catalog application.<br/> It is mainly focused on facilitating the ingestion of information into Data Catalog.<br/> The API enables you to more easily connect Data Catalog to sources that are not necessarily natively supported in the product.</p>
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```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 collibra_catalog_sampling
```
### 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 collibra_catalog_sampling
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import collibra_catalog_sampling
from collibra_catalog_sampling.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_sampling.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_sampling.SamplesApi(collibra_catalog_sampling.ApiClient(configuration))
asset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Asset identifier
column_limit = 0 # int | The maximum number of columns to retrieve. If not set (columnLimit = <code>0</code>), the default column limit will be used. Maximum is set to 1500. (optional) (default to 0)
column_offset = 0 # int | The index of the fist column to retrieve. If not set (columnOffset = <code>0</code>), results will be retrieved starting from column <code>0</code>. (optional) (default to 0)
try:
# Read sample data from the Collibra cloud repository or Edge cache
api_response = api_instance.read_samples(asset_id, column_limit=column_limit, column_offset=column_offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling SamplesApi->read_samples: %s\n" % e)
# Configure HTTP basic authorization: basicAuth
configuration = collibra_catalog_sampling.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = collibra_catalog_sampling.SamplesApi(collibra_catalog_sampling.ApiClient(configuration))
asset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Asset identifier
try:
# Create a request to collect and cache sample data for an Edge data source
api_response = api_instance.request_samples(asset_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SamplesApi->request_samples: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to */rest/catalogSampling/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SamplesApi* | [**read_samples**](docs/SamplesApi.md#read_samples) | **GET** /samples/{assetId} | Read sample data from the Collibra cloud repository or Edge cache
*SamplesApi* | [**request_samples**](docs/SamplesApi.md#request_samples) | **POST** /samples/{assetId}/request | Create a request to collect and cache sample data for an Edge data source
## Documentation For Models
- [ColumnPagedResponse](docs/ColumnPagedResponse.md)
- [Job](docs/Job.md)
- [ReadSamplesResponse](docs/ReadSamplesResponse.md)
- [RequestSamplesResponse](docs/RequestSamplesResponse.md)
- [SampleColumn](docs/SampleColumn.md)
- [StandardErrorResponse](docs/StandardErrorResponse.md)
## Documentation For Authorization
## basicAuth
- **Type**: HTTP basic authentication
## Author
Raw data
{
"_id": null,
"home_page": null,
"name": "collibra-catalog-sampling-100",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Swagger, Catalog Sampling API",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/05/34/a2cbccd5a8c00bbc1d9a1d61d7e5a2d1510d2a186915866a21ed2c85ddc4/collibra-catalog_sampling_100-1.0.0.tar.gz",
"platform": null,
"description": "# collibra-catalog_sampling_100\n<p>The Catalog Sampling API offers functionality related to the Collibra Data Catalog application.<br/> It is mainly focused on facilitating the ingestion of information into Data Catalog.<br/> The API enables you to more easily connect Data Catalog to sources that are not necessarily natively supported in the product.</p>\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport collibra_catalog_sampling \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport collibra_catalog_sampling\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport collibra_catalog_sampling\nfrom collibra_catalog_sampling.rest import ApiException\nfrom pprint import pprint\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_sampling.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_sampling.SamplesApi(collibra_catalog_sampling.ApiClient(configuration))\nasset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Asset identifier\ncolumn_limit = 0 # int | The maximum number of columns to retrieve. If not set (columnLimit = <code>0</code>), the default column limit will be used. Maximum is set to 1500. (optional) (default to 0)\ncolumn_offset = 0 # int | The index of the fist column to retrieve. If not set (columnOffset = <code>0</code>), results will be retrieved starting from column <code>0</code>. (optional) (default to 0)\n\ntry:\n # Read sample data from the Collibra cloud repository or Edge cache\n api_response = api_instance.read_samples(asset_id, column_limit=column_limit, column_offset=column_offset)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling SamplesApi->read_samples: %s\\n\" % e)\n# Configure HTTP basic authorization: basicAuth\nconfiguration = collibra_catalog_sampling.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = collibra_catalog_sampling.SamplesApi(collibra_catalog_sampling.ApiClient(configuration))\nasset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | Asset identifier\n\ntry:\n # Create a request to collect and cache sample data for an Edge data source\n api_response = api_instance.request_samples(asset_id)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling SamplesApi->request_samples: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to */rest/catalogSampling/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*SamplesApi* | [**read_samples**](docs/SamplesApi.md#read_samples) | **GET** /samples/{assetId} | Read sample data from the Collibra cloud repository or Edge cache\n*SamplesApi* | [**request_samples**](docs/SamplesApi.md#request_samples) | **POST** /samples/{assetId}/request | Create a request to collect and cache sample data for an Edge data source\n\n## Documentation For Models\n\n - [ColumnPagedResponse](docs/ColumnPagedResponse.md)\n - [Job](docs/Job.md)\n - [ReadSamplesResponse](docs/ReadSamplesResponse.md)\n - [RequestSamplesResponse](docs/RequestSamplesResponse.md)\n - [SampleColumn](docs/SampleColumn.md)\n - [StandardErrorResponse](docs/StandardErrorResponse.md)\n\n## Documentation For Authorization\n\n\n## basicAuth\n\n- **Type**: HTTP basic authentication\n\n\n## Author\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Catalog Sampling API",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"swagger",
" catalog sampling api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40844a537edfc17d7d31e8dd71ba9d194f0de286a4955885e048717ee68b3bf6",
"md5": "7533714da19156c3e7c610e77970eadd",
"sha256": "05c41a3874a023d9bd975799767dc9e05e8b7fbae7d3d59c106434586dfd8e54"
},
"downloads": -1,
"filename": "collibra_catalog_sampling_100-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7533714da19156c3e7c610e77970eadd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35790,
"upload_time": "2024-06-24T17:54:41",
"upload_time_iso_8601": "2024-06-24T17:54:41.503264Z",
"url": "https://files.pythonhosted.org/packages/40/84/4a537edfc17d7d31e8dd71ba9d194f0de286a4955885e048717ee68b3bf6/collibra_catalog_sampling_100-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0534a2cbccd5a8c00bbc1d9a1d61d7e5a2d1510d2a186915866a21ed2c85ddc4",
"md5": "97b9c541477644256f568dbd892d2fdd",
"sha256": "5b1ac69654226d18417f63c4f52ca6dd7da3db4257a0b20750d4c3778e1f7036"
},
"downloads": -1,
"filename": "collibra-catalog_sampling_100-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "97b9c541477644256f568dbd892d2fdd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21892,
"upload_time": "2024-06-24T17:54:43",
"upload_time_iso_8601": "2024-06-24T17:54:43.315806Z",
"url": "https://files.pythonhosted.org/packages/05/34/a2cbccd5a8c00bbc1d9a1d61d7e5a2d1510d2a186915866a21ed2c85ddc4/collibra-catalog_sampling_100-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 17:54:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "collibra-catalog-sampling-100"
}
JSON