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
41 changes: 41 additions & 0 deletions 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.1697.0",
"minVersion": "1.1716.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
27 changes: 16 additions & 11 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/v1/Ontologies/models/ParameterEvaluationResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Represents the validity of a parameter against the configured constraints.
**result** | ValidationResult | Yes | |
**evaluated_constraints** | List[ParameterEvaluatedConstraint] | Yes | |
**required** | bool | Yes | Represents whether the parameter is a required input to the action. |
**default_value** | Optional[DataValue] | No | |


[[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: 2 additions & 0 deletions docs/v2/DataHealth/models/CheckConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ BuildStatusCheckConfig | buildStatus
ColumnTypeCheckConfig | columnType
AllowedColumnValuesCheckConfig | allowedColumnValues
TimeSinceLastUpdatedCheckConfig | timeSinceLastUpdated
ScheduleStatusCheckConfig | scheduleStatus
NullPercentageCheckConfig | nullPercentage
ScheduleDurationCheckConfig | scheduleDuration
TotalColumnCountCheckConfig | totalColumnCount
NumericColumnMedianCheckConfig | numericColumnMedian
BuildDurationCheckConfig | buildDuration
Expand Down
2 changes: 2 additions & 0 deletions docs/v2/DataHealth/models/ReplaceCheckConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ ReplaceBuildStatusCheckConfig | buildStatus
ReplaceColumnTypeCheckConfig | columnType
ReplaceAllowedColumnValuesCheckConfig | allowedColumnValues
ReplaceTimeSinceLastUpdatedCheckConfig | timeSinceLastUpdated
ReplaceScheduleStatusCheckConfig | scheduleStatus
ReplaceNullPercentageCheckConfig | nullPercentage
ReplaceScheduleDurationCheckConfig | scheduleDuration
ReplaceTotalColumnCountCheckConfig | totalColumnCount
ReplaceNumericColumnMedianCheckConfig | numericColumnMedian
ReplaceBuildDurationCheckConfig | buildDuration
Expand Down
12 changes: 12 additions & 0 deletions docs/v2/DataHealth/models/ReplaceScheduleDurationCheckConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ReplaceScheduleDurationCheckConfig

ReplaceScheduleDurationCheckConfig

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**time_check_config** | TimeCheckConfig | Yes | |
**type** | Literal["scheduleDuration"] | 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)
12 changes: 12 additions & 0 deletions docs/v2/DataHealth/models/ReplaceScheduleStatusCheckConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ReplaceScheduleStatusCheckConfig

ReplaceScheduleStatusCheckConfig

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**status_check_config** | StatusCheckConfig | Yes | |
**type** | Literal["scheduleStatus"] | 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/ScheduleDurationCheckConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# ScheduleDurationCheckConfig

Checks the total time a schedule takes to complete.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**subject** | ScheduleSubject | Yes | |
**time_check_config** | TimeCheckConfig | Yes | |
**type** | Literal["scheduleDuration"] | 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/ScheduleStatusCheckConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# ScheduleStatusCheckConfig

Checks the status of the most recent schedule run.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**subject** | ScheduleSubject | Yes | |
**status_check_config** | StatusCheckConfig | Yes | |
**type** | Literal["scheduleStatus"] | 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)
11 changes: 11 additions & 0 deletions docs/v2/DataHealth/models/ScheduleSubject.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ScheduleSubject

A schedule resource type.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**schedule_rid** | ScheduleRid | Yes | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
53 changes: 53 additions & 0 deletions docs/v2/Filesystem/Resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Method | HTTP request | Release Stage |
[**get_batch**](#get_batch) | **POST** /v2/filesystem/resources/getBatch | Stable |
[**get_by_path**](#get_by_path) | **GET** /v2/filesystem/resources/getByPath | Stable |
[**get_by_path_batch**](#get_by_path_batch) | **POST** /v2/filesystem/resources/getByPathBatch | Stable |
[**get_recently_viewed**](#get_recently_viewed) | **GET** /v2/filesystem/resources/getRecentlyViewed | Private Beta |
[**markings**](#markings) | **GET** /v2/filesystem/resources/{resourceRid}/markings | Stable |
[**permanently_delete**](#permanently_delete) | **POST** /v2/filesystem/resources/{resourceRid}/permanentlyDelete | Stable |
[**remove_markings**](#remove_markings) | **POST** /v2/filesystem/resources/{resourceRid}/removeMarkings | Stable |
Expand Down Expand Up @@ -361,6 +362,58 @@ 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_recently_viewed**
Get the resources most recently viewed by the calling user. If a resource is now inaccessible or has
been trashed, it will not be included in the response.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**limit** | Optional[RecentlyViewedLimit] | The maximum number of recently viewed resources to return. Defaults to 100, with a maximum of 100. Values above 100 are clamped to 100. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**GetRecentlyViewedResponse**

### Example

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

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

# Optional[RecentlyViewedLimit] | The maximum number of recently viewed resources to return. Defaults to 100, with a maximum of 100. Values above 100 are clamped to 100.
limit = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.filesystem.Resource.get_recently_viewed(limit=limit, preview=preview)
print("The get_recently_viewed response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Resource.get_recently_viewed: %s\n" % e)

```



### Authorization

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

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | GetRecentlyViewedResponse | | 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)

# **markings**
List of Markings directly applied to a resource. The number of Markings on a resource is typically small
so the `pageSize` and `pageToken` parameters are not required.
Expand Down
11 changes: 11 additions & 0 deletions docs/v2/Filesystem/models/GetRecentlyViewedResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GetRecentlyViewedResponse

Response containing the resources most recently viewed by the calling user.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[RecentlyViewedResource] | Yes | The list of recently viewed resources, ordered from most to least recently viewed. |


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

The maximum number of recently viewed resources to return.

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

## 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)
12 changes: 12 additions & 0 deletions docs/v2/Filesystem/models/RecentlyViewedResource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# RecentlyViewedResource

A resource that was recently viewed by the calling user, along with when it was last viewed.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**resource** | Resource | Yes | |
**last_viewed** | datetime | Yes | The timestamp at which the calling user last viewed this resource. |


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