acceldata-sdk-python 26.7.0__tar.gz → 26.9.0__tar.gz

acceldata_sdk_python-26.9.0/CHANGELOG.txt

@@ -0,0 +1,51 @@
+Version Log
+========================
+
+26.9.0 (20/09/2026)
+------------------
+- Released **acceldata_sdk_python** version 26.9.0.
+
+Pipeline Control Plane API (SDK wiring):
+- `GET /torch-pipeline/api/pipelines/summary` — pagination (`page`, `size`, `sortBy`) and filters (name, owner, team, tags, run status/result, etc.).
+- `PUT /torch-pipeline/api/pipelines` — request body is now `PipelineInputRequest` (`pipeline` + `tagWriteMode`).
+- `GET /torch-pipeline/api/pipelines/{identity}` — responses include `tagAssociations` alongside `tags`.
+
+SDK changes:
+- `AdocClient.get_pipelines()` — new optional `pipeline_filter`, `page`, `size`, and `sort_by` parameters.
+- New `PipelineSummaryFilter` SDK type with `to_query_params()` for listing filters.
+- `AdocClient.create_pipeline()` — sends full `PipelineInputRequest` payload including `tagWriteMode` (default `TAGS`).
+- `AdocClient.update_pipeline()` — new optional `tag_write_mode` parameter (default `TAGS`).
+- `CreatePipelineInputRequest` — new `tag_write_mode` and `tag_associations` constructor parameters.
+
+Generated models (OpenAPI) — catalog:
+- `ColumnMapping` — new `lower_bound`, `upper_bound`.
+- `DataAnomalySegmentResult` — new `check_summaries`.
+- `SegmentResultResponse` — new `check_summaries` (list of `CheckSummaryResponse`); new `CheckSummaryResponse` type.
+- `RuleExecution` — new `has_multiple_data_planes`, `left_job_state`, `right_job_state`, `right_request_id`.
+- `YunikornSparkResourceConfig` — new `queue_name`.
+- `NotificationPayload` — `severity` is optional/nullable in OpenAPI (default `"MEDIUM"` on deserialize when omitted or null); applies to catalog and pipeline models.
+- `AnalyticsPipeline` — new `slot_config`, `slots_enabled`; new `SlotConfigInput` type (`provisioned_pushdown`, `provisioned_spark`).
+- `CrawlerRunConfig` — new `asset_batch_size`.
+- `CreateProfile` — new `priority`.
+- `PolicyExecutionRequest` — new `priority`.
+- `ExecutionResult` — new nullable `queued_job_phase` (`WAITING`, `ACQUIRED`, `DISPATCHED`, `IN_PROGRESS`).
+- Policy/rule models — new `tag_associations` on `ColumnMapping`, `DataCadenceRule`, `DataQualityRule`, `Item`, `QualityRule`, `ReconciliationRule`; new `TagDetail` type.
+
+Generated models (OpenAPI) — pipeline:
+- `PipelineInputRequest` — new `tag_write_mode` (default `TAGS`).
+- `Pipeline` — new `tag_associations`, `assembly_id`.
+- `Node` — new `linked_pipeline_run_info`; new `PipelineRunInfo` type.
+- `PipelineRunInfo` — new allowed `source_type`: `AWS_STEP_FUNCTIONS`.
+- `NotificationPayload` — `severity` optional/nullable (default `"MEDIUM"` on deserialize); same contract as catalog.
+
+Tests added:
+- `tests/unit/test_pipeline_summary_filter.py`
+- `tests/unit/test_create_pipeline_input_request.py`
+- `tests/unit/test_pipeline_service_listing_create.py`
+- `tests/unit/test_notification_payload.py`
+- `tests/unit/test_analytics_pipeline_deserialization.py`
+- `tests/unit/test_crawler_run_config_deserialization.py`
+- `tests/unit/test_create_profile_deserialization.py`
+- `tests/unit/test_pipeline_deserialization.py`
+- `tests/unit/test_policy_executions.py` — `TestPolicyExecutionRequestPriority`
+- `tests/unit/test_executor.py` — `ExecutionResult.queued_job_phase` coverage

