Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 87 additions & 1 deletion README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs-snippets-npm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"sls": {
"dependencies": {
"com.palantir.foundry.api:api-gateway": {
"minVersion": "1.1416.1",
"minVersion": "1.1448.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
63 changes: 49 additions & 14 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion docs/v1/Core/models/FilePath.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# FilePath

The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`.
The path to a File within Foundry. Paths are relative and must not start with a leading slash.
Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`.


## Type
Expand Down
1 change: 1 addition & 0 deletions docs/v1/Core/models/UnsupportedType.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ UnsupportedType
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**unsupported_type** | str | Yes | |
**params** | Dict[UnsupportedTypeParamKey, UnsupportedTypeParamValue] | Yes | |
**type** | Literal["unsupported"] | Yes | None |


Expand Down
11 changes: 11 additions & 0 deletions docs/v1/Core/models/UnsupportedTypeParamKey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# UnsupportedTypeParamKey

UnsupportedTypeParamKey

## Type
```python
str
```


[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md)
11 changes: 11 additions & 0 deletions docs/v1/Core/models/UnsupportedTypeParamValue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# UnsupportedTypeParamValue

UnsupportedTypeParamValue

## Type
```python
str
```


[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md)
2 changes: 1 addition & 1 deletion docs/v1/Ontologies/models/ApplyActionMode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ApplyActionMode

ApplyActionMode
If not specified, defaults to `VALIDATE_AND_EXECUTE`.

| **Value** |
| --------- |
Expand Down
1 change: 1 addition & 0 deletions docs/v1/Ontologies/models/PropertyValue.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Represents the value of a property in the following format.
| Integer | number | `238940` |
| Long | string | `"58319870951433"` |
| [MediaReference](https://palantir.com/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` |
| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{"value": 10, "propertySecurityIndex" : 5}` |
| Short | number | `8739` |
| String | string | `"Call me Ishmael"` |
| Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} |
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/Ontologies/models/ReturnEditsMode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ReturnEditsMode

ReturnEditsMode
If not specified, defaults to `NONE`.

| **Value** |
| --------- |
Expand Down
3 changes: 2 additions & 1 deletion docs/v2/Core/models/FilePath.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# FilePath

The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`.
The path to a File within Foundry. Paths are relative and must not start with a leading slash.
Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`.


## Type
Expand Down
1 change: 1 addition & 0 deletions docs/v2/Core/models/UnsupportedType.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ UnsupportedType
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**unsupported_type** | str | Yes | |
**params** | Dict[UnsupportedTypeParamKey, UnsupportedTypeParamValue] | Yes | |
**type** | Literal["unsupported"] | Yes | None |


Expand Down
11 changes: 11 additions & 0 deletions docs/v2/Core/models/UnsupportedTypeParamKey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# UnsupportedTypeParamKey

UnsupportedTypeParamKey

## Type
```python
str
```


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
11 changes: 11 additions & 0 deletions docs/v2/Core/models/UnsupportedTypeParamValue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# UnsupportedTypeParamValue

UnsupportedTypeParamValue

## Type
```python
str
```


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
67 changes: 65 additions & 2 deletions docs/v2/DataHealth/CheckReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v2/dataHealth/checkReports/{checkReportRid} | Public Beta |
[**get**](#get) | **GET** /v2/dataHealth/checks/{checkRid}/checkReports/{checkReportRid} | Public Beta |
[**get_latest**](#get_latest) | **GET** /v2/dataHealth/checks/{checkRid}/checkReports/getLatest | Public Beta |

# **get**
Get the CheckReport with the specified rid.
Expand All @@ -11,6 +12,7 @@ Get the CheckReport with the specified rid.

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**check_rid** | CheckRid | | |
**check_report_rid** | CheckReportRid | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

Expand All @@ -26,14 +28,18 @@ from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# CheckRid
check_rid = "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3"
# CheckReportRid
check_report_rid = "ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.data_health.CheckReport.get(check_report_rid, preview=preview)
api_response = client.data_health.Check.CheckReport.get(
check_rid, check_report_rid, preview=preview
)
print("The get response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
Expand All @@ -54,3 +60,60 @@ See [README](../../../README.md#authorization)

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)

# **get_latest**
Get the most recent check reports for this Check. Reports are returned
in reverse chronological order (most recent first).


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**check_rid** | CheckRid | | |
**limit** | Optional[CheckReportLimit] | The maximum number of check reports to return. Defaults to 10. Maximum allowed value is 100. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**GetLatestCheckReportsResponse**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# CheckRid
check_rid = "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3"
# Optional[CheckReportLimit] | The maximum number of check reports to return. Defaults to 10. Maximum allowed value is 100.
limit = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.data_health.Check.CheckReport.get_latest(
check_rid, limit=limit, preview=preview
)
print("The get_latest response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling CheckReport.get_latest: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | GetLatestCheckReportsResponse | | application/json |

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)

1 change: 1 addition & 0 deletions docs/v2/DataHealth/models/CheckConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ ApproximateUniquePercentageCheckConfig | approximateUniquePercentage
BuildStatusCheckConfig | buildStatus
ColumnTypeCheckConfig | columnType
AllowedColumnValuesCheckConfig | allowedColumnValues
TimeSinceLastUpdatedCheckConfig | timeSinceLastUpdated
NullPercentageCheckConfig | nullPercentage
TotalColumnCountCheckConfig | totalColumnCount
NumericColumnMedianCheckConfig | numericColumnMedian
Expand Down
16 changes: 16 additions & 0 deletions docs/v2/DataHealth/models/CheckReportLimit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# CheckReportLimit

The maximum number of check reports to return in a single request.


Validation rules:
* must be greater than or equal to 1
* must be less than or equal to 100

## Type
```python
int
```


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
11 changes: 11 additions & 0 deletions docs/v2/DataHealth/models/GetLatestCheckReportsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GetLatestCheckReportsResponse

The response for getting the latest check reports.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[CheckReport] | Yes | The list of check reports. |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
11 changes: 11 additions & 0 deletions docs/v2/DataHealth/models/IgnoreEmptyTransactions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# IgnoreEmptyTransactions

Whether empty transactions should be ignored when calculating time since last updated. If true (default), only transactions with actual data changes are considered.

## Type
```python
bool
```


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
1 change: 1 addition & 0 deletions docs/v2/DataHealth/models/ReplaceCheckConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ ReplaceApproximateUniquePercentageCheckConfig | approximateUniquePercentage
ReplaceBuildStatusCheckConfig | buildStatus
ReplaceColumnTypeCheckConfig | columnType
ReplaceAllowedColumnValuesCheckConfig | allowedColumnValues
ReplaceTimeSinceLastUpdatedCheckConfig | timeSinceLastUpdated
ReplaceNullPercentageCheckConfig | nullPercentage
ReplaceTotalColumnCountCheckConfig | totalColumnCount
ReplaceNumericColumnMedianCheckConfig | numericColumnMedian
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ReplaceTimeSinceLastUpdatedCheckConfig

ReplaceTimeSinceLastUpdatedCheckConfig

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**time_check_config** | TransactionTimeCheckConfig | Yes | |
**type** | Literal["timeSinceLastUpdated"] | Yes | None |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
13 changes: 13 additions & 0 deletions docs/v2/DataHealth/models/TimeSinceLastUpdatedCheckConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# TimeSinceLastUpdatedCheckConfig

Checks the total time since the dataset has updated.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**subject** | DatasetSubject | Yes | |
**time_check_config** | TransactionTimeCheckConfig | Yes | |
**type** | Literal["timeSinceLastUpdated"] | Yes | None |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
13 changes: 13 additions & 0 deletions docs/v2/DataHealth/models/TransactionTimeCheckConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# TransactionTimeCheckConfig

Defines the configuration of a transaction-based time check.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**time_bounds** | Optional[TimeBoundsConfig] | No | |
**median_deviation** | Optional[MedianDeviationConfig] | No | |
**ignore_empty_transactions** | Optional[IgnoreEmptyTransactions] | No | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
63 changes: 63 additions & 0 deletions docs/v2/Datasets/Dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**create**](#create) | **POST** /v2/datasets | Stable |
[**get**](#get) | **GET** /v2/datasets/{datasetRid} | Stable |
[**get_health_check_reports**](#get_health_check_reports) | **GET** /v2/datasets/{datasetRid}/getHealthCheckReports | Public Beta |
[**get_health_checks**](#get_health_checks) | **GET** /v2/datasets/{datasetRid}/getHealthChecks | Public Beta |
[**get_schedules**](#get_schedules) | **GET** /v2/datasets/{datasetRid}/getSchedules | Public Beta |
[**get_schema**](#get_schema) | **GET** /v2/datasets/{datasetRid}/getSchema | Public Beta |
Expand Down Expand Up @@ -111,6 +112,68 @@ See [README](../../../README.md#authorization)

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)

# **get_health_check_reports**
Get the most recent Data Health Check report for each check configured on the given Dataset.
Returns one report per check, representing the current health status of the dataset.

To get the list of checks configured on a Dataset, use
[Get Dataset Health Checks](https://palantir.com/docs/foundry/api/datasets/get-dataset-health-checks/).
For the full report history of a specific check, use
[Get Latest Check Reports](https://palantir.com/docs/foundry/api/v2/data-health-v2-resources/checks/get-latest-check-reports).


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**dataset_rid** | DatasetRid | | |
**branch_name** | Optional[BranchName] | The name of the Branch. If none is provided, the default Branch name - `master` for most enrollments - will be used. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**GetHealthCheckReportsResponse**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# DatasetRid
dataset_rid = None
# Optional[BranchName] | The name of the Branch. If none is provided, the default Branch name - `master` for most enrollments - will be used.
branch_name = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.datasets.Dataset.get_health_check_reports(
dataset_rid, branch_name=branch_name, preview=preview
)
print("The get_health_check_reports response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Dataset.get_health_check_reports: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | GetHealthCheckReportsResponse | | application/json |

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)

# **get_health_checks**
Get the RIDs of the Data Health Checks that are configured for the given Dataset.

Expand Down
Loading