Skip to content

Commit 9f783e1

Browse files
Excavator: Upgrade API Version
1 parent 337a522 commit 9f783e1

File tree

17 files changed

+180
-153
lines changed

17 files changed

+180
-153
lines changed

docs-snippets-npm/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"sls": {
2525
"dependencies": {
2626
"com.palantir.foundry.api:api-gateway": {
27-
"minVersion": "1.1416.1",
27+
"minVersion": "1.1421.0",
2828
"maxVersion": "1.x.x",
2929
"optional": false
3030
}

docs-snippets-npm/src/index.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1390,7 +1390,7 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
13901390
],
13911391
"v2.createTemporaryObjectSetV2": [
13921392
{
1393-
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# ObjectSet\nobject_set = {\"type\": \"base\", \"objectType\": \"Employee\"}\n# Optional[SdkPackageRid] | The package rid of the generated SDK.\nsdk_package_rid = None\n# Optional[SdkVersion] | The package version of the generated SDK.\nsdk_version = None\n\n\ntry:\n api_response = client.ontologies.OntologyObjectSet.create_temporary(\n ontology, object_set=object_set, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version\n )\n print(\"The create_temporary response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling OntologyObjectSet.create_temporary: %s\\n\" % e)"
1393+
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# ObjectSet\nobject_set = {\"type\": \"base\", \"objectType\": \"Employee\"}\n# Optional[FoundryBranch] | The Foundry branch to reference. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.\nbranch = None\n# Optional[SdkPackageRid] | The package rid of the generated SDK.\nsdk_package_rid = None\n# Optional[SdkVersion] | The package version of the generated SDK.\nsdk_version = None\n\n\ntry:\n api_response = client.ontologies.OntologyObjectSet.create_temporary(\n ontology,\n object_set=object_set,\n branch=branch,\n sdk_package_rid=sdk_package_rid,\n sdk_version=sdk_version,\n )\n print(\"The create_temporary response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling OntologyObjectSet.create_temporary: %s\\n\" % e)"
13941394
}
13951395
],
13961396
"v2.getObjectSetV2": [
@@ -1415,7 +1415,7 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
14151415
],
14161416
"v2.loadObjectSetV2ObjectsOrInterfaces": [
14171417
{
1418-
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# ObjectSet\nobject_set = {\"type\": \"base\", \"interfaceBase\": \"Person\"}\n# List[SelectedPropertyApiName]\nselect = None\n# List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both.\nselect_v2 = None\n# Optional[FoundryBranch] | The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported.\nbranch = None\n# Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2.\nexclude_rid = None\n# Optional[SearchOrderByV2]\norder_by = None\n# Optional[PageSize]\npage_size = 10000\n# Optional[PageToken]\npage_token = \"v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv\"\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n# Optional[SdkPackageRid] | The package rid of the generated SDK.\nsdk_package_rid = None\n# Optional[SdkVersion] | The package version of the generated SDK.\nsdk_version = None\n# Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results.\nsnapshot = None\n\n\ntry:\n api_response = client.ontologies.OntologyObjectSet.load_objects_or_interfaces(\n ontology,\n object_set=object_set,\n select=select,\n select_v2=select_v2,\n branch=branch,\n exclude_rid=exclude_rid,\n order_by=order_by,\n page_size=page_size,\n page_token=page_token,\n preview=preview,\n sdk_package_rid=sdk_package_rid,\n sdk_version=sdk_version,\n snapshot=snapshot,\n )\n print(\"The load_objects_or_interfaces response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling OntologyObjectSet.load_objects_or_interfaces: %s\\n\" % e)"
1418+
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# ObjectSet\nobject_set = {\"type\": \"interfaceBase\", \"interfaceType\": \"Person\"}\n# List[SelectedPropertyApiName]\nselect = None\n# List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both.\nselect_v2 = None\n# Optional[FoundryBranch] | The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported.\nbranch = None\n# Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2.\nexclude_rid = None\n# Optional[SearchOrderByV2]\norder_by = None\n# Optional[PageSize]\npage_size = 10000\n# Optional[PageToken]\npage_token = \"v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv\"\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n# Optional[SdkPackageRid] | The package rid of the generated SDK.\nsdk_package_rid = None\n# Optional[SdkVersion] | The package version of the generated SDK.\nsdk_version = None\n# Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results.\nsnapshot = None\n\n\ntry:\n api_response = client.ontologies.OntologyObjectSet.load_objects_or_interfaces(\n ontology,\n object_set=object_set,\n select=select,\n select_v2=select_v2,\n branch=branch,\n exclude_rid=exclude_rid,\n order_by=order_by,\n page_size=page_size,\n page_token=page_token,\n preview=preview,\n sdk_package_rid=sdk_package_rid,\n sdk_version=sdk_version,\n snapshot=snapshot,\n )\n print(\"The load_objects_or_interfaces response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling OntologyObjectSet.load_objects_or_interfaces: %s\\n\" % e)"
14191419
}
14201420
],
14211421
"v2.ontologyTransactionPostEdits": [
@@ -1575,7 +1575,7 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
15751575
],
15761576
"v2.cancelSqlQuery": [
15771577
{
1578-
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# SqlQueryId | The id of a query.\nsql_query_id = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.sql_queries.SqlQuery.cancel(sql_query_id, preview=preview)\n print(\"The cancel response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling SqlQuery.cancel: %s\\n\" % e)"
1578+
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# SqlQueryId | The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints.\nsql_query_id = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.sql_queries.SqlQuery.cancel(sql_query_id, preview=preview)\n print(\"The cancel response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling SqlQuery.cancel: %s\\n\" % e)"
15791579
}
15801580
],
15811581
"v2.executeSqlQuery": [
@@ -1585,12 +1585,12 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
15851585
],
15861586
"v2.getResultsSqlQuery": [
15871587
{
1588-
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# SqlQueryId | The id of a query.\nsql_query_id = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.sql_queries.SqlQuery.get_results(sql_query_id, preview=preview)\n print(\"The get_results response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling SqlQuery.get_results: %s\\n\" % e)"
1588+
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# SqlQueryId | The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints.\nsql_query_id = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.sql_queries.SqlQuery.get_results(sql_query_id, preview=preview)\n print(\"The get_results response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling SqlQuery.get_results: %s\\n\" % e)"
15891589
}
15901590
],
15911591
"v2.getStatusSqlQuery": [
15921592
{
1593-
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# SqlQueryId | The id of a query.\nsql_query_id = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.sql_queries.SqlQuery.get_status(sql_query_id, preview=preview)\n print(\"The get_status response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling SqlQuery.get_status: %s\\n\" % e)"
1593+
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# SqlQueryId | The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints.\nsql_query_id = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.sql_queries.SqlQuery.get_status(sql_query_id, preview=preview)\n print(\"The get_status response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling SqlQuery.get_status: %s\\n\" % e)"
15941594
}
15951595
],
15961596
"v2.createStreamingDataset": [

docs/v2/Ontologies/OntologyObject.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -373,21 +373,21 @@ Partial terms are not matched by terms filters except where explicitly noted.
373373

374374
### Parameters
375375

376-
Name | Type | Description | Notes |
377-
------------- |------------------------------------| ------------- | ------------- |
378-
**ontology** | OntologyIdentifier | | |
379-
**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | |
380-
**select** | List[PropertyApiName] | The API names of the object type properties to include in the response. | |
381-
**select_v2** | Optional[List[PropertyIdentifier]] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
382-
**branch** | Optional[FoundryBranch] | The Foundry branch to search objects from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] |
383-
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
384-
**order_by** | Optional[SearchOrderByV2] | | [optional] |
385-
**page_size** | Optional[PageSize] | | [optional] |
386-
**page_token** | Optional[PageToken] | | [optional] |
387-
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
388-
**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] |
389-
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |
390-
**where** | Optional[SearchJsonQueryV2] | | [optional] |
376+
Name | Type | Description | Notes |
377+
------------- | ------------- | ------------- | ------------- |
378+
**ontology** | OntologyIdentifier | | |
379+
**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | |
380+
**select** | List[PropertyApiName] | The API names of the object type properties to include in the response. | |
381+
**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | |
382+
**branch** | Optional[FoundryBranch] | The Foundry branch to search objects from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] |
383+
**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] |
384+
**order_by** | Optional[SearchOrderByV2] | | [optional] |
385+
**page_size** | Optional[PageSize] | | [optional] |
386+
**page_token** | Optional[PageToken] | | [optional] |
387+
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
388+
**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] |
389+
**snapshot** | Optional[bool] | A flag to use snapshot consistency when paging. Setting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items. Setting this to false will let new results enter as you page, but you may encounter duplicate or missing items. This defaults to false if not specified, which means you will always get the latest results. | [optional] |
390+
**where** | Optional[SearchJsonQueryV2] | | [optional] |
391391

392392
### Return type
393393
**SearchObjectsResponseV2**

0 commit comments

Comments
 (0)