Excavator: Upgrade API Version (#92)

palantir · Dec 17, 2024 · 89b0610 · 89b0610
1 parent fcd3130
commit 89b0610
Show file tree

Hide file tree

Showing 77 changed files with 2,036 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -441,6 +441,7 @@ Namespace | Resource | Operation | HTTP request |
 **Orchestration** | Build | [**cancel**](docs/v2/Orchestration/Build.md#cancel) | **POST** /v2/orchestration/builds/{buildRid}/cancel |
 **Orchestration** | Build | [**create**](docs/v2/Orchestration/Build.md#create) | **POST** /v2/orchestration/builds/create |
 **Orchestration** | Build | [**get**](docs/v2/Orchestration/Build.md#get) | **GET** /v2/orchestration/builds/{buildRid} |
+**Orchestration** | Build | [**get_batch**](docs/v2/Orchestration/Build.md#get_batch) | **POST** /v2/orchestration/builds/getBatch |
 **Orchestration** | Schedule | [**create**](docs/v2/Orchestration/Schedule.md#create) | **POST** /v2/orchestration/schedules |
 **Orchestration** | Schedule | [**delete**](docs/v2/Orchestration/Schedule.md#delete) | **DELETE** /v2/orchestration/schedules/{scheduleRid} |
 **Orchestration** | Schedule | [**get**](docs/v2/Orchestration/Schedule.md#get) | **GET** /v2/orchestration/schedules/{scheduleRid} |
@@ -781,6 +782,19 @@ Namespace | Resource | Operation | HTTP request |
 - [FieldSchemaDict](docs/v2/models/FieldSchemaDict.md)
 - [Filename](docs/v2/models/Filename.md)
 - [FilePath](docs/v2/models/FilePath.md)
+- [FilterBinaryTypeDict](docs/v2/models/FilterBinaryTypeDict.md)
+- [FilterBooleanTypeDict](docs/v2/models/FilterBooleanTypeDict.md)
+- [FilterDateTimeTypeDict](docs/v2/models/FilterDateTimeTypeDict.md)
+- [FilterDateTypeDict](docs/v2/models/FilterDateTypeDict.md)
+- [FilterDoubleTypeDict](docs/v2/models/FilterDoubleTypeDict.md)
+- [FilterEnumTypeDict](docs/v2/models/FilterEnumTypeDict.md)
+- [FilterFloatTypeDict](docs/v2/models/FilterFloatTypeDict.md)
+- [FilterIntegerTypeDict](docs/v2/models/FilterIntegerTypeDict.md)
+- [FilterLongTypeDict](docs/v2/models/FilterLongTypeDict.md)
+- [FilterRidTypeDict](docs/v2/models/FilterRidTypeDict.md)
+- [FilterStringTypeDict](docs/v2/models/FilterStringTypeDict.md)
+- [FilterTypeDict](docs/v2/models/FilterTypeDict.md)
+- [FilterUuidTypeDict](docs/v2/models/FilterUuidTypeDict.md)
 - [FloatType](docs/v2/models/FloatType.md)
 - [FloatTypeDict](docs/v2/models/FloatTypeDict.md)
 - [FullRowChangeDataCaptureConfiguration](docs/v2/models/FullRowChangeDataCaptureConfiguration.md)
@@ -807,6 +821,7 @@ Namespace | Resource | Operation | HTTP request |
 - [MediaType](docs/v2/models/MediaType.md)
 - [NullType](docs/v2/models/NullType.md)
 - [NullTypeDict](docs/v2/models/NullTypeDict.md)
+- [OrderByDirection](docs/v2/models/OrderByDirection.md)
 - [OrganizationRid](docs/v2/models/OrganizationRid.md)
 - [PageSize](docs/v2/models/PageSize.md)
 - [PageToken](docs/v2/models/PageToken.md)
@@ -1358,6 +1373,9 @@ Namespace | Resource | Operation | HTTP request |
 - [DatasetUpdatedTriggerDict](docs/v2/models/DatasetUpdatedTriggerDict.md)
 - [FallbackBranches](docs/v2/models/FallbackBranches.md)
 - [ForceBuild](docs/v2/models/ForceBuild.md)
+- [GetBuildsBatchRequestElementDict](docs/v2/models/GetBuildsBatchRequestElementDict.md)
+- [GetBuildsBatchResponse](docs/v2/models/GetBuildsBatchResponse.md)
+- [GetBuildsBatchResponseDict](docs/v2/models/GetBuildsBatchResponseDict.md)
 - [JobSucceededTrigger](docs/v2/models/JobSucceededTrigger.md)
 - [JobSucceededTriggerDict](docs/v2/models/JobSucceededTriggerDict.md)
 - [ListRunsOfScheduleResponse](docs/v2/models/ListRunsOfScheduleResponse.md)
@@ -1407,6 +1425,21 @@ Namespace | Resource | Operation | HTTP request |
 - [ScheduleVersionRid](docs/v2/models/ScheduleVersionRid.md)
 - [ScopeMode](docs/v2/models/ScopeMode.md)
 - [ScopeModeDict](docs/v2/models/ScopeModeDict.md)
+- [SearchBuildsAndFilterDict](docs/v2/models/SearchBuildsAndFilterDict.md)
+- [SearchBuildsEqualsFilterDict](docs/v2/models/SearchBuildsEqualsFilterDict.md)
+- [SearchBuildsEqualsFilterField](docs/v2/models/SearchBuildsEqualsFilterField.md)
+- [SearchBuildsFilterDict](docs/v2/models/SearchBuildsFilterDict.md)
+- [SearchBuildsGteFilterDict](docs/v2/models/SearchBuildsGteFilterDict.md)
+- [SearchBuildsGteFilterField](docs/v2/models/SearchBuildsGteFilterField.md)
+- [SearchBuildsLtFilterDict](docs/v2/models/SearchBuildsLtFilterDict.md)
+- [SearchBuildsLtFilterField](docs/v2/models/SearchBuildsLtFilterField.md)
+- [SearchBuildsNotFilterDict](docs/v2/models/SearchBuildsNotFilterDict.md)
+- [SearchBuildsOrderByDict](docs/v2/models/SearchBuildsOrderByDict.md)
+- [SearchBuildsOrderByField](docs/v2/models/SearchBuildsOrderByField.md)
+- [SearchBuildsOrderByItemDict](docs/v2/models/SearchBuildsOrderByItemDict.md)
+- [SearchBuildsOrFilterDict](docs/v2/models/SearchBuildsOrFilterDict.md)
+- [SearchBuildsResponse](docs/v2/models/SearchBuildsResponse.md)
+- [SearchBuildsResponseDict](docs/v2/models/SearchBuildsResponseDict.md)
 - [TimeTrigger](docs/v2/models/TimeTrigger.md)
 - [TimeTriggerDict](docs/v2/models/TimeTriggerDict.md)
 - [Trigger](docs/v2/models/Trigger.md)

diff --git a/docs/v2/Orchestration/Build.md b/docs/v2/Orchestration/Build.md
@@ -5,6 +5,7 @@ Method | HTTP request |
 [**cancel**](#cancel) | **POST** /v2/orchestration/builds/{buildRid}/cancel |
 [**create**](#create) | **POST** /v2/orchestration/builds/create |
 [**get**](#get) | **GET** /v2/orchestration/builds/{buildRid} |
+[**get_batch**](#get_batch) | **POST** /v2/orchestration/builds/getBatch |
 
 # **cancel**
 Request a cancellation for all unfinished jobs in a build. The build's status will not update immediately. This endpoint is asynchronous and a success response indicates that the cancellation request has been acknowledged and the build is expected to be canceled soon. If the build has already finished or finishes shortly after the request and before the cancellation, the build will not change.
@@ -200,3 +201,126 @@ 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_batch**
+Execute multiple get requests on Build.
+
+The maximum batch size for this endpoint is 100.
+
+### Parameters
+
+Name | Type | Description  | Notes |
+------------- | ------------- | ------------- | ------------- |
+**body** | Annotated[List[GetBuildsBatchRequestElementDict], Len(min_length=1, max_length=100)] | Body of the request |  |
+**preview** | Optional[PreviewMode] | preview | [optional] |
+
+### Return type
+**GetBuildsBatchResponse**
+
+### Example
+
+```python
+from foundry.v2 import FoundryClient
+import foundry
+from pprint import pprint
+
+foundry_client = FoundryClient(
+    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
+)
+
+# Annotated[List[GetBuildsBatchRequestElementDict], Len(min_length=1, max_length=100)] | Body of the request
+body = [{"buildRid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58"}]
+# Optional[PreviewMode] | preview
+preview = None
+
+
+try:
+    api_response = foundry_client.orchestration.Build.get_batch(
+        body,
+        preview=preview,
+    )
+    print("The get_batch response:\n")
+    pprint(api_response)
+except foundry.PalantirRPCException as e:
+    print("HTTP error when calling Build.get_batch: %s\n" % e)
+
+```
+
+
+
+### Authorization
+
+See [README](../../../README.md#authorization)
+
+### HTTP response details
+| Status Code | Type        | Description | Content Type |
+|-------------|-------------|-------------|------------------|
+**200** | GetBuildsBatchResponse  |  | 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)
+
+Search for Builds.
+
+### Parameters
+
+Name | Type | Description  | Notes |
+------------- | ------------- | ------------- | ------------- |
+**where** | SearchBuildsFilterDict |  |  |
+**order_by** | Optional[SearchBuildsOrderByDict] |  | [optional] |
+**page_size** | Optional[PageSize] | The page size for the search request. If no value is provided, a default of `100` will be used.  | [optional] |
+**page_token** | Optional[PageToken] |  | [optional] |
+**preview** | Optional[PreviewMode] | preview | [optional] |
+
+### Return type
+**SearchBuildsResponse**
+
+### Example
+
+```python
+from foundry.v2 import FoundryClient
+import foundry
+from pprint import pprint
+
+foundry_client = FoundryClient(
+    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
+)
+
+# SearchBuildsFilterDict |
+where = None
+# Optional[SearchBuildsOrderByDict] |
+order_by = {"fields": [{"field": "STARTED_TIME", "direction": "ASC"}]}
+# Optional[PageSize] | The page size for the search request. If no value is provided, a default of `100` will be used.
+page_size = 100
+# Optional[PageToken] |
+page_token = "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
+# Optional[PreviewMode] | preview
+preview = None
+
+
+try:
+    api_response = foundry_client.orchestration.Build.search(
+        where=where,
+        order_by=order_by,
+        page_size=page_size,
+        page_token=page_token,
+        preview=preview,
+    )
+    print("The search response:\n")
+    pprint(api_response)
+except foundry.PalantirRPCException as e:
+    print("HTTP error when calling Build.search: %s\n" % e)
+
+```
+
+
+
+### Authorization
+
+See [README](../../../README.md#authorization)
+
+### HTTP response details
+| Status Code | Type        | Description | Content Type |
+|-------------|-------------|-------------|------------------|
+**200** | SearchBuildsResponse  |  | 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)
+
diff --git a/docs/v2/core/models/FilterBinaryTypeDict.md b/docs/v2/core/models/FilterBinaryTypeDict.md
@@ -0,0 +1,11 @@
+# FilterBinaryTypeDict
+
+FilterBinaryType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["binary"] | 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)
diff --git a/docs/v2/core/models/FilterBooleanTypeDict.md b/docs/v2/core/models/FilterBooleanTypeDict.md
@@ -0,0 +1,11 @@
+# FilterBooleanTypeDict
+
+FilterBooleanType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["boolean"] | 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)
diff --git a/docs/v2/core/models/FilterDateTimeTypeDict.md b/docs/v2/core/models/FilterDateTimeTypeDict.md
@@ -0,0 +1,11 @@
+# FilterDateTimeTypeDict
+
+FilterDateTimeType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["dateTime"] | 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)
diff --git a/docs/v2/core/models/FilterDateTypeDict.md b/docs/v2/core/models/FilterDateTypeDict.md
@@ -0,0 +1,11 @@
+# FilterDateTypeDict
+
+FilterDateType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["date"] | 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)
diff --git a/docs/v2/core/models/FilterDoubleTypeDict.md b/docs/v2/core/models/FilterDoubleTypeDict.md
@@ -0,0 +1,11 @@
+# FilterDoubleTypeDict
+
+FilterDoubleType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["double"] | 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)
diff --git a/docs/v2/core/models/FilterEnumTypeDict.md b/docs/v2/core/models/FilterEnumTypeDict.md
@@ -0,0 +1,12 @@
+# FilterEnumTypeDict
+
+FilterEnumType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**values** | List[str] | Yes | The values allowed by the enum type. |
+**type** | Literal["enum"] | 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)
diff --git a/docs/v2/core/models/FilterFloatTypeDict.md b/docs/v2/core/models/FilterFloatTypeDict.md
@@ -0,0 +1,11 @@
+# FilterFloatTypeDict
+
+FilterFloatType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["float"] | 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)
diff --git a/docs/v2/core/models/FilterIntegerTypeDict.md b/docs/v2/core/models/FilterIntegerTypeDict.md
@@ -0,0 +1,11 @@
+# FilterIntegerTypeDict
+
+FilterIntegerType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["integer"] | 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)
diff --git a/docs/v2/core/models/FilterLongTypeDict.md b/docs/v2/core/models/FilterLongTypeDict.md
@@ -0,0 +1,11 @@
+# FilterLongTypeDict
+
+FilterLongType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["long"] | 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)
diff --git a/docs/v2/core/models/FilterRidTypeDict.md b/docs/v2/core/models/FilterRidTypeDict.md
@@ -0,0 +1,11 @@
+# FilterRidTypeDict
+
+FilterRidType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["rid"] | 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)
diff --git a/docs/v2/core/models/FilterStringTypeDict.md b/docs/v2/core/models/FilterStringTypeDict.md
@@ -0,0 +1,11 @@
+# FilterStringTypeDict
+
+FilterStringType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["string"] | 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)
diff --git a/docs/v2/core/models/FilterTypeDict.md b/docs/v2/core/models/FilterTypeDict.md
@@ -0,0 +1,26 @@
+# FilterTypeDict
+
+FilterType
+
+This is a discriminator type and does not contain any fields. Instead, it is a union
+of of the models listed below.
+
+This discriminator class uses the `type` field to differentiate between classes.
+
+| Class | Value
+| ------------ | -------------
+FilterDateTimeTypeDict | dateTime
+FilterDateTypeDict | date
+FilterBooleanTypeDict | boolean
+FilterStringTypeDict | string
+FilterDoubleTypeDict | double
+FilterBinaryTypeDict | binary
+FilterIntegerTypeDict | integer
+FilterFloatTypeDict | float
+FilterRidTypeDict | rid
+FilterUuidTypeDict | uuid
+FilterEnumTypeDict | enum
+FilterLongTypeDict | long
+
+
+[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
diff --git a/docs/v2/core/models/FilterUuidTypeDict.md b/docs/v2/core/models/FilterUuidTypeDict.md
@@ -0,0 +1,11 @@
+# FilterUuidTypeDict
+
+FilterUuidType
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**type** | Literal["uuid"] | 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)
diff --git a/docs/v2/core/models/OrderByDirection.md b/docs/v2/core/models/OrderByDirection.md
@@ -0,0 +1,11 @@
+# OrderByDirection
+
+Specifies the ordering direction (can be either `ASC` or `DESC`)
+
+| **Value** |
+| --------- |
+| `"ASC"` |
+| `"DESC"` |
+
+
+[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
diff --git a/docs/v2/orchestration/models/GetBuildsBatchRequestElementDict.md b/docs/v2/orchestration/models/GetBuildsBatchRequestElementDict.md
@@ -0,0 +1,11 @@
+# GetBuildsBatchRequestElementDict
+
+GetBuildsBatchRequestElement
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**buildRid** | BuildRid | Yes | The RID of a build. |
+
+
+[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)