-
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 (#30)
- Loading branch information
1 parent
a6eba06
commit 6e62137
Showing
133 changed files
with
4,605 additions
and
1 deletion.
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,59 @@ | ||
| # Resource | ||
|
|
||
| Method | HTTP request | | ||
| ------------- | ------------- | | ||
|
|
||
| Get the Resource with the specified rid. | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **resource_rid** | ResourceRid | resourceRid | | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **Resource** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # ResourceRid | resourceRid | ||
| resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.filesystem.Resource.get( | ||
| resource_rid, | ||
| preview=preview, | ||
| ) | ||
| print("The get response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling Resource.get: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | Resource | | 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,176 @@ | ||
| # Query | ||
|
|
||
| Method | HTTP request | | ||
| ------------- | ------------- | | ||
|
|
||
| Executes a Query using the given parameters. | ||
|
|
||
| Optional parameters do not need to be supplied. | ||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **query_api_name** | QueryApiName | queryApiName | | | ||
| **parameters** | Dict[ParameterId, Optional[DataValue]] | | | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **ExecuteQueryResponse** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # QueryApiName | queryApiName | ||
| query_api_name = None | ||
| # Dict[ParameterId, Optional[DataValue]] | | ||
| parameters = None | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.functions.Query.execute( | ||
| query_api_name, | ||
| parameters=parameters, | ||
| preview=preview, | ||
| ) | ||
| print("The execute response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling Query.execute: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | ExecuteQueryResponse | | 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) | ||
|
|
||
| Gets a specific query type with the given API name. | ||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **query_api_name** | QueryApiName | queryApiName | | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **Query** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # QueryApiName | queryApiName | ||
| query_api_name = None | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.functions.Query.get( | ||
| query_api_name, | ||
| preview=preview, | ||
| ) | ||
| print("The get response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling Query.get: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | Query | | 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) | ||
|
|
||
| Gets a specific query type with the given RID. | ||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **rid** | FunctionRid | | | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **Query** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # FunctionRid | | ||
| rid = None | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.functions.Query.get_by_rid( | ||
| rid=rid, | ||
| preview=preview, | ||
| ) | ||
| print("The get_by_rid response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling Query.get_by_rid: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | Query | | 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) | ||
|
|
Oops, something went wrong.