diff --git a/README.md b/README.md index 16ecad23..f60c879b 100644 --- a/README.md +++ b/README.md @@ -1813,6 +1813,9 @@ Namespace | Name | Import | **Ontologies** | [BoundingBoxValue](docs/v2/Ontologies/models/BoundingBoxValue.md) | `from foundry_sdk.v2.ontologies.models import BoundingBoxValue` | **Ontologies** | [CenterPoint](docs/v2/Ontologies/models/CenterPoint.md) | `from foundry_sdk.v2.ontologies.models import CenterPoint` | **Ontologies** | [CenterPointTypes](docs/v2/Ontologies/models/CenterPointTypes.md) | `from foundry_sdk.v2.ontologies.models import CenterPointTypes` | +**Ontologies** | [ConjunctiveMarkingSummary](docs/v2/Ontologies/models/ConjunctiveMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import ConjunctiveMarkingSummary` | +**Ontologies** | [ContainerConjunctiveMarkingSummary](docs/v2/Ontologies/models/ContainerConjunctiveMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import ContainerConjunctiveMarkingSummary` | +**Ontologies** | [ContainerDisjunctiveMarkingSummary](docs/v2/Ontologies/models/ContainerDisjunctiveMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import ContainerDisjunctiveMarkingSummary` | **Ontologies** | [ContainsAllTermsInOrderPrefixLastTerm](docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTerm.md) | `from foundry_sdk.v2.ontologies.models import ContainsAllTermsInOrderPrefixLastTerm` | **Ontologies** | [ContainsAllTermsInOrderQuery](docs/v2/Ontologies/models/ContainsAllTermsInOrderQuery.md) | `from foundry_sdk.v2.ontologies.models import ContainsAllTermsInOrderQuery` | **Ontologies** | [ContainsAllTermsQuery](docs/v2/Ontologies/models/ContainsAllTermsQuery.md) | `from foundry_sdk.v2.ontologies.models import ContainsAllTermsQuery` | @@ -1855,6 +1858,7 @@ Namespace | Name | Import | **Ontologies** | [DeprecatedPropertyTypeStatus](docs/v2/Ontologies/models/DeprecatedPropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import DeprecatedPropertyTypeStatus` | **Ontologies** | [DerivedPropertyApiName](docs/v2/Ontologies/models/DerivedPropertyApiName.md) | `from foundry_sdk.v2.ontologies.models import DerivedPropertyApiName` | **Ontologies** | [DerivedPropertyDefinition](docs/v2/Ontologies/models/DerivedPropertyDefinition.md) | `from foundry_sdk.v2.ontologies.models import DerivedPropertyDefinition` | +**Ontologies** | [DisjunctiveMarkingSummary](docs/v2/Ontologies/models/DisjunctiveMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import DisjunctiveMarkingSummary` | **Ontologies** | [DividePropertyExpression](docs/v2/Ontologies/models/DividePropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import DividePropertyExpression` | **Ontologies** | [DoesNotIntersectBoundingBoxQuery](docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQuery.md) | `from foundry_sdk.v2.ontologies.models import DoesNotIntersectBoundingBoxQuery` | **Ontologies** | [DoesNotIntersectPolygonQuery](docs/v2/Ontologies/models/DoesNotIntersectPolygonQuery.md) | `from foundry_sdk.v2.ontologies.models import DoesNotIntersectPolygonQuery` | @@ -1865,6 +1869,7 @@ Namespace | Name | Import | **Ontologies** | [EntrySetType](docs/v2/Ontologies/models/EntrySetType.md) | `from foundry_sdk.v2.ontologies.models import EntrySetType` | **Ontologies** | [EnumConstraint](docs/v2/Ontologies/models/EnumConstraint.md) | `from foundry_sdk.v2.ontologies.models import EnumConstraint` | **Ontologies** | [EqualsQueryV2](docs/v2/Ontologies/models/EqualsQueryV2.md) | `from foundry_sdk.v2.ontologies.models import EqualsQueryV2` | +**Ontologies** | [ErrorComputingSecurity](docs/v2/Ontologies/models/ErrorComputingSecurity.md) | `from foundry_sdk.v2.ontologies.models import ErrorComputingSecurity` | **Ontologies** | [ExactDistinctAggregationV2](docs/v2/Ontologies/models/ExactDistinctAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import ExactDistinctAggregationV2` | **Ontologies** | [ExamplePropertyTypeStatus](docs/v2/Ontologies/models/ExamplePropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import ExamplePropertyTypeStatus` | **Ontologies** | [ExecuteQueryRequest](docs/v2/Ontologies/models/ExecuteQueryRequest.md) | `from foundry_sdk.v2.ontologies.models import ExecuteQueryRequest` | @@ -1957,6 +1962,7 @@ Namespace | Name | Import | **Ontologies** | [LogicRuleArgument](docs/v2/Ontologies/models/LogicRuleArgument.md) | `from foundry_sdk.v2.ontologies.models import LogicRuleArgument` | **Ontologies** | [LteQueryV2](docs/v2/Ontologies/models/LteQueryV2.md) | `from foundry_sdk.v2.ontologies.models import LteQueryV2` | **Ontologies** | [LtQueryV2](docs/v2/Ontologies/models/LtQueryV2.md) | `from foundry_sdk.v2.ontologies.models import LtQueryV2` | +**Ontologies** | [MarkingId](docs/v2/Ontologies/models/MarkingId.md) | `from foundry_sdk.v2.ontologies.models import MarkingId` | **Ontologies** | [MatchRule](docs/v2/Ontologies/models/MatchRule.md) | `from foundry_sdk.v2.ontologies.models import MatchRule` | **Ontologies** | [MaxAggregationV2](docs/v2/Ontologies/models/MaxAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import MaxAggregationV2` | **Ontologies** | [MediaMetadata](docs/v2/Ontologies/models/MediaMetadata.md) | `from foundry_sdk.v2.ontologies.models import MediaMetadata` | @@ -2071,9 +2077,12 @@ Namespace | Name | Import | **Ontologies** | [PropertyImplementation](docs/v2/Ontologies/models/PropertyImplementation.md) | `from foundry_sdk.v2.ontologies.models import PropertyImplementation` | **Ontologies** | [PropertyKnownTypeFormattingRule](docs/v2/Ontologies/models/PropertyKnownTypeFormattingRule.md) | `from foundry_sdk.v2.ontologies.models import PropertyKnownTypeFormattingRule` | **Ontologies** | [PropertyLoadLevel](docs/v2/Ontologies/models/PropertyLoadLevel.md) | `from foundry_sdk.v2.ontologies.models import PropertyLoadLevel` | +**Ontologies** | [PropertyMarkingSummary](docs/v2/Ontologies/models/PropertyMarkingSummary.md) | `from foundry_sdk.v2.ontologies.models import PropertyMarkingSummary` | **Ontologies** | [PropertyNumberFormattingRule](docs/v2/Ontologies/models/PropertyNumberFormattingRule.md) | `from foundry_sdk.v2.ontologies.models import PropertyNumberFormattingRule` | **Ontologies** | [PropertyNumberFormattingRuleType](docs/v2/Ontologies/models/PropertyNumberFormattingRuleType.md) | `from foundry_sdk.v2.ontologies.models import PropertyNumberFormattingRuleType` | **Ontologies** | [PropertyOrStructFieldOfPropertyImplementation](docs/v2/Ontologies/models/PropertyOrStructFieldOfPropertyImplementation.md) | `from foundry_sdk.v2.ontologies.models import PropertyOrStructFieldOfPropertyImplementation` | +**Ontologies** | [PropertySecurities](docs/v2/Ontologies/models/PropertySecurities.md) | `from foundry_sdk.v2.ontologies.models import PropertySecurities` | +**Ontologies** | [PropertySecurity](docs/v2/Ontologies/models/PropertySecurity.md) | `from foundry_sdk.v2.ontologies.models import PropertySecurity` | **Ontologies** | [PropertyTimestampFormattingRule](docs/v2/Ontologies/models/PropertyTimestampFormattingRule.md) | `from foundry_sdk.v2.ontologies.models import PropertyTimestampFormattingRule` | **Ontologies** | [PropertyTypeApiName](docs/v2/Ontologies/models/PropertyTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeApiName` | **Ontologies** | [PropertyTypeReference](docs/v2/Ontologies/models/PropertyTypeReference.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeReference` | @@ -2192,6 +2201,7 @@ Namespace | Name | Import | **Ontologies** | [UniqueIdentifierArgument](docs/v2/Ontologies/models/UniqueIdentifierArgument.md) | `from foundry_sdk.v2.ontologies.models import UniqueIdentifierArgument` | **Ontologies** | [UniqueIdentifierLinkId](docs/v2/Ontologies/models/UniqueIdentifierLinkId.md) | `from foundry_sdk.v2.ontologies.models import UniqueIdentifierLinkId` | **Ontologies** | [UniqueIdentifierValue](docs/v2/Ontologies/models/UniqueIdentifierValue.md) | `from foundry_sdk.v2.ontologies.models import UniqueIdentifierValue` | +**Ontologies** | [UnsupportedPolicy](docs/v2/Ontologies/models/UnsupportedPolicy.md) | `from foundry_sdk.v2.ontologies.models import UnsupportedPolicy` | **Ontologies** | [UuidConstraint](docs/v2/Ontologies/models/UuidConstraint.md) | `from foundry_sdk.v2.ontologies.models import UuidConstraint` | **Ontologies** | [ValidateActionResponseV2](docs/v2/Ontologies/models/ValidateActionResponseV2.md) | `from foundry_sdk.v2.ontologies.models import ValidateActionResponseV2` | **Ontologies** | [ValidationResult](docs/v2/Ontologies/models/ValidationResult.md) | `from foundry_sdk.v2.ontologies.models import ValidationResult` | diff --git a/docs-snippets-npm/package.json b/docs-snippets-npm/package.json index 16cac557..3a20c479 100644 --- a/docs-snippets-npm/package.json +++ b/docs-snippets-npm/package.json @@ -24,7 +24,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1416.1", + "minVersion": "1.1422.0", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index 8ef7ac4c..b8067731 100644 --- a/docs-snippets-npm/src/index.ts +++ b/docs-snippets-npm/src/index.ts @@ -1390,7 +1390,7 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets value | {"firstName": "Alex", "lastName": "Karp"} | diff --git a/docs/v2/Datasets/models/ViewBackingDataset.md b/docs/v2/Datasets/models/ViewBackingDataset.md index 5ce3b00c..a7884def 100644 --- a/docs/v2/Datasets/models/ViewBackingDataset.md +++ b/docs/v2/Datasets/models/ViewBackingDataset.md @@ -5,7 +5,7 @@ One of the Datasets backing a View. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**branch** | BranchName | Yes | | +**branch** | Optional[BranchName] | No | The branch of the backing dataset. If not specified, defaults to the branch of the View. | **dataset_rid** | DatasetRid | Yes | | diff --git a/docs/v2/Ontologies/OntologyObject.md b/docs/v2/Ontologies/OntologyObject.md index 4af9f644..cc22a8d1 100644 --- a/docs/v2/Ontologies/OntologyObject.md +++ b/docs/v2/Ontologies/OntologyObject.md @@ -373,21 +373,21 @@ Partial terms are not matched by terms filters except where explicitly noted. ### Parameters -Name | Type | Description | Notes | -------------- |------------------------------------| ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**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**. | | -**select** | List[PropertyApiName] | The API names of the object type properties to include in the response. | | -**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. | | -**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] | -**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] | -**order_by** | Optional[SearchOrderByV2] | | [optional] | -**page_size** | Optional[PageSize] | | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | -**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] | -**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] | -**where** | Optional[SearchJsonQueryV2] | | [optional] | +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | | | +**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**. | | +**select** | List[PropertyApiName] | The API names of the object type properties to include in the response. | | +**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | +**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] | +**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] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | +**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] | +**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] | +**where** | Optional[SearchJsonQueryV2] | | [optional] | ### Return type **SearchObjectsResponseV2** diff --git a/docs/v2/Ontologies/OntologyObjectSet.md b/docs/v2/Ontologies/OntologyObjectSet.md index 848a09a1..0030873e 100644 --- a/docs/v2/Ontologies/OntologyObjectSet.md +++ b/docs/v2/Ontologies/OntologyObjectSet.md @@ -116,6 +116,7 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | | | **object_set** | ObjectSet | | | +**branch** | 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. | [optional] | **sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | **sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | @@ -135,6 +136,8 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa ontology = "palantir" # ObjectSet object_set = {"type": "base", "objectType": "Employee"} +# 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. +branch = None # Optional[SdkPackageRid] | The package rid of the generated SDK. sdk_package_rid = None # Optional[SdkVersion] | The package version of the generated SDK. @@ -143,7 +146,11 @@ sdk_version = None try: api_response = client.ontologies.OntologyObjectSet.create_temporary( - ontology, object_set=object_set, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version + ontology, + object_set=object_set, + branch=branch, + sdk_package_rid=sdk_package_rid, + sdk_version=sdk_version, ) print("The create_temporary response:\n") pprint(api_response) @@ -229,22 +236,23 @@ Vector properties will not be returned unless included in the `select` parameter ### Parameters -Name | Type | Description | Notes | -------------- |------------------------------------| ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**object_set** | ObjectSet | | | -**select** | List[SelectedPropertyApiName] | | | -**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. | | -**branch** | Optional[FoundryBranch] | The Foundry branch to load the object set from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] | -**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] | -**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | -**order_by** | Optional[SearchOrderByV2] | | [optional] | -**page_size** | Optional[PageSize] | | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | -**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | -**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] | -**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. | [optional] | +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | | | +**object_set** | ObjectSet | | | +**select** | List[SelectedPropertyApiName] | | | +**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | +**branch** | Optional[FoundryBranch] | The Foundry branch to load the object set from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] | +**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] | +**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | +**load_property_securities** | Optional[bool] | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. | [optional] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | +**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | +**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] | +**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] | ### Return type **LoadObjectSetResponseV2** @@ -272,6 +280,8 @@ branch = None exclude_rid = None # Optional[IncludeComputeUsage] include_compute_usage = None +# Optional[bool] | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. +load_property_securities = None # Optional[SearchOrderByV2] order_by = None # Optional[PageSize] @@ -297,6 +307,7 @@ try: branch=branch, exclude_rid=exclude_rid, include_compute_usage=include_compute_usage, + load_property_securities=load_property_securities, order_by=order_by, page_size=page_size, page_token=page_token, @@ -438,23 +449,24 @@ Vector properties will not be returned unless included in the `select` parameter ### Parameters -Name | Type | Description | Notes | -------------- |------------------------------------| ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**object_set** | ObjectSet | | | -**select** | List[SelectedPropertyApiName] | | | -**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. | | -**branch** | Optional[FoundryBranch] | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] | -**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] | -**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | -**order_by** | Optional[SearchOrderByV2] | | [optional] | -**page_size** | Optional[PageSize] | | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | -**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | -**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | -**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] | -**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. | [optional] | +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | | | +**object_set** | ObjectSet | | | +**select** | List[SelectedPropertyApiName] | | | +**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | +**branch** | Optional[FoundryBranch] | The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. | [optional] | +**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] | +**include_compute_usage** | Optional[IncludeComputeUsage] | | [optional] | +**load_property_securities** | Optional[bool] | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. | [optional] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | +**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | +**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | +**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] | +**transaction_id** | Optional[OntologyTransactionId] | The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] | ### Return type **LoadObjectSetV2MultipleObjectTypesResponse** @@ -482,6 +494,8 @@ branch = None exclude_rid = None # Optional[IncludeComputeUsage] include_compute_usage = None +# Optional[bool] | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. +load_property_securities = None # Optional[SearchOrderByV2] order_by = None # Optional[PageSize] @@ -509,6 +523,7 @@ try: branch=branch, exclude_rid=exclude_rid, include_compute_usage=include_compute_usage, + load_property_securities=load_property_securities, order_by=order_by, page_size=page_size, page_token=page_token, @@ -558,21 +573,21 @@ Vector properties will not be returned unless included in the `select` parameter ### Parameters -Name | Type | Description | Notes | -------------- |------------------------------------| ------------- | ------------- | -**ontology** | OntologyIdentifier | | | -**object_set** | ObjectSet | | | -**select** | List[SelectedPropertyApiName] | | | -**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. | | -**branch** | 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. | [optional] | -**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] | -**order_by** | Optional[SearchOrderByV2] | | [optional] | -**page_size** | Optional[PageSize] | | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | -**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | -**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | -**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] | +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | | | +**object_set** | ObjectSet | | | +**select** | List[SelectedPropertyApiName] | | | +**select_v2** | List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | | +**branch** | 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. | [optional] | +**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] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | +**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] | +**sdk_version** | Optional[SdkVersion] | The package version of the generated SDK. | [optional] | +**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] | ### Return type **LoadObjectSetV2ObjectsOrInterfacesResponse** @@ -589,7 +604,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyIdentifier ontology = "palantir" # ObjectSet -object_set = {"type": "base", "interfaceBase": "Person"} +object_set = {"type": "interfaceBase", "interfaceType": "Person"} # List[SelectedPropertyApiName] select = None # List[PropertyIdentifier] | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. diff --git a/docs/v2/Ontologies/models/ConjunctiveMarkingSummary.md b/docs/v2/Ontologies/models/ConjunctiveMarkingSummary.md new file mode 100644 index 00000000..f901bc6e --- /dev/null +++ b/docs/v2/Ontologies/models/ConjunctiveMarkingSummary.md @@ -0,0 +1,13 @@ +# ConjunctiveMarkingSummary + +The conjunctive set of markings required to access the property value. +All markings from a conjunctive set must be met for access. + + +## Type +```python +List[MarkingId] +``` + + +[[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/Ontologies/models/ContainerConjunctiveMarkingSummary.md b/docs/v2/Ontologies/models/ContainerConjunctiveMarkingSummary.md new file mode 100644 index 00000000..4ba122dc --- /dev/null +++ b/docs/v2/Ontologies/models/ContainerConjunctiveMarkingSummary.md @@ -0,0 +1,16 @@ +# ContainerConjunctiveMarkingSummary + +The conjunctive set of markings for the container of this property value, +such as the project of a dataset. These markings may differ from the marking +on the actual property value, but still must be satisfied for accessing the property + +All markings from a conjunctive set must be met for access. + + +## Type +```python +List[MarkingId] +``` + + +[[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/Ontologies/models/ContainerDisjunctiveMarkingSummary.md b/docs/v2/Ontologies/models/ContainerDisjunctiveMarkingSummary.md new file mode 100644 index 00000000..16d5edcc --- /dev/null +++ b/docs/v2/Ontologies/models/ContainerDisjunctiveMarkingSummary.md @@ -0,0 +1,20 @@ +# ContainerDisjunctiveMarkingSummary + +The disjunctive set of markings for the container of this property value, +such as the project of a dataset. These markings may differ from the marking +on the actual property value, but still must be satisfied for accessing the property +All markings from a conjunctive set must be met for access. + +Disjunctive markings are represented as a conjunctive list of disjunctive sets. +The top-level set is a conjunction of sets, where each inner set should be +treated as a unit where any marking within the set can satisfy the set. +All sets within the top level set should be satisfied. + + +## Type +```python +List[List[MarkingId]] +``` + + +[[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/Ontologies/models/DisjunctiveMarkingSummary.md b/docs/v2/Ontologies/models/DisjunctiveMarkingSummary.md new file mode 100644 index 00000000..da80c5fb --- /dev/null +++ b/docs/v2/Ontologies/models/DisjunctiveMarkingSummary.md @@ -0,0 +1,16 @@ +# DisjunctiveMarkingSummary + +The disjunctive set of markings required to access the property value. +Disjunctive markings are represented as a conjunctive list of disjunctive sets. +The top-level set is a conjunction of sets, where each inner set should be +treated as a unit where any marking within the set can satisfy the set. +All sets within the top level set should be satisfied. + + +## Type +```python +List[List[MarkingId]] +``` + + +[[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/Ontologies/models/ErrorComputingSecurity.md b/docs/v2/Ontologies/models/ErrorComputingSecurity.md new file mode 100644 index 00000000..923a75be --- /dev/null +++ b/docs/v2/Ontologies/models/ErrorComputingSecurity.md @@ -0,0 +1,11 @@ +# ErrorComputingSecurity + +Indicates the server was not able to load the securities of the property. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["errorComputingSecurity"] | 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/Ontologies/models/InQuery.md b/docs/v2/Ontologies/models/InQuery.md index aaa3afc5..b3d88ebf 100644 --- a/docs/v2/Ontologies/models/InQuery.md +++ b/docs/v2/Ontologies/models/InQuery.md @@ -1,8 +1,8 @@ # InQuery Returns objects where the specified field equals any of the provided values. Allows you to -specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, -but not both. +specify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects +in the object set. Either `field` or `propertyIdentifier` must be supplied, but not both. ## Properties diff --git a/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md b/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md index d891f763..31acdc9e 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md +++ b/docs/v2/Ontologies/models/LoadObjectSetRequestV2.md @@ -3,17 +3,18 @@ Represents the API POST body when loading an `ObjectSet`. ## Properties -| Name | Type | Required | Description | -| ------------ |------------------------------------|----------| ------------- | -**object_set** | ObjectSet | Yes | | -**order_by** | Optional[SearchOrderByV2] | No | | -**select** | List[SelectedPropertyApiName] | Yes | | -**select_v2** | Optional[List[PropertyIdentifier]] | No | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | -**page_token** | Optional[PageToken] | No | | -**page_size** | Optional[PageSize] | No | | -**exclude_rid** | Optional[bool] | No | 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. | -**snapshot** | Optional[bool] | No | 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. | -**include_compute_usage** | Optional[IncludeComputeUsage] | No | | +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_set** | ObjectSet | Yes | | +**order_by** | Optional[SearchOrderByV2] | No | | +**select** | List[SelectedPropertyApiName] | Yes | | +**select_v2** | List[PropertyIdentifier] | Yes | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**page_token** | Optional[PageToken] | No | | +**page_size** | Optional[PageSize] | No | | +**exclude_rid** | Optional[bool] | No | 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. | +**load_property_securities** | Optional[bool] | No | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. | +**snapshot** | Optional[bool] | No | 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. | +**include_compute_usage** | Optional[IncludeComputeUsage] | No | | [[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/Ontologies/models/LoadObjectSetResponseV2.md b/docs/v2/Ontologies/models/LoadObjectSetResponseV2.md index 8934b4ab..70d4e608 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetResponseV2.md +++ b/docs/v2/Ontologies/models/LoadObjectSetResponseV2.md @@ -9,6 +9,7 @@ Represents the API response when loading an `ObjectSet`. **next_page_token** | Optional[PageToken] | No | | **total_count** | TotalCount | Yes | | **compute_usage** | Optional[ComputeSeconds] | No | | +**property_securities** | List[PropertySecurities] | Yes | | [[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/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md index af45d3ff..33102ec6 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md +++ b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesRequest.md @@ -4,17 +4,18 @@ Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObje ## Properties -| Name | Type | Required | Description | -| ------------ |------------------------------------|----------| ------------- | -**object_set** | ObjectSet | Yes | | -**order_by** | Optional[SearchOrderByV2] | No | | -**select** | List[SelectedPropertyApiName] | Yes | | -**select_v2** | Optional[List[PropertyIdentifier]] | No | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | -**page_token** | Optional[PageToken] | No | | -**page_size** | Optional[PageSize] | No | | -**exclude_rid** | Optional[bool] | No | 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. | -**snapshot** | Optional[bool] | No | 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. | -**include_compute_usage** | Optional[IncludeComputeUsage] | No | | +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_set** | ObjectSet | Yes | | +**order_by** | Optional[SearchOrderByV2] | No | | +**select** | List[SelectedPropertyApiName] | Yes | | +**select_v2** | List[PropertyIdentifier] | Yes | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**page_token** | Optional[PageToken] | No | | +**page_size** | Optional[PageSize] | No | | +**exclude_rid** | Optional[bool] | No | 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. | +**load_property_securities** | Optional[bool] | No | A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. | +**snapshot** | Optional[bool] | No | 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. | +**include_compute_usage** | Optional[IncludeComputeUsage] | No | | [[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/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md index 07481458..c42a21a8 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md +++ b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md @@ -23,6 +23,7 @@ implementations of both properties backed by SharedPropertyTypes as well as prop **interface_to_object_type_mappings** | Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappings] | Yes | | **interface_to_object_type_mappings_v2** | Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappingsV2] | Yes | | **compute_usage** | Optional[ComputeSeconds] | No | | +**property_securities** | List[PropertySecurities] | Yes | | [[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/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md b/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md index 580ea9a8..2335be3a 100644 --- a/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md +++ b/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesRequest.md @@ -4,16 +4,16 @@ Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObje ## Properties -| Name | Type | Required | Description | -| ------------ |------------------------------------|----------| ------------- | -**object_set** | ObjectSet | Yes | | -**order_by** | Optional[SearchOrderByV2] | No | | -**select** | List[SelectedPropertyApiName] | Yes | | -**select_v2** | Optional[List[PropertyIdentifier]] | No | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | -**page_token** | Optional[PageToken] | No | | -**page_size** | Optional[PageSize] | No | | -**exclude_rid** | Optional[bool] | No | 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. | -**snapshot** | Optional[bool] | No | 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. | +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_set** | ObjectSet | Yes | | +**order_by** | Optional[SearchOrderByV2] | No | | +**select** | List[SelectedPropertyApiName] | Yes | | +**select_v2** | List[PropertyIdentifier] | Yes | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**page_token** | Optional[PageToken] | No | | +**page_size** | Optional[PageSize] | No | | +**exclude_rid** | Optional[bool] | No | 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. | +**snapshot** | Optional[bool] | No | 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. | [[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/Ontologies/models/MarkingId.md b/docs/v2/Ontologies/models/MarkingId.md new file mode 100644 index 00000000..b53b07b2 --- /dev/null +++ b/docs/v2/Ontologies/models/MarkingId.md @@ -0,0 +1,11 @@ +# MarkingId + +The id of a classification or mandatory marking. + +## 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) diff --git a/docs/v2/Ontologies/models/PropertyMarkingSummary.md b/docs/v2/Ontologies/models/PropertyMarkingSummary.md new file mode 100644 index 00000000..0d5ff17b --- /dev/null +++ b/docs/v2/Ontologies/models/PropertyMarkingSummary.md @@ -0,0 +1,15 @@ +# PropertyMarkingSummary + +All marking requirements applicable to a property value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**conjunctive** | Optional[ConjunctiveMarkingSummary] | No | | +**disjunctive** | Optional[DisjunctiveMarkingSummary] | No | | +**container_conjunctive** | Optional[ContainerConjunctiveMarkingSummary] | No | | +**container_disjunctive** | Optional[ContainerDisjunctiveMarkingSummary] | No | | +**type** | Literal["propertyMarkingSummary"] | 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/Ontologies/models/PropertySecurities.md b/docs/v2/Ontologies/models/PropertySecurities.md new file mode 100644 index 00000000..3d1eb90b --- /dev/null +++ b/docs/v2/Ontologies/models/PropertySecurities.md @@ -0,0 +1,12 @@ +# PropertySecurities + +A disjunctive set of security results for a property value. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**disjunction** | List[PropertySecurity] | Yes | | + + +[[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/Ontologies/models/PropertySecurity.md b/docs/v2/Ontologies/models/PropertySecurity.md new file mode 100644 index 00000000..154f4ba2 --- /dev/null +++ b/docs/v2/Ontologies/models/PropertySecurity.md @@ -0,0 +1,17 @@ +# PropertySecurity + +PropertySecurity + +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 +| ------------ | ------------- +PropertyMarkingSummary | propertyMarkingSummary +UnsupportedPolicy | unsupportedPolicy +ErrorComputingSecurity | errorComputingSecurity + + +[[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/Ontologies/models/PropertyValue.md b/docs/v2/Ontologies/models/PropertyValue.md index cb86253e..a55337ed 100644 --- a/docs/v2/Ontologies/models/PropertyValue.md +++ b/docs/v2/Ontologies/models/PropertyValue.md @@ -18,6 +18,7 @@ Represents the value of a property in the following format. | Integer | number | `238940` | | Long | string | `"58319870951433"` | | [MediaReference](https://palantir.com/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` | +| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{"value": 10, "propertySecurityIndex" : 5}` | | Short | number | `8739` | | String | string | `"Call me Ishmael"` | | Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} | diff --git a/docs/v2/Ontologies/models/SearchObjectsRequestV2.md b/docs/v2/Ontologies/models/SearchObjectsRequestV2.md index 17bdf31f..a8d0f105 100644 --- a/docs/v2/Ontologies/models/SearchObjectsRequestV2.md +++ b/docs/v2/Ontologies/models/SearchObjectsRequestV2.md @@ -3,16 +3,16 @@ SearchObjectsRequestV2 ## Properties -| Name | Type | Required | Description | -| ------------ |------------------------------------|----------| ------------- | -**where** | Optional[SearchJsonQueryV2] | No | | -**order_by** | Optional[SearchOrderByV2] | No | | -**page_size** | Optional[PageSize] | No | | -**page_token** | Optional[PageToken] | No | | -**select** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | -**select_v2** | Optional[List[PropertyIdentifier]] | No | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | -**exclude_rid** | Optional[bool] | No | 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. | -**snapshot** | Optional[bool] | No | 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. | +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**where** | Optional[SearchJsonQueryV2] | No | | +**order_by** | Optional[SearchOrderByV2] | No | | +**page_size** | Optional[PageSize] | No | | +**page_token** | Optional[PageToken] | No | | +**select** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | +**select_v2** | List[PropertyIdentifier] | Yes | The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. | +**exclude_rid** | Optional[bool] | No | 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. | +**snapshot** | Optional[bool] | No | 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. | [[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/Ontologies/models/UnsupportedPolicy.md b/docs/v2/Ontologies/models/UnsupportedPolicy.md new file mode 100644 index 00000000..a644c47c --- /dev/null +++ b/docs/v2/Ontologies/models/UnsupportedPolicy.md @@ -0,0 +1,11 @@ +# UnsupportedPolicy + +Indicates the property is backed by a restricted view that does not support property securities. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["unsupportedPolicy"] | 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/SqlQueries/SqlQuery.md b/docs/v2/SqlQueries/SqlQuery.md index a91a4bdb..8e329b28 100644 --- a/docs/v2/SqlQueries/SqlQuery.md +++ b/docs/v2/SqlQueries/SqlQuery.md @@ -15,7 +15,7 @@ Cancels a query. If the query is no longer running this is effectively a no-op. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**sql_query_id** | SqlQueryId | The id of a query. | | +**sql_query_id** | 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. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -30,7 +30,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# SqlQueryId | The id of a query. +# 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. sql_query_id = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -128,7 +128,7 @@ retried while the query is still running. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**sql_query_id** | SqlQueryId | The id of a query. | | +**sql_query_id** | 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. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -165,7 +165,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# SqlQueryId | The id of a query. +# 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. sql_query_id = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -201,7 +201,7 @@ Gets the status of a query. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**sql_query_id** | SqlQueryId | The id of a query. | | +**sql_query_id** | 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. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -216,7 +216,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# SqlQueryId | The id of a query. +# 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. sql_query_id = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None diff --git a/foundry_sdk/_core/api_client.py b/foundry_sdk/_core/api_client.py index 2cd44c82..a84c9682 100644 --- a/foundry_sdk/_core/api_client.py +++ b/foundry_sdk/_core/api_client.py @@ -425,7 +425,7 @@ def __init__( elif not isinstance(auth, Auth): raise TypeError( "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or " - "PublicClientAuth, not an instance of {type(auth)}." + f"PublicClientAuth, not an instance of {type(auth).__name__}." ) assert_non_empty_string(hostname, "hostname") diff --git a/foundry_sdk/_versions.py b/foundry_sdk/_versions.py index 7c276897..8ede27a4 100644 --- a/foundry_sdk/_versions.py +++ b/foundry_sdk/_versions.py @@ -17,4 +17,4 @@ # using the autorelease bot __version__ = "0.0.0" -__openapi_document_version__ = "1.1416.1" +__openapi_document_version__ = "1.1422.0" diff --git a/foundry_sdk/v1/ontologies/models.py b/foundry_sdk/v1/ontologies/models.py index b5bc3f36..2f6f3155 100644 --- a/foundry_sdk/v1/ontologies/models.py +++ b/foundry_sdk/v1/ontologies/models.py @@ -1051,6 +1051,7 @@ class Property(core.ModelBase): | Integer | number | `238940` | | Long | string | `"58319870951433"` | | [MediaReference](https://palantir.com/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` | +| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{"value": 10, "propertySecurityIndex" : 5}` | | Short | number | `8739` | | String | string | `"Call me Ishmael"` | | Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} | diff --git a/foundry_sdk/v2/cli.py b/foundry_sdk/v2/cli.py index b9ddbc20..abfdb3ce 100644 --- a/foundry_sdk/v2/cli.py +++ b/foundry_sdk/v2/cli.py @@ -6868,6 +6868,14 @@ def ontologies_ontology_object_set_op_aggregate( @ontologies_ontology_object_set.command("create_temporary") @click.argument("ontology", type=str, required=True) @click.option("--object_set", type=str, required=True, help="""""") +@click.option( + "--branch", + type=str, + required=False, + help="""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. +""", +) @click.option( "--sdk_package_rid", type=str, @@ -6887,6 +6895,7 @@ def ontologies_ontology_object_set_op_create_temporary( client: FoundryClient, ontology: str, object_set: str, + branch: typing.Optional[str], sdk_package_rid: typing.Optional[str], sdk_version: typing.Optional[str], ): @@ -6897,6 +6906,7 @@ def ontologies_ontology_object_set_op_create_temporary( result = client.ontologies.OntologyObjectSet.create_temporary( ontology=ontology, object_set=json.loads(object_set), + branch=branch, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, ) @@ -6952,6 +6962,17 @@ def ontologies_ontology_object_set_op_get( """, ) @click.option("--include_compute_usage", type=bool, required=False, help="""""") +@click.option( + "--load_property_securities", + type=bool, + required=False, + help="""A flag to load the securities for all properties. +Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. +Returned objects will return all properties as Secured Property Values, which provide the property data +as well an index into the `propertySecurities` list. +This feature is experimental and not yet generally available. +""", +) @click.option("--order_by", type=str, required=False, help="""""") @click.option("--page_size", type=int, required=False, help="""""") @click.option("--page_token", type=str, required=False, help="""""") @@ -6997,6 +7018,7 @@ def ontologies_ontology_object_set_op_load( branch: typing.Optional[str], exclude_rid: typing.Optional[bool], include_compute_usage: typing.Optional[bool], + load_property_securities: typing.Optional[bool], order_by: typing.Optional[str], page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -7024,6 +7046,7 @@ def ontologies_ontology_object_set_op_load( branch=branch, exclude_rid=exclude_rid, include_compute_usage=include_compute_usage, + load_property_securities=load_property_securities, order_by=None if order_by is None else json.loads(order_by), page_size=page_size, page_token=page_token, @@ -7143,6 +7166,17 @@ def ontologies_ontology_object_set_op_load_links( """, ) @click.option("--include_compute_usage", type=bool, required=False, help="""""") +@click.option( + "--load_property_securities", + type=bool, + required=False, + help="""A flag to load the securities for all properties. +Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. +Returned objects will return all properties as Secured Property Values, which provide the property data +as well an index into the `propertySecurities` list. +This feature is experimental and not yet generally available. +""", +) @click.option("--order_by", type=str, required=False, help="""""") @click.option("--page_size", type=int, required=False, help="""""") @click.option("--page_token", type=str, required=False, help="""""") @@ -7195,6 +7229,7 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( branch: typing.Optional[str], exclude_rid: typing.Optional[bool], include_compute_usage: typing.Optional[bool], + load_property_securities: typing.Optional[bool], order_by: typing.Optional[str], page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -7228,6 +7263,7 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( branch=branch, exclude_rid=exclude_rid, include_compute_usage=include_compute_usage, + load_property_securities=load_property_securities, order_by=None if order_by is None else json.loads(order_by), page_size=page_size, page_token=page_token, diff --git a/foundry_sdk/v2/datasets/models.py b/foundry_sdk/v2/datasets/models.py index b16747c7..6eda965a 100644 --- a/foundry_sdk/v2/datasets/models.py +++ b/foundry_sdk/v2/datasets/models.py @@ -366,7 +366,9 @@ class View(core.ModelBase): class ViewBackingDataset(core.ModelBase): """One of the Datasets backing a View.""" - branch: BranchName + branch: typing.Optional[BranchName] = None + """The branch of the backing dataset. If not specified, defaults to the branch of the View.""" + dataset_rid: DatasetRid = pydantic.Field(alias=str("datasetRid")) # type: ignore[literal-required] diff --git a/foundry_sdk/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py index e1813d5f..015f3d24 100644 --- a/foundry_sdk/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -616,6 +616,37 @@ class CenterPoint(core.ModelBase): distance: core_models.Distance +ConjunctiveMarkingSummary = typing.List["MarkingId"] +""" +The conjunctive set of markings required to access the property value. +All markings from a conjunctive set must be met for access. +""" + + +ContainerConjunctiveMarkingSummary = typing.List["MarkingId"] +""" +The conjunctive set of markings for the container of this property value, +such as the project of a dataset. These markings may differ from the marking +on the actual property value, but still must be satisfied for accessing the property + +All markings from a conjunctive set must be met for access. +""" + + +ContainerDisjunctiveMarkingSummary = typing.List[typing.List["MarkingId"]] +""" +The disjunctive set of markings for the container of this property value, +such as the project of a dataset. These markings may differ from the marking +on the actual property value, but still must be satisfied for accessing the property +All markings from a conjunctive set must be met for access. + +Disjunctive markings are represented as a conjunctive list of disjunctive sets. +The top-level set is a conjunction of sets, where each inner set should be +treated as a unit where any marking within the set can satisfy the set. +All sets within the top level set should be satisfied. +""" + + class ContainsAllTermsInOrderPrefixLastTerm(core.ModelBase): """ Returns objects where the specified field contains all of the terms in the order provided, @@ -1018,6 +1049,16 @@ class DeprecatedPropertyTypeStatus(core.ModelBase): """Definition of a derived property.""" +DisjunctiveMarkingSummary = typing.List[typing.List["MarkingId"]] +""" +The disjunctive set of markings required to access the property value. +Disjunctive markings are represented as a conjunctive list of disjunctive sets. +The top-level set is a conjunction of sets, where each inner set should be +treated as a unit where any marking within the set can satisfy the set. +All sets within the top level set should be satisfied. +""" + + class DividePropertyExpression(core.ModelBase): """Divides the left numeric value by the right numeric value.""" @@ -1103,6 +1144,12 @@ class EqualsQueryV2(core.ModelBase): type: typing.Literal["eq"] = "eq" +class ErrorComputingSecurity(core.ModelBase): + """Indicates the server was not able to load the securities of the property.""" + + type: typing.Literal["errorComputingSecurity"] = "errorComputingSecurity" + + class ExactDistinctAggregationV2(core.ModelBase): """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" @@ -1257,8 +1304,8 @@ class HumanReadableFormat(core.ModelBase): class InQuery(core.ModelBase): """ Returns objects where the specified field equals any of the provided values. Allows you to - specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, - but not both. + specify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects + in the object set. Either `field` or `propertyIdentifier` must be supplied, but not both. """ field: typing.Optional[PropertyApiName] = None @@ -1810,7 +1857,7 @@ class LoadObjectSetRequestV2(core.ModelBase): object_set: ObjectSet = pydantic.Field(alias=str("objectSet")) # type: ignore[literal-required] order_by: typing.Optional[SearchOrderByV2] = pydantic.Field(alias=str("orderBy"), default=None) # type: ignore[literal-required] select: typing.List[SelectedPropertyApiName] - select_v2: typing.Optional[typing.List[PropertyIdentifier]] = pydantic.Field(alias=str("selectV2"), default=None) # type: ignore[literal-required] + select_v2: typing.List[PropertyIdentifier] = pydantic.Field(alias=str("selectV2")) # type: ignore[literal-required] """ The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. @@ -1824,6 +1871,15 @@ class LoadObjectSetRequestV2(core.ModelBase): Setting this to true may improve performance of this endpoint for object types in OSV2. """ + load_property_securities: typing.Optional[bool] = pydantic.Field(alias=str("loadPropertySecurities"), default=None) # type: ignore[literal-required] + """ + A flag to load the securities for all properties. + Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. + Returned objects will return all properties as Secured Property Values, which provide the property data + as well an index into the `propertySecurities` list. + This feature is experimental and not yet generally available. + """ + snapshot: typing.Optional[bool] = None """ A flag to use snapshot consistency when paging. @@ -1844,6 +1900,7 @@ class LoadObjectSetResponseV2(core.ModelBase): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] compute_usage: typing.Optional[core_models.ComputeSeconds] = pydantic.Field(alias=str("computeUsage"), default=None) # type: ignore[literal-required] + property_securities: typing.List[PropertySecurities] = pydantic.Field(alias=str("propertySecurities")) # type: ignore[literal-required] class LoadObjectSetV2MultipleObjectTypesRequest(core.ModelBase): @@ -1852,7 +1909,7 @@ class LoadObjectSetV2MultipleObjectTypesRequest(core.ModelBase): object_set: ObjectSet = pydantic.Field(alias=str("objectSet")) # type: ignore[literal-required] order_by: typing.Optional[SearchOrderByV2] = pydantic.Field(alias=str("orderBy"), default=None) # type: ignore[literal-required] select: typing.List[SelectedPropertyApiName] - select_v2: typing.Optional[typing.List[PropertyIdentifier]] = pydantic.Field(alias=str("selectV2"), default=None) # type: ignore[literal-required] + select_v2: typing.List[PropertyIdentifier] = pydantic.Field(alias=str("selectV2")) # type: ignore[literal-required] """ The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. @@ -1866,6 +1923,15 @@ class LoadObjectSetV2MultipleObjectTypesRequest(core.ModelBase): Setting this to true may improve performance of this endpoint for object types in OSV2. """ + load_property_securities: typing.Optional[bool] = pydantic.Field(alias=str("loadPropertySecurities"), default=None) # type: ignore[literal-required] + """ + A flag to load the securities for all properties. + Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. + Returned objects will return all properties as Secured Property Values, which provide the property data + as well an index into the `propertySecurities` list. + This feature is experimental and not yet generally available. + """ + snapshot: typing.Optional[bool] = None """ A flag to use snapshot consistency when paging. @@ -1901,6 +1967,7 @@ class LoadObjectSetV2MultipleObjectTypesResponse(core.ModelBase): interface_to_object_type_mappings: typing.Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappings] = pydantic.Field(alias=str("interfaceToObjectTypeMappings")) # type: ignore[literal-required] interface_to_object_type_mappings_v2: typing.Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappingsV2] = pydantic.Field(alias=str("interfaceToObjectTypeMappingsV2")) # type: ignore[literal-required] compute_usage: typing.Optional[core_models.ComputeSeconds] = pydantic.Field(alias=str("computeUsage"), default=None) # type: ignore[literal-required] + property_securities: typing.List[PropertySecurities] = pydantic.Field(alias=str("propertySecurities")) # type: ignore[literal-required] class LoadObjectSetV2ObjectsOrInterfacesRequest(core.ModelBase): @@ -1909,7 +1976,7 @@ class LoadObjectSetV2ObjectsOrInterfacesRequest(core.ModelBase): object_set: ObjectSet = pydantic.Field(alias=str("objectSet")) # type: ignore[literal-required] order_by: typing.Optional[SearchOrderByV2] = pydantic.Field(alias=str("orderBy"), default=None) # type: ignore[literal-required] select: typing.List[SelectedPropertyApiName] - select_v2: typing.Optional[typing.List[PropertyIdentifier]] = pydantic.Field(alias=str("selectV2"), default=None) # type: ignore[literal-required] + select_v2: typing.List[PropertyIdentifier] = pydantic.Field(alias=str("selectV2")) # type: ignore[literal-required] """ The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. @@ -2011,6 +2078,10 @@ class LteQueryV2(core.ModelBase): type: typing.Literal["lte"] = "lte" +MarkingId = str +"""The id of a classification or mandatory marking.""" + + class MatchRule(core.ModelBase): """Matches intervals containing the terms in the query""" @@ -3120,6 +3191,16 @@ class PropertyKnownTypeFormattingRule(core.ModelBase): """ +class PropertyMarkingSummary(core.ModelBase): + """All marking requirements applicable to a property value.""" + + conjunctive: typing.Optional[ConjunctiveMarkingSummary] = None + disjunctive: typing.Optional[DisjunctiveMarkingSummary] = None + container_conjunctive: typing.Optional[ContainerConjunctiveMarkingSummary] = pydantic.Field(alias=str("containerConjunctive"), default=None) # type: ignore[literal-required] + container_disjunctive: typing.Optional[ContainerDisjunctiveMarkingSummary] = pydantic.Field(alias=str("containerDisjunctive"), default=None) # type: ignore[literal-required] + type: typing.Literal["propertyMarkingSummary"] = "propertyMarkingSummary" + + class PropertyNumberFormattingRule(core.ModelBase): """Wrapper for numeric formatting options.""" @@ -3151,6 +3232,19 @@ class PropertyNumberFormattingRule(core.ModelBase): """PropertyOrStructFieldOfPropertyImplementation""" +class PropertySecurities(core.ModelBase): + """A disjunctive set of security results for a property value.""" + + disjunction: typing.List[PropertySecurity] + + +PropertySecurity = typing_extensions.Annotated[ + typing.Union["PropertyMarkingSummary", "UnsupportedPolicy", "ErrorComputingSecurity"], + pydantic.Field(discriminator="type"), +] +"""PropertySecurity""" + + class PropertyTimestampFormattingRule(core.ModelBase): """Formatting configuration for timestamp property values.""" @@ -3231,6 +3325,7 @@ class PropertyV2(core.ModelBase): | Integer | number | `238940` | | Long | string | `"58319870951433"` | | [MediaReference](https://palantir.com/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` | +| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{"value": 10, "propertySecurityIndex" : 5}` | | Short | number | `8739` | | String | string | `"Call me Ishmael"` | | Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} | @@ -3703,7 +3798,7 @@ class SearchObjectsRequestV2(core.ModelBase): select: typing.List[PropertyApiName] """The API names of the object type properties to include in the response.""" - select_v2: typing.Optional[typing.List[PropertyIdentifier]] = pydantic.Field(alias=str("selectV2"), default=None) # type: ignore[literal-required] + select_v2: typing.List[PropertyIdentifier] = pydantic.Field(alias=str("selectV2")) # type: ignore[literal-required] """ The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. @@ -4371,6 +4466,12 @@ class UniqueIdentifierArgument(core.ModelBase): """ +class UnsupportedPolicy(core.ModelBase): + """Indicates the property is backed by a restricted view that does not support property securities.""" + + type: typing.Literal["unsupportedPolicy"] = "unsupportedPolicy" + + class UuidConstraint(core.ModelBase): """The string must be a valid UUID (Universally Unique Identifier).""" @@ -4625,9 +4726,17 @@ class WithinPolygonQuery(core.ModelBase): core.resolve_forward_references(AttachmentMetadataResponse, globalns=globals(), localns=locals()) core.resolve_forward_references(BatchActionObjectEdit, globalns=globals(), localns=locals()) core.resolve_forward_references(BatchActionResults, globalns=globals(), localns=locals()) +core.resolve_forward_references(ConjunctiveMarkingSummary, globalns=globals(), localns=locals()) +core.resolve_forward_references( + ContainerConjunctiveMarkingSummary, globalns=globals(), localns=locals() +) +core.resolve_forward_references( + ContainerDisjunctiveMarkingSummary, globalns=globals(), localns=locals() +) core.resolve_forward_references(DatetimeFormat, globalns=globals(), localns=locals()) core.resolve_forward_references(DatetimeTimezone, globalns=globals(), localns=locals()) core.resolve_forward_references(DerivedPropertyDefinition, globalns=globals(), localns=locals()) +core.resolve_forward_references(DisjunctiveMarkingSummary, globalns=globals(), localns=locals()) core.resolve_forward_references(DurationFormatStyle, globalns=globals(), localns=locals()) core.resolve_forward_references( InterfaceLinkTypeLinkedEntityApiName, globalns=globals(), localns=locals() @@ -4668,6 +4777,7 @@ class WithinPolygonQuery(core.ModelBase): core.resolve_forward_references( PropertyOrStructFieldOfPropertyImplementation, globalns=globals(), localns=locals() ) +core.resolve_forward_references(PropertySecurity, globalns=globals(), localns=locals()) core.resolve_forward_references( PropertyTypeReferenceOrStringConstant, globalns=globals(), localns=locals() ) @@ -4765,6 +4875,9 @@ class WithinPolygonQuery(core.ModelBase): "BoundingBoxValue", "CenterPoint", "CenterPointTypes", + "ConjunctiveMarkingSummary", + "ContainerConjunctiveMarkingSummary", + "ContainerDisjunctiveMarkingSummary", "ContainsAllTermsInOrderPrefixLastTerm", "ContainsAllTermsInOrderQuery", "ContainsAllTermsQuery", @@ -4807,6 +4920,7 @@ class WithinPolygonQuery(core.ModelBase): "DeprecatedPropertyTypeStatus", "DerivedPropertyApiName", "DerivedPropertyDefinition", + "DisjunctiveMarkingSummary", "DividePropertyExpression", "DoesNotIntersectBoundingBoxQuery", "DoesNotIntersectPolygonQuery", @@ -4817,6 +4931,7 @@ class WithinPolygonQuery(core.ModelBase): "EntrySetType", "EnumConstraint", "EqualsQueryV2", + "ErrorComputingSecurity", "ExactDistinctAggregationV2", "ExamplePropertyTypeStatus", "ExecuteQueryRequest", @@ -4909,6 +5024,7 @@ class WithinPolygonQuery(core.ModelBase): "LogicRuleArgument", "LtQueryV2", "LteQueryV2", + "MarkingId", "MatchRule", "MaxAggregationV2", "MediaMetadata", @@ -5023,9 +5139,12 @@ class WithinPolygonQuery(core.ModelBase): "PropertyImplementation", "PropertyKnownTypeFormattingRule", "PropertyLoadLevel", + "PropertyMarkingSummary", "PropertyNumberFormattingRule", "PropertyNumberFormattingRuleType", "PropertyOrStructFieldOfPropertyImplementation", + "PropertySecurities", + "PropertySecurity", "PropertyTimestampFormattingRule", "PropertyTypeApiName", "PropertyTypeReference", @@ -5144,6 +5263,7 @@ class WithinPolygonQuery(core.ModelBase): "UniqueIdentifierArgument", "UniqueIdentifierLinkId", "UniqueIdentifierValue", + "UnsupportedPolicy", "UuidConstraint", "ValidateActionResponseV2", "ValidationResult", diff --git a/foundry_sdk/v2/ontologies/ontology_object.py b/foundry_sdk/v2/ontologies/ontology_object.py index d162fbfc..ab01fb7c 100644 --- a/foundry_sdk/v2/ontologies/ontology_object.py +++ b/foundry_sdk/v2/ontologies/ontology_object.py @@ -16,6 +16,7 @@ import typing import pydantic +import typing_extensions from foundry_sdk import _core as core from foundry_sdk import _errors as errors @@ -349,7 +350,7 @@ def search( object_type: ontologies_models.ObjectTypeApiName, *, select: typing.List[ontologies_models.PropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -394,7 +395,7 @@ def search( :param select: The API names of the object type properties to include in the response. :type select: List[PropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :param branch: 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. :type branch: Optional[FoundryBranch] :param exclude_rid: 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. @@ -810,7 +811,7 @@ def search( object_type: ontologies_models.ObjectTypeApiName, *, select: typing.List[ontologies_models.PropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -855,7 +856,7 @@ def search( :param select: The API names of the object type properties to include in the response. :type select: List[PropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :param branch: 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. :type branch: Optional[FoundryBranch] :param exclude_rid: 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. diff --git a/foundry_sdk/v2/ontologies/ontology_object_set.py b/foundry_sdk/v2/ontologies/ontology_object_set.py index 4ac4224f..4f0bf1ab 100644 --- a/foundry_sdk/v2/ontologies/ontology_object_set.py +++ b/foundry_sdk/v2/ontologies/ontology_object_set.py @@ -16,6 +16,7 @@ import typing import pydantic +import typing_extensions from foundry_sdk import _core as core from foundry_sdk import _errors as errors @@ -133,6 +134,7 @@ def create_temporary( ontology: ontologies_models.OntologyIdentifier, *, object_set: ontologies_models.ObjectSet, + branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -145,6 +147,8 @@ def create_temporary( :type ontology: OntologyIdentifier :param object_set: :type object_set: ObjectSet + :param branch: 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. + :type branch: Optional[FoundryBranch] :param sdk_package_rid: The package rid of the generated SDK. :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. @@ -160,6 +164,7 @@ def create_temporary( method="POST", resource_path="/v2/ontologies/{ontology}/objectSets/createTemporary", query_params={ + "branch": branch, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, }, @@ -233,10 +238,11 @@ def load( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, + load_property_securities: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -264,13 +270,15 @@ def load( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :param branch: The Foundry branch to load the object set from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] :param exclude_rid: 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. :type exclude_rid: Optional[bool] :param include_compute_usage: :type include_compute_usage: Optional[IncludeComputeUsage] + :param load_property_securities: A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. + :type load_property_securities: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -316,6 +324,7 @@ def load( page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, + load_property_securities=load_property_securities, snapshot=snapshot, include_compute_usage=include_compute_usage, ), @@ -423,10 +432,11 @@ def load_multiple_object_types( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, + load_property_securities: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -460,13 +470,15 @@ def load_multiple_object_types( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :param branch: The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] :param exclude_rid: 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. :type exclude_rid: Optional[bool] :param include_compute_usage: :type include_compute_usage: Optional[IncludeComputeUsage] + :param load_property_securities: A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. + :type load_property_securities: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -515,6 +527,7 @@ def load_multiple_object_types( page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, + load_property_securities=load_property_securities, snapshot=snapshot, include_compute_usage=include_compute_usage, ), @@ -534,7 +547,7 @@ def load_objects_or_interfaces( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -571,7 +584,7 @@ def load_objects_or_interfaces( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :param branch: 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. :type branch: Optional[FoundryBranch] :param exclude_rid: 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. @@ -797,6 +810,7 @@ def create_temporary( ontology: ontologies_models.OntologyIdentifier, *, object_set: ontologies_models.ObjectSet, + branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -809,6 +823,8 @@ def create_temporary( :type ontology: OntologyIdentifier :param object_set: :type object_set: ObjectSet + :param branch: 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. + :type branch: Optional[FoundryBranch] :param sdk_package_rid: The package rid of the generated SDK. :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The package version of the generated SDK. @@ -824,6 +840,7 @@ def create_temporary( method="POST", resource_path="/v2/ontologies/{ontology}/objectSets/createTemporary", query_params={ + "branch": branch, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, }, @@ -897,10 +914,11 @@ def load( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, + load_property_securities: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -928,13 +946,15 @@ def load( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :param branch: The Foundry branch to load the object set from. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] :param exclude_rid: 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. :type exclude_rid: Optional[bool] :param include_compute_usage: :type include_compute_usage: Optional[IncludeComputeUsage] + :param load_property_securities: A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. + :type load_property_securities: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -980,6 +1000,7 @@ def load( page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, + load_property_securities=load_property_securities, snapshot=snapshot, include_compute_usage=include_compute_usage, ), @@ -1087,10 +1108,11 @@ def load_multiple_object_types( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = None, + load_property_securities: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -1124,13 +1146,15 @@ def load_multiple_object_types( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :param branch: The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. :type branch: Optional[FoundryBranch] :param exclude_rid: 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. :type exclude_rid: Optional[bool] :param include_compute_usage: :type include_compute_usage: Optional[IncludeComputeUsage] + :param load_property_securities: A flag to load the securities for all properties. Setting this flag to true will return a list of securities in the `propertySecurities` field of the response. Returned objects will return all properties as Secured Property Values, which provide the property data as well an index into the `propertySecurities` list. This feature is experimental and not yet generally available. + :type load_property_securities: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -1179,6 +1203,7 @@ def load_multiple_object_types( page_token=page_token, page_size=page_size, exclude_rid=exclude_rid, + load_property_securities=load_property_securities, snapshot=snapshot, include_compute_usage=include_compute_usage, ), @@ -1198,7 +1223,7 @@ def load_objects_or_interfaces( *, object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], - select_v2: typing.Optional[typing.List[ontologies_models.PropertyIdentifier]] = None, + select_v2: typing.List[ontologies_models.PropertyIdentifier], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, @@ -1235,7 +1260,7 @@ def load_objects_or_interfaces( :param select: :type select: List[SelectedPropertyApiName] :param select_v2: The identifiers of the properties to include in the response. Only selectV2 or select should be populated, but not both. - :type select_v2: Optional[List[PropertyIdentifier]] + :type select_v2: List[PropertyIdentifier] :param branch: 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. :type branch: Optional[FoundryBranch] :param exclude_rid: 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. diff --git a/foundry_sdk/v2/sql_queries/errors.py b/foundry_sdk/v2/sql_queries/errors.py index fcb5a3ae..3d996d5c 100644 --- a/foundry_sdk/v2/sql_queries/errors.py +++ b/foundry_sdk/v2/sql_queries/errors.py @@ -29,7 +29,7 @@ class CancelSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore sqlQueryId: sql_queries_models.SqlQueryId - """The id of a query.""" + """The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints.""" @dataclass @@ -58,7 +58,7 @@ class GetResultsSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore sqlQueryId: sql_queries_models.SqlQueryId - """The id of a query.""" + """The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints.""" @dataclass @@ -74,7 +74,7 @@ class GetStatusSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore sqlQueryId: sql_queries_models.SqlQueryId - """The id of a query.""" + """The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints.""" @dataclass diff --git a/foundry_sdk/v2/sql_queries/sql_query.py b/foundry_sdk/v2/sql_queries/sql_query.py index 541b12d4..0ef43a68 100644 --- a/foundry_sdk/v2/sql_queries/sql_query.py +++ b/foundry_sdk/v2/sql_queries/sql_query.py @@ -63,7 +63,7 @@ def cancel( """ Cancels a query. If the query is no longer running this is effectively a no-op. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -194,7 +194,7 @@ def get_results( This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -256,7 +256,7 @@ def get_status( """ Gets the status of a query. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -365,7 +365,7 @@ def cancel( """ Cancels a query. If the query is no longer running this is effectively a no-op. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -496,7 +496,7 @@ def get_results( This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -558,7 +558,7 @@ def get_status( """ Gets the status of a query. - :param sql_query_id: The id of a query. + :param sql_query_id: The unique identifier for a query. Note that query IDs are not URL-safe and must be URL-encoded when used in API endpoints. :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] diff --git a/tests/test_api_client.py b/tests/test_api_client.py index 8ea89d13..acc5cb9b 100644 --- a/tests/test_api_client.py +++ b/tests/test_api_client.py @@ -430,51 +430,51 @@ def test_ssl_error(): def test_passing_in_str_auth(): with pytest.raises(TypeError) as e: ApiClient(auth="foo", hostname="localhost:8123") # type: ignore - assert str(e.value).startswith( - "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not a string." - ) + assert str(e.value).startswith( + "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not a string." + ) with pytest.raises(TypeError) as e: AsyncApiClient(auth="foo", hostname="localhost:8123") # type: ignore - assert str(e.value).startswith( - "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not a string." - ) + assert str(e.value).startswith( + "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not a string." + ) def test_passing_in_int_to_auth(): with pytest.raises(TypeError) as e: ApiClient(auth=2, hostname="localhost:8123") # type: ignore - assert ( - str(e.value) - == "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not an instance of int." - ) + assert ( + str(e.value) + == "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not an instance of int." + ) with pytest.raises(TypeError) as e: AsyncApiClient(auth=2, hostname="localhost:8123") # type: ignore - assert ( - str(e.value) - == "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not an instance of int." - ) + assert ( + str(e.value) + == "auth must be an instance of UserTokenAuth, ConfidentialClientAuth or PublicClientAuth, not an instance of int." + ) def test_passing_in_int_to_hostname(): with pytest.raises(TypeError) as e: ApiClient(auth=UserTokenAuth(token="foo"), hostname=2) # type: ignore - assert str(e.value) == "hostname must be a string, not int." + assert str(e.value) == "The hostname must be a string, not ." with pytest.raises(TypeError) as e: AsyncApiClient(auth=UserTokenAuth(token="foo"), hostname=2) # type: ignore - assert str(e.value) == "hostname must be a string, not int." + assert str(e.value) == "The hostname must be a string, not ." def test_passing_in_int_to_config(): with pytest.raises(TypeError) as e: ApiClient(auth=UserTokenAuth(token="foo"), hostname="localhost:1234", config=2) # type: ignore - assert str(e.value) == "config must be an instance of Config, not int." + assert str(e.value) == "config must be an instance of Config, not ." with pytest.raises(TypeError) as e: AsyncApiClient(auth=UserTokenAuth(token="foo"), hostname="localhost:1234", config=2) # type: ignore - assert str(e.value) == "config must be an instance of Config, not int." + assert str(e.value) == "config must be an instance of Config, not ." def test_config_shared_with_auth():