Skip to content

Commit

Permalink
Excavator: Upgrade API Version (#113)
Browse files Browse the repository at this point in the history
  • Loading branch information
svc-excavator-bot authored Jan 31, 2025
1 parent 6193f81 commit 8b4a5a9
Show file tree
Hide file tree
Showing 39 changed files with 1,390 additions and 5 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,14 @@ Namespace | Resource | Operation | HTTP request |
**Admin** | GroupMember | [**remove**](docs/v2/Admin/GroupMember.md#remove) | **POST** /v2/admin/groups/{groupId}/groupMembers/remove |
**Admin** | GroupMembership | [**list**](docs/v2/Admin/GroupMembership.md#list) | **GET** /v2/admin/users/{userId}/groupMemberships |
**Admin** | GroupMembership | [**page**](docs/v2/Admin/GroupMembership.md#page) | **GET** /v2/admin/users/{userId}/groupMemberships |
**Admin** | Marking | [**create**](docs/v2/Admin/Marking.md#create) | **POST** /v2/admin/markings |
**Admin** | Marking | [**get**](docs/v2/Admin/Marking.md#get) | **GET** /v2/admin/markings/{markingId} |
**Admin** | Marking | [**get_batch**](docs/v2/Admin/Marking.md#get_batch) | **POST** /v2/admin/markings/getBatch |
**Admin** | Marking | [**list**](docs/v2/Admin/Marking.md#list) | **GET** /v2/admin/markings |
**Admin** | Marking | [**page**](docs/v2/Admin/Marking.md#page) | **GET** /v2/admin/markings |
**Admin** | MarkingCategory | [**get**](docs/v2/Admin/MarkingCategory.md#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} |
**Admin** | MarkingCategory | [**list**](docs/v2/Admin/MarkingCategory.md#list) | **GET** /v2/admin/markingCategories |
**Admin** | MarkingCategory | [**page**](docs/v2/Admin/MarkingCategory.md#page) | **GET** /v2/admin/markingCategories |
**Admin** | MarkingMember | [**add**](docs/v2/Admin/MarkingMember.md#add) | **POST** /v2/admin/markings/{markingId}/markingMembers/add |
**Admin** | MarkingMember | [**list**](docs/v2/Admin/MarkingMember.md#list) | **GET** /v2/admin/markings/{markingId}/markingMembers |
**Admin** | MarkingMember | [**page**](docs/v2/Admin/MarkingMember.md#page) | **GET** /v2/admin/markings/{markingId}/markingMembers |
Expand All @@ -422,6 +430,7 @@ Namespace | Resource | Operation | HTTP request |
**Admin** | User | [**get**](docs/v2/Admin/User.md#get) | **GET** /v2/admin/users/{userId} |
**Admin** | User | [**get_batch**](docs/v2/Admin/User.md#get_batch) | **POST** /v2/admin/users/getBatch |
**Admin** | User | [**get_current**](docs/v2/Admin/User.md#get_current) | **GET** /v2/admin/users/getCurrent |
**Admin** | User | [**get_markings**](docs/v2/Admin/User.md#get_markings) | **GET** /v2/admin/users/{userId}/getMarkings |
**Admin** | User | [**list**](docs/v2/Admin/User.md#list) | **GET** /v2/admin/users |
**Admin** | User | [**page**](docs/v2/Admin/User.md#page) | **GET** /v2/admin/users |
**Admin** | User | [**profile_picture**](docs/v2/Admin/User.md#profile_picture) | **GET** /v2/admin/users/{userId}/profilePicture |
Expand Down Expand Up @@ -739,6 +748,8 @@ Namespace | Resource | Operation | HTTP request |
- [AsSecretNameDict](docs/v2/models/AsSecretNameDict.md)
- [AwsAccessKey](docs/v2/models/AwsAccessKey.md)
- [AwsAccessKeyDict](docs/v2/models/AwsAccessKeyDict.md)
- [BasicCredentials](docs/v2/models/BasicCredentials.md)
- [BasicCredentialsDict](docs/v2/models/BasicCredentialsDict.md)
- [CloudIdentity](docs/v2/models/CloudIdentity.md)
- [CloudIdentityDict](docs/v2/models/CloudIdentityDict.md)
- [CloudIdentityRid](docs/v2/models/CloudIdentityRid.md)
Expand Down Expand Up @@ -808,13 +819,21 @@ Namespace | Resource | Operation | HTTP request |
- [PlaintextValue](docs/v2/models/PlaintextValue.md)
- [PostgreSqlImportConfig](docs/v2/models/PostgreSqlImportConfig.md)
- [PostgreSqlImportConfigDict](docs/v2/models/PostgreSqlImportConfigDict.md)
- [Protocol](docs/v2/models/Protocol.md)
- [Region](docs/v2/models/Region.md)
- [RuntimePlatform](docs/v2/models/RuntimePlatform.md)
- [RuntimePlatformDict](docs/v2/models/RuntimePlatformDict.md)
- [S3AuthenticationMode](docs/v2/models/S3AuthenticationMode.md)
- [S3AuthenticationModeDict](docs/v2/models/S3AuthenticationModeDict.md)
- [S3ConnectionConfiguration](docs/v2/models/S3ConnectionConfiguration.md)
- [S3ConnectionConfigurationDict](docs/v2/models/S3ConnectionConfigurationDict.md)
- [S3KmsConfiguration](docs/v2/models/S3KmsConfiguration.md)
- [S3KmsConfigurationDict](docs/v2/models/S3KmsConfigurationDict.md)
- [S3ProxyConfiguration](docs/v2/models/S3ProxyConfiguration.md)
- [S3ProxyConfigurationDict](docs/v2/models/S3ProxyConfigurationDict.md)
- [SecretName](docs/v2/models/SecretName.md)
- [StsRoleConfiguration](docs/v2/models/StsRoleConfiguration.md)
- [StsRoleConfigurationDict](docs/v2/models/StsRoleConfigurationDict.md)
- [TableImport](docs/v2/models/TableImport.md)
- [TableImportAllowSchemaChanges](docs/v2/models/TableImportAllowSchemaChanges.md)
- [TableImportConfig](docs/v2/models/TableImportConfig.md)
Expand Down
82 changes: 82 additions & 0 deletions docs/v2/Admin/Marking.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,86 @@

Method | HTTP request |
------------- | ------------- |
[**create**](#create) | **POST** /v2/admin/markings |
[**get**](#get) | **GET** /v2/admin/markings/{markingId} |
[**get_batch**](#get_batch) | **POST** /v2/admin/markings/getBatch |
[**list**](#list) | **GET** /v2/admin/markings |
[**page**](#page) | **GET** /v2/admin/markings |

# **create**
Creates a new Marking.

### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**category_id** | MarkingCategoryId | | |
**initial_members** | List[PrincipalId] | Users and Groups that will be able to view resources protected by this Marking. This can be changed later through the MarkingMember operations. | |
**initial_role_assignments** | List[MarkingRoleUpdateDict] | The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. | |
**name** | MarkingName | | |
**description** | Optional[str] | | [optional] |
**preview** | Optional[PreviewMode] | preview | [optional] |

### Return type
**Marking**

### Example

```python
from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# MarkingCategoryId |
category_id = "0950264e-01c8-4e83-81a9-1a6b7f77621a"
# List[PrincipalId] | Users and Groups that will be able to view resources protected by this Marking. This can be changed later through the MarkingMember operations.
initial_members = ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]
# List[MarkingRoleUpdateDict] | The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer.
initial_role_assignments = [
{"role": "ADMINISTER", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}
]
# MarkingName |
name = "PII"
# Optional[str] |
description = "Contains personally identifiable information about our customers"
# Optional[PreviewMode] | preview
preview = None


try:
api_response = foundry_client.admin.Marking.create(
category_id=category_id,
initial_members=initial_members,
initial_role_assignments=initial_role_assignments,
name=name,
description=description,
preview=preview,
)
print("The create response:\n")
pprint(api_response)
except foundry.PalantirRPCException as e:
print("HTTP error when calling Marking.create: %s\n" % e)

```



### Authorization

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

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | Marking | The created Marking | 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 Marking with the specified id.

### Parameters
Expand Down Expand Up @@ -57,6 +136,7 @@ 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 Marking.

The maximum batch size for this endpoint is 500.
Expand Down Expand Up @@ -113,6 +193,7 @@ 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)

# **list**
Maximum page size 100.

### Parameters
Expand Down Expand Up @@ -170,6 +251,7 @@ 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)

# **page**
Maximum page size 100.

### Parameters
Expand Down
6 changes: 6 additions & 0 deletions docs/v2/Admin/MarkingCategory.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

Method | HTTP request |
------------- | ------------- |
[**get**](#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} |
[**list**](#list) | **GET** /v2/admin/markingCategories |
[**page**](#page) | **GET** /v2/admin/markingCategories |

# **get**
Get the MarkingCategory with the specified id.

### Parameters
Expand Down Expand Up @@ -57,6 +61,7 @@ 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)

# **list**
Maximum page size 100.

### Parameters
Expand Down Expand Up @@ -114,6 +119,7 @@ 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)

# **page**
Maximum page size 100.

### Parameters
Expand Down
2 changes: 2 additions & 0 deletions docs/v2/Admin/User.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request |
[**get**](#get) | **GET** /v2/admin/users/{userId} |
[**get_batch**](#get_batch) | **POST** /v2/admin/users/getBatch |
[**get_current**](#get_current) | **GET** /v2/admin/users/getCurrent |
[**get_markings**](#get_markings) | **GET** /v2/admin/users/{userId}/getMarkings |
[**list**](#list) | **GET** /v2/admin/users |
[**page**](#page) | **GET** /v2/admin/users |
[**profile_picture**](#profile_picture) | **GET** /v2/admin/users/{userId}/profilePicture |
Expand Down Expand Up @@ -211,6 +212,7 @@ 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_markings**
Retrieve Markings that the user is currently a member of.

### Parameters
Expand Down
12 changes: 12 additions & 0 deletions docs/v2/connectivity/models/BasicCredentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# BasicCredentials

BasicCredentials

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**username** | str | Yes | |
**password** | EncryptedProperty | Yes | |


[[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/connectivity/models/BasicCredentialsDict.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# BasicCredentialsDict

BasicCredentials

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**username** | str | Yes | |
**password** | EncryptedPropertyDict | Yes | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,20 @@ CreateConnectionRequestS3ConnectionConfiguration
## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**connectionTimeoutMillis** | NotRequired[Long] | No | The amount of time (in milliseconds) to wait when initially establishing a connection before giving up and timing out. If not specified, defaults to 10000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_CONNECTION_TIMEOUT). |
**maxErrorRetry** | NotRequired[int] | No | The maximum number of retry attempts for failed requests to the S3 service. If not specified, defaults to 3 as defined by the [AWS SDK default](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/retry-strategy.html#retry-strategies). |
**bucketUrl** | str | Yes | The URL of the S3 bucket. The URL should contain a trailing slash. |
**clientKmsConfiguration** | NotRequired[S3KmsConfigurationDict] | No | The client-side KMS key to use for encryption and decryption of data in the S3 bucket. If not specified, the default KMS key for the bucket is used. |
**matchSubfolderExactly** | NotRequired[bool] | No | If true, only files in the subfolder specified in the bucket URL will be synced. If false, all files in the bucket will be synced. If not specified, defaults to false. |
**stsRoleConfiguration** | NotRequired[StsRoleConfigurationDict] | No | The configuration needed to assume a role to connect to the S3 external system. |
**s3Endpoint** | NotRequired[str] | No | The endpoint of the S3 service. This is used to connect to a custom S3 service that is not AWS S3. If not specified, defaults to the [AWS S3 endpoint](https://docs.aws.amazon.com/general/latest/gr/s3.html). Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. |
**socketTimeoutMillis** | NotRequired[Long] | No | The amount of time (in milliseconds) to wait for data to be transferred over an established, open connection. If not specified, defaults to 50000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_SOCKET_TIMEOUT). |
**enableRequesterPays** | NotRequired[bool] | No | Defaults to false, unless set and overwritten. If true, includes the [requester pays header](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html) in requests, allowing reads from requester pays buckets. |
**s3EndpointSigningRegion** | NotRequired[Region] | No | The region used when constructing the S3 client using a custom endpoint. This is often not required and would only be needed if you are using the S3 connector with an S3-compliant third-party API, and are also setting a custom endpoint that requires a non-default region. |
**region** | NotRequired[Region] | No | The region representing the location of the S3 bucket. Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. |
**authenticationMode** | NotRequired[S3AuthenticationModeDict] | No | The authentication mode to use to connect to the S3 external system. No authentication mode is required to connect to publicly accessible AWS S3 buckets. |
**proxyConfiguration** | NotRequired[S3ProxyConfigurationDict] | No | The configuration needed to connect to the S3 external system through a proxy. |
**maxConnections** | NotRequired[int] | No | The maximum number of HTTP connections to the S3 service per sync. If not specified, defaults to 50 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_MAX_CONNECTIONS). |
**type** | Literal["s3"] | Yes | None |


Expand Down
11 changes: 11 additions & 0 deletions docs/v2/connectivity/models/Protocol.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Protocol

Protocol to establish a connection with another system.

| **Value** |
| --------- |
| `"HTTP"` |
| `"HTTPS"` |


[[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/connectivity/models/Region.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Region

The region of the external system.


## Type
```python
str
```


[[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/connectivity/models/S3ConnectionConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,19 @@ implement the s3a protocol)](/docs/foundry/available-connectors/amazon-s3/#amazo
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**bucket_url** | str | Yes | The URL of the S3 bucket. The URL should contain a trailing slash. |
**s3_endpoint** | Optional[str] | No | The endpoint of the S3 service. This is used to connect to a custom S3 service that is not AWS S3. If not specified, defaults to the [AWS S3 endpoint](https://docs.aws.amazon.com/general/latest/gr/s3.html). Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. |
**region** | Optional[Region] | No | The region representing the location of the S3 bucket. Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. |
**authentication_mode** | Optional[S3AuthenticationMode] | No | The authentication mode to use to connect to the S3 external system. No authentication mode is required to connect to publicly accessible AWS S3 buckets. |
**s3_endpoint_signing_region** | Optional[Region] | No | The region used when constructing the S3 client using a custom endpoint. This is often not required and would only be needed if you are using the S3 connector with an S3-compliant third-party API, and are also setting a custom endpoint that requires a non-default region. |
**client_kms_configuration** | Optional[S3KmsConfiguration] | No | The client-side KMS key to use for encryption and decryption of data in the S3 bucket. If not specified, the default KMS key for the bucket is used. |
**sts_role_configuration** | Optional[StsRoleConfiguration] | No | The configuration needed to assume a role to connect to the S3 external system. |
**proxy_configuration** | Optional[S3ProxyConfiguration] | No | The configuration needed to connect to the S3 external system through a proxy. |
**max_connections** | Optional[int] | No | The maximum number of HTTP connections to the S3 service per sync. If not specified, defaults to 50 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_MAX_CONNECTIONS). |
**connection_timeout_millis** | Optional[Long] | No | The amount of time (in milliseconds) to wait when initially establishing a connection before giving up and timing out. If not specified, defaults to 10000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_CONNECTION_TIMEOUT). |
**socket_timeout_millis** | Optional[Long] | No | The amount of time (in milliseconds) to wait for data to be transferred over an established, open connection. If not specified, defaults to 50000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_SOCKET_TIMEOUT). |
**max_error_retry** | Optional[int] | No | The maximum number of retry attempts for failed requests to the S3 service. If not specified, defaults to 3 as defined by the [AWS SDK default](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/retry-strategy.html#retry-strategies). |
**match_subfolder_exactly** | Optional[bool] | No | If true, only files in the subfolder specified in the bucket URL will be synced. If false, all files in the bucket will be synced. If not specified, defaults to false. |
**enable_requester_pays** | Optional[bool] | No | Defaults to false, unless set and overwritten. If true, includes the [requester pays header](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html) in requests, allowing reads from requester pays buckets. |
**type** | Literal["s3"] | Yes | None |


Expand Down
Loading

0 comments on commit 8b4a5a9

Please sign in to comment.