{acceldata_sdk_python-26.7.0/acceldata_sdk_python.egg-info → acceldata_sdk_python-26.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acceldata_sdk_python
-Version: 26.7.0
+Version: 26.9.0
 Summary: Acceldata SDK Python
 Author-email: acceldata <apisupport@acceldata.io>
 License-Expression: MIT

{acceldata_sdk_python-26.7.0 → acceldata_sdk_python-26.9.0}/README-pipeline.md

@@ -24,14 +24,13 @@ The rest of this guide is organized by topic (definition, runs, spans, jobs, eve
 
 ## Creating a pipeline
 
-`CreatePipelineInputRequest` accepts an optional `tags` argument: a list of `Tag` objects attached to the pipeline definition for discovery and display in ADOC. Each tag has a `name` (stable identifier, often a `key:value` style string) and a `displayName` (human-readable label in the UI). When `tags` is omitted, the pipeline is created with no tags.
-
-Updating labels after the fact is a separate call: `PipelineResource.replace_tags(...)` **replaces the entire tag list** with the supplied list. To add or remove a single tag, send a new full list that reflects the desired state.
+Create and update use a `PipelineInputRequest`-shaped body: a `pipeline` object plus
+`tagWriteMode` (default `TAGS`). Prefer `CreatePipelineInputRequest`, which builds that
+payload for you.
 
 ```python
 from acceldata.client.adoc_client import AdocClient
 from acceldata.models.api.pipeline.meta import Meta
-from acceldata.models.api.pipeline.tag import Tag
 from acceldata.models.sdk.pipeline.create_pipeline_input_request import (
     CreatePipelineInputRequest,
 )
@@ -48,15 +47,135 @@ pipeline = client.create_pipeline(
         name="Monthly reporting pipeline",
         description="Builds monthly reporting datasets",
         meta=Meta(owner="data-team", team="analytics", code_location="..."),
+    )
+)
+print(pipeline.to_dict())
+```
+
+For tagging pipelines, see [Pipeline tags](#pipeline-tags) below.
+
+## Pipeline tags
+
+> **Since 26.9.0:** `tagAssociations`, `tag_write_mode` on create/update, and the
+> deprecation of legacy `pipeline.tags` apply from **acceldata-sdk-python 26.9.0**
+> onwards. See [26.9.0 release notes](RELEASE_NOTES_26.9.0.md) for the full change list.
+>
+> **Deprecation:** The legacy `pipeline.tags` field is **deprecated from 26.9.0** and
+> will be removed **after 3 releases**. Affected APIs include
+> `CreatePipelineInputRequest.tags`, and display-name writes via
+> `PipelineResource.replace_tags` / `AdocClient.replace_pipeline_tags` with the default
+> `tag_write_mode="TAGS"`. Tags are migrating to **`tagAssociations`**, which reference
+> existing Tag Service key/value ids (`keyId`, `keyValueId`). **New code should use
+> `tag_associations` with `tag_write_mode="ASSOCIATIONS"`.** The `tags` field still
+> appears in API responses for backward compatibility. To create keys/values and resolve
+> ids, see the [Tags guide](README-unified-tags.md).
+
+### `tag_write_mode`
+
+Available from **26.9.0** on `CreatePipelineInputRequest`, `AdocClient.create_pipeline()`,
+and `AdocClient.update_pipeline()`.
+
+Create and update pipeline calls send `tagWriteMode` (SDK: `tag_write_mode`) to select
+which tag payload is applied. On **update**, the supplied tag set **replaces** the
+existing associations — an empty list clears all tags.
+
+| `tag_write_mode` | Default | Payload applied | `pipeline.tags` on write | `pipeline.tagAssociations` on write | Response includes |
+| --- | --- | --- | --- | --- | --- |
+| `TAGS` | Yes | Legacy display-name tags | Each `Tag.displayName` is find-or-created in the Tag Service (as both key name and value name), then associated with the pipeline. `Tag.name` is stored but not used for find-or-create. | Ignored | Both `tags` and `tagAssociations` (with resolved key/value names) |
+| `ASSOCIATIONS` | No | Tag Service id references | Ignored entirely | Each `TagDetail` with `keyId` and `keyValueId` is associated with the pipeline. Optional `keyName` / `valueName` are read-only in responses. | Both `tags` and `tagAssociations` (with resolved key/value names) |
+
+| SDK parameter | Wire field | Allowed values |
+| --- | --- | --- |
+| `tag_write_mode` | `tagWriteMode` | `TAGS`, `ASSOCIATIONS` |
+
+### Create with `tagAssociations` (recommended)
+
+Use this when tag keys and values already exist in the Tag Service (or after creating
+them via the [Tags guide](README-unified-tags.md)).
+
+```python
+from acceldata.models.api.pipeline.tag_detail import TagDetail
+from acceldata.models.sdk.pipeline.create_pipeline_input_request import (
+    CreatePipelineInputRequest,
+)
+
+pipeline = client.create_pipeline(
+    CreatePipelineInputRequest(
+        uid="monthly_reporting_pipeline_tagged",
+        name="Monthly reporting pipeline (associations)",
+        tag_associations=[
+            TagDetail(keyId=12, keyValueId=34),
+            TagDetail(keyId=12, keyValueId=56),
+        ],
+        tag_write_mode="ASSOCIATIONS",
+    )
+)
+```
+
+### Create with `tags` (deprecated)
+
+Each tag has a `name` (stable identifier, often a `key:value` style string) and a
+`displayName` (human-readable label in the UI). Prefer `tag_associations` instead.
+
+```python
+from acceldata.models.api.pipeline.tag import Tag
+from acceldata.models.sdk.pipeline.create_pipeline_input_request import (
+    CreatePipelineInputRequest,
+)
+
+# tag_write_mode="TAGS" is the default; shown here for clarity
+pipeline = client.create_pipeline(
+    CreatePipelineInputRequest(
+        uid="monthly_reporting_pipeline",
+        name="Monthly reporting pipeline",
         tags=[
             Tag(name="env:prod", displayName="Environment: Production"),
             Tag(name="domain:finance", displayName="Domain: Finance"),
         ],
+        tag_write_mode="TAGS",
     )
 )
-print(pipeline.to_dict())
 ```
 
+### Replace tags on an existing pipeline
+
+Both approaches below **replace the entire tag set** with the supplied list. To add or
+remove a single tag, send the full list that reflects the desired state.
+
+#### Using `replace_tags` with `tagAssociations` (recommended)
+
+```python
+from acceldata.models.api.pipeline.tag_detail import TagDetail
+
+pipeline.replace_tags(
+    tag_associations=[
+        TagDetail(keyId=12, keyValueId=34),
+        TagDetail(keyId=15, keyValueId=78),
+    ],
+    tag_write_mode="ASSOCIATIONS",
+)
+```
+
+Or via the client:
+
+```python
+client.replace_pipeline_tags(
+    pipeline_uid,
+    tag_associations=[TagDetail(keyId=12, keyValueId=34)],
+    tag_write_mode="ASSOCIATIONS",
+)
+```
+
+#### Using `replace_tags` with display-name tags (deprecated)
+
+> **Deprecated from 26.9.0.** Display-name tag writes via `replace_tags` /
+> `replace_pipeline_tags` with the default `tag_write_mode="TAGS"` will be **removed
+> after 3 releases**. Migrate to `tag_associations` with
+> `tag_write_mode="ASSOCIATIONS"` (see above).
+
+Use this when you want to set display-name tags without pre-resolving Tag Service ids.
+It performs a GET + PUT under the default `tag_write_mode="TAGS"`.
+
 ```python
 from acceldata.models.api.pipeline.tag import Tag
 
@@ -68,6 +187,24 @@ pipeline.replace_tags(
 )
 ```
 
+Alternatively, call `AdocClient.replace_pipeline_tags(pipeline_uid, tags)` for the same
+behavior without a `PipelineResource` instance.
+
+You can also use `update_pipeline` directly if you already have the full pipeline object:
+
+```python
+from acceldata.models.api.pipeline.tag_detail import TagDetail
+
+updated = pipeline.pipeline.model_copy(
+    update={
+        "tagAssociations": [
+            TagDetail(keyId=12, keyValueId=34),
+        ],
+    }
+)
+client.update_pipeline(updated, tag_write_mode="ASSOCIATIONS")
+```
+
 ## Pipeline runs
 
 ```python
@@ -406,14 +543,89 @@ runs = client.get_pipeline_runs(pipeline.id)
 runs = pipeline.get_runs()
 ```
 
-### Get all pipelines
+### Get all pipelines (summary listing)
+
+`get_pipelines()` calls `GET /pipelines/summary` and returns a paginated listing of
+pipeline summaries (metadata plus latest run info when available).
 
-`get_pipelines()` returns a listing object; iterate `pipelines` for each row (including `pipeline_summary` with `uid` and `name`).
+| Parameter | Default | Description |
+| --- | --- | --- |
+| `pipeline_filter` | `None` | `PipelineSummaryFilter` instance |
+| `page` | `0` | 0-based page index |
+| `size` | `25` | Results per page |
+| `sort_by` | `None` | Sort as `field:direction`, e.g. `name:asc`, `createdAt:desc`, `latestRunResult:desc` |
+
+Pass filters via `PipelineSummaryFilter`. All filter values are sent as query-string
+parameters (camelCase on the wire). The server parses comma-separated values where
+noted below — matching `PipelineQueryEnhancer` on the torch-pipeline service.
+
+#### Filter categories
+
+| Category | SDK fields | Wire format | Notes |
+| --- | --- | --- | --- |
+| Single value | `name`, `description`, `pipeline_source`, `instrumented_by`, `run_status` | One string | Partial match for `name` / `description`; single enum for `run_status` (`runStatus`) and `pipeline_source` (`pipelineSource`, or `ALL`) |
+| Comma-separated strings | `owner`, `team`, `run_result`, `data_source`, `namespaces` | `"a,b"` string | Pass multiple values as one comma-separated string, e.g. `owner="alice,bob"` |
+| Comma-separated ids | `tag_key_ids`, `tag_key_value_ids`, `tags`, `pipeline_ids`, `adf_ids` | `"1,2"` string | Tag Service / pipeline / ADF ids. SDK also accepts a single `int` or `list[int]` and joins them for you |
+
+#### Filter field reference
+
+| SDK field | Query param | Type on wire |
+| --- | --- | --- |
+| `name` | `name` | string (partial match) |
+| `description` | `description` | string (partial match) |
+| `owner` | `owner` | comma-separated string |
+| `team` | `team` | comma-separated string |
+| `tag_key_ids` | `tagKeyIds` | comma-separated long ids |
+| `tag_key_value_ids` | `tagKeyValueIds` | comma-separated long ids |
+| `tags` | `tags` | comma-separated long ids (alias for `tagKeyValueIds`; merged server-side) |
+| `pipeline_ids` | `pipelineIds` | comma-separated long ids |
+| `pipeline_source` | `pipelineSource` | string (`AIRFLOW`, `ALL`, …) |
+| `instrumented_by` | `instrumentedBy` | string (`SDK`, `OPENLINEAGE`; requires `pipeline_source=AIRFLOW`) |
+| `namespaces` | `namespaces` | comma-separated string (OpenLineage; requires `instrumented_by=OPENLINEAGE` on Airflow) |
+| `data_source` | `dataSource` | comma-separated string |
+| `adf_ids` | `adfIds` | comma-separated long ids (Azure Data Factory integration ids) |
+| `run_status` | `runStatus` | string (single latest-run status) |
+| `run_result` | `runResult` | comma-separated string (e.g. `SUCCESS,FAILURE`) |
 
 ```python
+from acceldata.models.sdk.pipeline.pipeline_summary_filter import PipelineSummaryFilter
+
+# First page (defaults: page=0, size=25)
 listing = client.get_pipelines()
 for row in listing.pipelines:
     print(row.pipeline_summary.uid, row.pipeline_summary.name)
+
+# Paginated + filtered (strings and comma-separated values)
+listing = client.get_pipelines(
+    pipeline_filter=PipelineSummaryFilter(
+        name="reporting",
+        owner="data-team",
+        tag_key_value_ids="34,56",
+        run_result="SUCCESS",
+    ),
+    page=0,
+    size=10,
+    sort_by="name:asc",
+)
+
+# Filter by pipeline ids — pass a list of ints or a comma-separated string
+listing = client.get_pipelines(
+    pipeline_filter=PipelineSummaryFilter(
+        pipeline_ids=[487648, 489112],
+    ),
+)
+
+# Tag Service filters — list[int] is supported for id fields
+listing = client.get_pipelines(
+    pipeline_filter=PipelineSummaryFilter(
+        tag_key_ids=[12],
+        tags=[34, 56],  # alias for tagKeyValueIds
+    ),
+)
+
+for row in listing.pipelines:
+    summary = row.pipeline_summary
+    print(summary.uid, summary.name, summary.owner, row.latest_run_result)
 ```
 
 ### Delete a pipeline

{acceldata_sdk_python-26.7.0 → acceldata_sdk_python-26.9.0}/README-tags.md

@@ -31,10 +31,14 @@ Use the ADOC base URL and API keys from your administrator. For local scripts, e
 
 Asset tags are catalog-level tags associated with a single asset. You can work with them on **`AdocClient`** (by numeric asset id) or on an **`AssetResource`** returned from `client.get_asset(...)`.
 
+> **Deprecated:** `get_asset_tags` / `add_asset_tag` call legacy
+> `GET/POST .../assets/{id}/tags|tag`. Prefer unified tag associations:
+> `client.get_tags_for_entity(asset_id, entity_type=ASSET)` and `client.associate_tags(...)`.
+
 | Method | HTTP | Description |
 | --- | --- | --- |
-| `get_asset_tags(asset_id)` | `GET .../assets/{id}/tags` | List tags on an asset |
-| `add_asset_tag(asset_id, payload)` | `POST .../assets/{id}/tag` | Add a tag to an asset |
+| `get_asset_tags(asset_id)` | `GET .../assets/{id}/tags` | List tags on an asset (**deprecated**) |
+| `add_asset_tag(asset_id, payload)` | `POST .../assets/{id}/tag` | Add a tag to an asset (**deprecated**) |
 
 Both approaches return **`AssetTagInfo`** objects with fields such as `name`, `id`, `classification`, `enabled`, and `processing_status`. Use `tag.to_dict()` for the full API-shaped payload.
 
@@ -79,10 +83,13 @@ if not any(t.name == tag_name for t in tags):
 
 Asset labels are key–value pairs stored on a catalog asset. You can read them with **`get_asset_labels`** and set or update them with **`add_asset_labels`**.
 
+> **Deprecated:** these call legacy `GET/PUT .../assets/{id}/labels`. Prefer
+> `client.get_tags_for_entity(asset_id, entity_type=ASSET)` and `client.associate_tags(...)`.
+
 | Method | HTTP | Description |
 | --- | --- | --- |
-| `get_asset_labels(asset_id)` | `GET .../assets/{id}/labels` | List labels on an asset |
-| `add_asset_labels(asset_id, payload)` | `PUT .../assets/{id}/labels` | Set or update labels |
+| `get_asset_labels(asset_id)` | `GET .../assets/{id}/labels` | List labels on an asset (**deprecated**) |
+| `add_asset_labels(asset_id, payload)` | `PUT .../assets/{id}/labels` | Set or update labels (**deprecated**) |
 
 Each label is a **`Label`** with `key` and `value`. The update call accepts one or more labels in a single request.
 

acceldata_sdk_python-26.9.0/README-unified-tags.md

@@ -0,0 +1,120 @@
+# Tags guide
+
+This guide explains how to create tags and assign them to catalog entities with `acceldata-sdk-python`.
+
+## Capabilities
+
+- Create a tag key with initial values
+- Add more values to an existing key
+- Search keys and values
+- Associate tag values to entities like policies or assets
+
+For setup and authentication, see [README](README.md).
+
+## Concept model
+
+- A **tag key** defines a dimension, like `environment`
+- A **tag value** is an allowed value, like `prod` or `staging`
+- A **tag association** links one or more values to an entity
+
+## Quick flow
+
+1. Create a tag key.
+2. Add values.
+3. Search and collect value IDs.
+4. Associate values to an entity.
+
+## 1) Create a tag key
+
+```python
+from acceldata.client.adoc_client import AdocClient
+from acceldata.models.api.tags.create_tag_request import CreateTagRequest
+from acceldata.models.sdk.tags.create_tag_type import CreateTagType
+
+client = AdocClient(
+    url="https://<your-adoc-url>",
+    access_key="<your-access-key>",
+    secret_key="<your-secret-key>",
+)
+
+tag = client.create_tag(
+    CreateTagRequest(
+        key="environment",
+        values=["prod"],
+        type=CreateTagType.USER,
+    )
+)
+print(tag.to_dict())
+```
+
+## 2) Add more values
+
+```python
+tag.add_values(["staging", "dev"])
+```
+
+Values can also be added by key id with `add_values_to_tag_key(...)`.
+
+## 3) Search keys and values
+
+```python
+from acceldata.models.sdk.tags.search_key_values_request import SearchKeyValuesRequest
+
+search = client.search_tag_key_values(
+    SearchKeyValuesRequest(name="environment", page=0, size=20)
+)
+```
+
+## 4) Associate values to an entity
+
+```python
+from acceldata.models.api.catalog.associate_tags_request import AssociateTagsRequest
+from acceldata.models.sdk.tags import TagEntityType
+
+key_value_ids = [item.key_value_id for item in (search.results or []) if item.key_value_id]
+
+client.associate_tags(
+    AssociateTagsRequest(
+        entity_id=89,
+        entity_type=TagEntityType.POLICY,
+        key_value_ids=key_value_ids,
+    )
+)
+```
+
+Pipelines can also take Tag Service associations at create/update time via
+`tagWriteMode=ASSOCIATIONS` on `CreatePipelineInputRequest` (see
+[Pipelines guide](README-pipeline.md)).
+
+```python
+from acceldata.models.api.pipeline.tag_detail import TagDetail
+from acceldata.models.sdk.pipeline import CreatePipelineInputRequest
+
+pipeline = client.create_pipeline(
+    CreatePipelineInputRequest(
+        uid="etl_pipeline",
+        name="ETL pipeline",
+        tag_associations=[TagDetail(keyId=12, keyValueId=key_value_ids[0])],
+        tag_write_mode="ASSOCIATIONS",
+    )
+)
+```
+
+## Verify associations
+
+```python
+entity_tags = client.get_tags_for_entity(89, TagEntityType.POLICY)
+print([t.to_dict() for t in entity_tags])
+```
+
+## Common mistakes
+
+- Creating a key but not adding required values
+- Associating with empty `key_value_ids`
+- Using an entity id that does not exist
+- Forgetting to verify with `get_tags_for_entity(...)`
+
+## See also
+
+- [Catalog guide](README-catalog.md)
+- [Policies guide](README-policies.md)