# `alteia datastreams`
**Usage**:
```console
$ alteia datastreams [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--install-completion`: Install completion for the current shell.
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
* `--help`: Show this message and exit.
**Commands**:
* `aggregate-partial-results`: Aggregate a datastream outputs using its...
* `complete`: Complete a datastream.
* `create`: Create a datastream from a datastream...
* `describe`: Describe datastream and its datastream...
* `get`: Get datastream description in yaml format.
* `list`: List datastreams.
* `list-partial-aggregations`: List ongoing aggregation for a datastream.
* `monitor-assets`: Monitor datastream assets monitored.
* `trigger`: Trigger a datastream in order to...
## `alteia datastreams aggregate-partial-results`
Aggregate a datastream outputs using its aggregation parameters.
**Usage**:
```console
$ alteia datastreams aggregate-partial-results [OPTIONS] DATASTREAM_ID
```
**Arguments**:
* `DATASTREAM_ID`: Datastream ID [required]
**Options**:
* `--force-command / --no-force-command`: Force partial aggregation command even if another one is running. [default: no-force-command]
* `--help`: Show this message and exit.
## `alteia datastreams complete`
Complete a datastream.
**Usage**:
```console
$ alteia datastreams complete [OPTIONS] DATASTREAM_ID
```
**Arguments**:
* `DATASTREAM_ID`: Datastream ID [required]
**Options**:
* `--help`: Show this message and exit.
## `alteia datastreams create`
Create a datastream from a datastream template.
**Usage**:
```console
$ alteia datastreams create [OPTIONS]
```
**Options**:
* `--name TEXT`: Datastream name. [required]
* `--template TEXT`: Datastream Template identifier. [required]
* `--source TEXT`: Source url. [required]
* `--synchronisation TEXT`: Source synchronisation. [default: automatic]
* `--start-date TEXT`: Start date in format 2023-01-01T01:01:01Z. [required]
* `--end-date TEXT`: End date in format 2023-02-01T01:01:01Z. [required]
* `--description TEXT`: Description.
* `--regex TEXT`: Regex. [default: .*las$]
* `--project TEXT`: Project identifier, used in order to describe a project target.
* `--help`: Show this message and exit.
## `alteia datastreams describe`
Describe datastream and its datastream files status.
**Usage**:
```console
$ alteia datastreams describe [OPTIONS] DATASTREAM_ID
```
**Arguments**:
* `DATASTREAM_ID`: Datastream ID [required]
**Options**:
* `--help`: Show this message and exit.
## `alteia datastreams get`
Get datastream description in yaml format.
**Usage**:
```console
$ alteia datastreams get [OPTIONS] DATASTREAM_ID
```
**Arguments**:
* `DATASTREAM_ID`: Datastream ID [required]
**Options**:
* `--help`: Show this message and exit.
## `alteia datastreams list`
List datastreams.
**Usage**:
```console
$ alteia datastreams list [OPTIONS]
```
**Options**:
* `--company TEXT`: Company ID.
* `--limit INTEGER`: Limit number of results. [default: 10]
* `--asset-schema-repository TEXT`: Asset schema repository name.
* `--asset-schema TEXT`: Asset schema name.
* `--asset-schema-repository-id TEXT`: Asset schema repository id.
* `--asset-schema-id TEXT`: Asset schema id.
* `--help`: Show this message and exit.
## `alteia datastreams list-partial-aggregations`
List ongoing aggregation for a datastream.
**Usage**:
```console
$ alteia datastreams list-partial-aggregations [OPTIONS] DATASTREAM_ID
```
**Arguments**:
* `DATASTREAM_ID`: Datastream ID [required]
**Options**:
* `--help`: Show this message and exit.
## `alteia datastreams monitor-assets`
Monitor datastream assets monitored.
**Usage**:
```console
$ alteia datastreams monitor-assets [OPTIONS] DATASTREAM_ID
```
**Arguments**:
* `DATASTREAM_ID`: Datastream ID [required]
**Options**:
* `--help`: Show this message and exit.
## `alteia datastreams trigger`
Trigger a datastream in order to synchronise
the datastream files with its source.
**Usage**:
```console
$ alteia datastreams trigger [OPTIONS] DATASTREAM_ID
```
**Arguments**:
* `DATASTREAM_ID`: Datastream ID [required]
**Options**:
* `--max-nb-files-sync INTEGER`: Maximum number of files to synchronize. [default: 20]
* `--fill-runnings-files / --no-fill-runnings-files`: Synchronize files in order to reach the maximum number of files. [default: no-fill-runnings-files]
* `--help`: Show this message and exit.
# `alteia datastreamtemplates`
**Usage**:
```console
$ alteia datastreamtemplates [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--install-completion`: Install completion for the current shell.
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
* `--help`: Show this message and exit.
**Commands**:
* `create`: Create a datastream template.
* `delete`: Delete a datastream template.
* `list`: List datastream templates.
## `alteia datastreamtemplates create`
Create a datastream template.
**Usage**:
```console
$ alteia datastreamtemplates create [OPTIONS]
```
**Options**:
* `--description PATH`: Path of the datastream template description (YAML file). [required]
* `--company TEXT`: Company identifier. [required]
* `--help`: Show this message and exit.
## `alteia datastreamtemplates delete`
Delete a datastream template.
**Usage**:
```console
$ alteia datastreamtemplates delete [OPTIONS] DATASTREAMSTEMPLATE
```
**Arguments**:
* `DATASTREAMSTEMPLATE`: Datastream template ID [required]
**Options**:
* `--help`: Show this message and exit.
## `alteia datastreamtemplates list`
List datastream templates.
**Usage**:
```console
$ alteia datastreamtemplates list [OPTIONS]
```
**Options**:
* `--company TEXT`: Company ID.
* `--limit INTEGER`: Limit number of results. [default: 10]
* `--asset-schema-repository TEXT`: Asset schema repository name.
* `--asset-schema TEXT`: Asset schema name.
* `--help`: Show this message and exit.
Raw data
{
"_id": null,
"home_page": "",
"name": "alteia-cli-dataflow-management",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.0,<4.0.0",
"maintainer_email": "",
"keywords": "cli,alteia",
"author": "Alteia Backend Team",
"author_email": "backend-team@alteia.com",
"download_url": "https://files.pythonhosted.org/packages/fe/58/00abc05aa934bcab776a59f1b2e44b70422ee50ff426d985585b2809529f/alteia-cli-dataflow-management-1.0.0.tar.gz",
"platform": null,
"description": "# `alteia datastreams`\n\n**Usage**:\n\n```console\n$ alteia datastreams [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n* `--install-completion`: Install completion for the current shell.\n* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n* `--help`: Show this message and exit.\n\n**Commands**:\n\n* `aggregate-partial-results`: Aggregate a datastream outputs using its...\n* `complete`: Complete a datastream.\n* `create`: Create a datastream from a datastream...\n* `describe`: Describe datastream and its datastream...\n* `get`: Get datastream description in yaml format.\n* `list`: List datastreams.\n* `list-partial-aggregations`: List ongoing aggregation for a datastream.\n* `monitor-assets`: Monitor datastream assets monitored.\n* `trigger`: Trigger a datastream in order to...\n\n## `alteia datastreams aggregate-partial-results`\n\nAggregate a datastream outputs using its aggregation parameters.\n\n**Usage**:\n\n```console\n$ alteia datastreams aggregate-partial-results [OPTIONS] DATASTREAM_ID\n```\n\n**Arguments**:\n\n* `DATASTREAM_ID`: Datastream ID [required]\n\n**Options**:\n\n* `--force-command / --no-force-command`: Force partial aggregation command even if another one is running. [default: no-force-command]\n* `--help`: Show this message and exit.\n\n## `alteia datastreams complete`\n\nComplete a datastream.\n\n**Usage**:\n\n```console\n$ alteia datastreams complete [OPTIONS] DATASTREAM_ID\n```\n\n**Arguments**:\n\n* `DATASTREAM_ID`: Datastream ID [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `alteia datastreams create`\n\nCreate a datastream from a datastream template.\n\n**Usage**:\n\n```console\n$ alteia datastreams create [OPTIONS]\n```\n\n**Options**:\n\n* `--name TEXT`: Datastream name. [required]\n* `--template TEXT`: Datastream Template identifier. [required]\n* `--source TEXT`: Source url. [required]\n* `--synchronisation TEXT`: Source synchronisation. [default: automatic]\n* `--start-date TEXT`: Start date in format 2023-01-01T01:01:01Z. [required]\n* `--end-date TEXT`: End date in format 2023-02-01T01:01:01Z. [required]\n* `--description TEXT`: Description.\n* `--regex TEXT`: Regex. [default: .*las$]\n* `--project TEXT`: Project identifier, used in order to describe a project target.\n* `--help`: Show this message and exit.\n\n## `alteia datastreams describe`\n\nDescribe datastream and its datastream files status.\n\n**Usage**:\n\n```console\n$ alteia datastreams describe [OPTIONS] DATASTREAM_ID\n```\n\n**Arguments**:\n\n* `DATASTREAM_ID`: Datastream ID [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `alteia datastreams get`\n\nGet datastream description in yaml format.\n\n**Usage**:\n\n```console\n$ alteia datastreams get [OPTIONS] DATASTREAM_ID\n```\n\n**Arguments**:\n\n* `DATASTREAM_ID`: Datastream ID [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `alteia datastreams list`\n\nList datastreams.\n\n**Usage**:\n\n```console\n$ alteia datastreams list [OPTIONS]\n```\n\n**Options**:\n\n* `--company TEXT`: Company ID.\n* `--limit INTEGER`: Limit number of results. [default: 10]\n* `--asset-schema-repository TEXT`: Asset schema repository name.\n* `--asset-schema TEXT`: Asset schema name.\n* `--asset-schema-repository-id TEXT`: Asset schema repository id.\n* `--asset-schema-id TEXT`: Asset schema id.\n* `--help`: Show this message and exit.\n\n## `alteia datastreams list-partial-aggregations`\n\nList ongoing aggregation for a datastream.\n\n**Usage**:\n\n```console\n$ alteia datastreams list-partial-aggregations [OPTIONS] DATASTREAM_ID\n```\n\n**Arguments**:\n\n* `DATASTREAM_ID`: Datastream ID [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `alteia datastreams monitor-assets`\n\nMonitor datastream assets monitored.\n\n**Usage**:\n\n```console\n$ alteia datastreams monitor-assets [OPTIONS] DATASTREAM_ID\n```\n\n**Arguments**:\n\n* `DATASTREAM_ID`: Datastream ID [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `alteia datastreams trigger`\n\nTrigger a datastream in order to synchronise\nthe datastream files with its source.\n\n**Usage**:\n\n```console\n$ alteia datastreams trigger [OPTIONS] DATASTREAM_ID\n```\n\n**Arguments**:\n\n* `DATASTREAM_ID`: Datastream ID [required]\n\n**Options**:\n\n* `--max-nb-files-sync INTEGER`: Maximum number of files to synchronize. [default: 20]\n* `--fill-runnings-files / --no-fill-runnings-files`: Synchronize files in order to reach the maximum number of files. [default: no-fill-runnings-files]\n* `--help`: Show this message and exit.\n\n# `alteia datastreamtemplates`\n\n**Usage**:\n\n```console\n$ alteia datastreamtemplates [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n* `--install-completion`: Install completion for the current shell.\n* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n* `--help`: Show this message and exit.\n\n**Commands**:\n\n* `create`: Create a datastream template.\n* `delete`: Delete a datastream template.\n* `list`: List datastream templates.\n\n## `alteia datastreamtemplates create`\n\nCreate a datastream template.\n\n**Usage**:\n\n```console\n$ alteia datastreamtemplates create [OPTIONS]\n```\n\n**Options**:\n\n* `--description PATH`: Path of the datastream template description (YAML file). [required]\n* `--company TEXT`: Company identifier. [required]\n* `--help`: Show this message and exit.\n\n## `alteia datastreamtemplates delete`\n\nDelete a datastream template.\n\n**Usage**:\n\n```console\n$ alteia datastreamtemplates delete [OPTIONS] DATASTREAMSTEMPLATE\n```\n\n**Arguments**:\n\n* `DATASTREAMSTEMPLATE`: Datastream template ID [required]\n\n**Options**:\n\n* `--help`: Show this message and exit.\n\n## `alteia datastreamtemplates list`\n\nList datastream templates.\n\n**Usage**:\n\n```console\n$ alteia datastreamtemplates list [OPTIONS]\n```\n\n**Options**:\n\n* `--company TEXT`: Company ID.\n* `--limit INTEGER`: Limit number of results. [default: 10]\n* `--asset-schema-repository TEXT`: Asset schema repository name.\n* `--asset-schema TEXT`: Asset schema name.\n* `--help`: Show this message and exit.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Alteia CLI extension for dataflow management",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"cli",
"alteia"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac788019429bb14868c40d5dc0e5c57aa0069ea329a3bbda9185571851adeb86",
"md5": "4d4ff2caeb5b57a11d2efdc749de98c6",
"sha256": "72b5a6947b1df14fad69debc48585a75d8b096ac7ff71fb424d18fc367518dd5"
},
"downloads": -1,
"filename": "alteia_cli_dataflow_management-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4d4ff2caeb5b57a11d2efdc749de98c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0,<4.0.0",
"size": 9609,
"upload_time": "2023-06-13T07:35:56",
"upload_time_iso_8601": "2023-06-13T07:35:56.245359Z",
"url": "https://files.pythonhosted.org/packages/ac/78/8019429bb14868c40d5dc0e5c57aa0069ea329a3bbda9185571851adeb86/alteia_cli_dataflow_management-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe5800abc05aa934bcab776a59f1b2e44b70422ee50ff426d985585b2809529f",
"md5": "abd62313e67bff8bcd4fe73224363731",
"sha256": "f232cb220e32337e1779b5d0d9116df87a02a73f6fea88309603380f4ce33be7"
},
"downloads": -1,
"filename": "alteia-cli-dataflow-management-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "abd62313e67bff8bcd4fe73224363731",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0,<4.0.0",
"size": 9142,
"upload_time": "2023-06-13T07:35:54",
"upload_time_iso_8601": "2023-06-13T07:35:54.535450Z",
"url": "https://files.pythonhosted.org/packages/fe/58/00abc05aa934bcab776a59f1b2e44b70422ee50ff426d985585b2809529f/alteia-cli-dataflow-management-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-13 07:35:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "alteia-cli-dataflow-management"
}
JSON