-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Excavator: Upgrade API Version (#38)
- Loading branch information
1 parent
087ac4d
commit 431176f
Showing
36 changed files
with
1,332 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,252 @@ | ||
| # Folder | ||
|
|
||
| Method | HTTP request | | ||
| ------------- | ------------- | | ||
| [**children**](#children) | **GET** /v2/filesystem/folders/{folderRid}/children | | ||
| [**children_page**](#children_page) | **GET** /v2/filesystem/folders/{folderRid}/children | | ||
| [**create**](#create) | **POST** /v2/filesystem/folders | | ||
| [**get**](#get) | **GET** /v2/filesystem/folders/{folderRid} | | ||
|
|
||
| # **children** | ||
| List all child Resources of the Folder. | ||
|
|
||
| This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is | ||
| provided, this page size will also be used as the default. | ||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **folder_rid** | FolderRid | folderRid | | | ||
| **page_size** | Optional[PageSize] | pageSize | [optional] | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **ResourceIterator[Resource]** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # FolderRid | folderRid | ||
| folder_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" | ||
| # Optional[PageSize] | pageSize | ||
| page_size = None | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| for folder in foundry_client.filesystem.Folder.children( | ||
| folder_rid, | ||
| page_size=page_size, | ||
| preview=preview, | ||
| ): | ||
| pprint(folder) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling Folder.children: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | ListChildrenOfFolderResponse | | 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) | ||
|
|
||
| # **children_page** | ||
| List all child Resources of the Folder. | ||
|
|
||
| This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is | ||
| provided, this page size will also be used as the default. | ||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **folder_rid** | FolderRid | folderRid | | | ||
| **page_size** | Optional[PageSize] | pageSize | [optional] | | ||
| **page_token** | Optional[PageToken] | pageToken | [optional] | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **ListChildrenOfFolderResponse** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # FolderRid | folderRid | ||
| folder_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" | ||
| # Optional[PageSize] | pageSize | ||
| page_size = None | ||
| # Optional[PageToken] | pageToken | ||
| page_token = None | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.filesystem.Folder.children_page( | ||
| folder_rid, | ||
| page_size=page_size, | ||
| page_token=page_token, | ||
| preview=preview, | ||
| ) | ||
| print("The children_page response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling Folder.children_page: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | ListChildrenOfFolderResponse | | 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) | ||
|
|
||
| # **create** | ||
| Creates a new Folder. | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **display_name** | ResourceDisplayName | | | | ||
| **parent_folder_rid** | FolderRid | The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, this value will be the root folder (`ri.compass.main.folder.0`). | | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **Folder** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # ResourceDisplayName | | ||
| display_name = "My Folder" | ||
| # FolderRid | The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, this value will be the root folder (`ri.compass.main.folder.0`). | ||
| parent_folder_rid = "ri.compass.main.folder.4cae7c13-b59f-48f6-9ef2-dbde603e4e33" | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.filesystem.Folder.create( | ||
| display_name=display_name, | ||
| parent_folder_rid=parent_folder_rid, | ||
| preview=preview, | ||
| ) | ||
| print("The create response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling Folder.create: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | Folder | The created Folder | 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** | ||
| Get the Folder with the specified rid. | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **folder_rid** | FolderRid | folderRid | | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **Folder** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # FolderRid | folderRid | ||
| folder_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.filesystem.Folder.get( | ||
| folder_rid, | ||
| preview=preview, | ||
| ) | ||
| print("The get response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling Folder.get: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | Folder | | 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) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # ConnectionRid | ||
|
|
||
| The Resource Identifier (RID) of a Connection (formerly known as a source). | ||
|
|
||
|
|
||
| ## Type | ||
| ```python | ||
| RID | ||
| ``` | ||
|
|
||
|
|
||
| [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # FileImport | ||
|
|
||
| FileImport | ||
|
|
||
| ## Properties | ||
| | Name | Type | Required | Description | | ||
| | ------------ | ------------- | ------------- | ------------- | | ||
| **rid** | FileImportRid | Yes | | | ||
| **connection_rid** | ConnectionRid | Yes | The RID of the Connection (formerly known as a source) that the File Import uses to import data. | | ||
| **dataset_rid** | DatasetRid | Yes | The RID of the output dataset. | | ||
| **branch_name** | Optional[BranchName] | No | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | | ||
| **display_name** | FileImportDisplayName | Yes | | | ||
|
|
||
|
|
||
| [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) |
Oops, something went wrong.