diff --git a/README.md b/README.md index dec077af..0db85844 100644 --- a/README.md +++ b/README.md @@ -2696,6 +2696,7 @@ Namespace | Name | Import | **Ontologies** | [NoLoadLevel](docs/v2/Ontologies/models/NoLoadLevel.md) | `from foundry_sdk.v2.ontologies.models import NoLoadLevel` | **Ontologies** | [NotQueryV2](docs/v2/Ontologies/models/NotQueryV2.md) | `from foundry_sdk.v2.ontologies.models import NotQueryV2` | **Ontologies** | [NowDatetimeValue](docs/v2/Ontologies/models/NowDatetimeValue.md) | `from foundry_sdk.v2.ontologies.models import NowDatetimeValue` | +**Ontologies** | [NullabilityPropertyTypeDataConstraint](docs/v2/Ontologies/models/NullabilityPropertyTypeDataConstraint.md) | `from foundry_sdk.v2.ontologies.models import NullabilityPropertyTypeDataConstraint` | **Ontologies** | [NumberFormatAffix](docs/v2/Ontologies/models/NumberFormatAffix.md) | `from foundry_sdk.v2.ontologies.models import NumberFormatAffix` | **Ontologies** | [NumberFormatCurrency](docs/v2/Ontologies/models/NumberFormatCurrency.md) | `from foundry_sdk.v2.ontologies.models import NumberFormatCurrency` | **Ontologies** | [NumberFormatCurrencyStyle](docs/v2/Ontologies/models/NumberFormatCurrencyStyle.md) | `from foundry_sdk.v2.ontologies.models import NumberFormatCurrencyStyle` | @@ -2845,6 +2846,7 @@ Namespace | Name | Import | **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** | [PropertyTypeDataConstraints](docs/v2/Ontologies/models/PropertyTypeDataConstraints.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeDataConstraints` | **Ontologies** | [PropertyTypeMappingInfo](docs/v2/Ontologies/models/PropertyTypeMappingInfo.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeMappingInfo` | **Ontologies** | [PropertyTypeReference](docs/v2/Ontologies/models/PropertyTypeReference.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeReference` | **Ontologies** | [PropertyTypeReferenceOrStringConstant](docs/v2/Ontologies/models/PropertyTypeReferenceOrStringConstant.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeReferenceOrStringConstant` | @@ -3923,11 +3925,13 @@ Namespace | Name | Import | **Models** | CreateModelStudioConfigVersionPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelStudioConfigVersionPermissionDenied` | **Models** | CreateModelStudioPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelStudioPermissionDenied` | **Models** | CreateModelVersionPermissionDenied | `from foundry_sdk.v2.models.errors import CreateModelVersionPermissionDenied` | +**Models** | DeploymentSourceCannotExportResourceMarkings | `from foundry_sdk.v2.models.errors import DeploymentSourceCannotExportResourceMarkings` | +**Models** | DeploymentSourceNotEnabledForComputeModules | `from foundry_sdk.v2.models.errors import DeploymentSourceNotEnabledForComputeModules` | +**Models** | DeploymentSourceNotImportedIntoProject | `from foundry_sdk.v2.models.errors import DeploymentSourceNotImportedIntoProject` | **Models** | DisableLiveDeploymentPermissionDenied | `from foundry_sdk.v2.models.errors import DisableLiveDeploymentPermissionDenied` | **Models** | ExperimentArtifactNotFound | `from foundry_sdk.v2.models.errors import ExperimentArtifactNotFound` | **Models** | ExperimentNotFound | `from foundry_sdk.v2.models.errors import ExperimentNotFound` | **Models** | ExperimentSeriesNotFound | `from foundry_sdk.v2.models.errors import ExperimentSeriesNotFound` | -**Models** | FunctionAlreadyExists | `from foundry_sdk.v2.models.errors import FunctionAlreadyExists` | **Models** | GpuTypeNotAvailable | `from foundry_sdk.v2.models.errors import GpuTypeNotAvailable` | **Models** | InferenceFailure | `from foundry_sdk.v2.models.errors import InferenceFailure` | **Models** | InferenceInvalidInput | `from foundry_sdk.v2.models.errors import InferenceInvalidInput` | @@ -3958,6 +3962,7 @@ Namespace | Name | Import | **Models** | PromoteVersionModelPermissionDenied | `from foundry_sdk.v2.models.errors import PromoteVersionModelPermissionDenied` | **Models** | ReplaceLiveDeploymentPermissionDenied | `from foundry_sdk.v2.models.errors import ReplaceLiveDeploymentPermissionDenied` | **Models** | ReplaceModelFunctionPermissionDenied | `from foundry_sdk.v2.models.errors import ReplaceModelFunctionPermissionDenied` | +**Models** | ReservedEnvironmentVariable | `from foundry_sdk.v2.models.errors import ReservedEnvironmentVariable` | **Models** | SearchExperimentsPermissionDenied | `from foundry_sdk.v2.models.errors import SearchExperimentsPermissionDenied` | **Models** | StartLiveDeploymentPermissionDenied | `from foundry_sdk.v2.models.errors import StartLiveDeploymentPermissionDenied` | **Models** | ThreadCountTooHigh | `from foundry_sdk.v2.models.errors import ThreadCountTooHigh` | diff --git a/docs-snippets-npm/package.json b/docs-snippets-npm/package.json index 8a6734e6..b953a489 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.1783.1", + "minVersion": "1.1795.1", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index 35e32231..63087f44 100644 --- a/docs-snippets-npm/src/index.ts +++ b/docs-snippets-npm/src/index.ts @@ -1600,12 +1600,12 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets models_models.ModelFunction: """ - Creates a function for the model. + Creates a function for the model. If a function already exists for the model, the existing function is updated. + :param model_rid: :type model_rid: ModelRid :param api_name: @@ -90,7 +91,6 @@ def create( :rtype: models_models.ModelFunction :raises CreateModelFunctionPermissionDenied: Could not create the ModelFunction. - :raises FunctionAlreadyExists: A function already exists for this model. :raises InvalidFunctionApiName: The provided API name for the function is invalid. :raises ModelApiTypeUnsupportedForFunction: The model API contains a data type that is not supported for Ontology function creation. :raises ModelNotFound: The given Model could not be found. @@ -122,7 +122,6 @@ def create( request_timeout=request_timeout, throwable_errors={ "CreateModelFunctionPermissionDenied": models_errors.CreateModelFunctionPermissionDenied, - "FunctionAlreadyExists": models_errors.FunctionAlreadyExists, "InvalidFunctionApiName": models_errors.InvalidFunctionApiName, "ModelApiTypeUnsupportedForFunction": models_errors.ModelApiTypeUnsupportedForFunction, "ModelNotFound": models_errors.ModelNotFound, @@ -325,7 +324,8 @@ def create( _sdk_internal: core.SdkInternal = {}, ) -> typing.Awaitable[models_models.ModelFunction]: """ - Creates a function for the model. + Creates a function for the model. If a function already exists for the model, the existing function is updated. + :param model_rid: :type model_rid: ModelRid :param api_name: @@ -344,7 +344,6 @@ def create( :rtype: typing.Awaitable[models_models.ModelFunction] :raises CreateModelFunctionPermissionDenied: Could not create the ModelFunction. - :raises FunctionAlreadyExists: A function already exists for this model. :raises InvalidFunctionApiName: The provided API name for the function is invalid. :raises ModelApiTypeUnsupportedForFunction: The model API contains a data type that is not supported for Ontology function creation. :raises ModelNotFound: The given Model could not be found. @@ -376,7 +375,6 @@ def create( request_timeout=request_timeout, throwable_errors={ "CreateModelFunctionPermissionDenied": models_errors.CreateModelFunctionPermissionDenied, - "FunctionAlreadyExists": models_errors.FunctionAlreadyExists, "InvalidFunctionApiName": models_errors.InvalidFunctionApiName, "ModelApiTypeUnsupportedForFunction": models_errors.ModelApiTypeUnsupportedForFunction, "ModelNotFound": models_errors.ModelNotFound, diff --git a/foundry_sdk/v2/ontologies/linked_object.py b/foundry_sdk/v2/ontologies/linked_object.py index 1cf2af51..e31b7f3d 100644 --- a/foundry_sdk/v2/ontologies/linked_object.py +++ b/foundry_sdk/v2/ontologies/linked_object.py @@ -66,6 +66,7 @@ def get_linked_object( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, @@ -91,6 +92,8 @@ def get_linked_object( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param sdk_package_rid: The package rid of the generated SDK. :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The version of the generated SDK. @@ -110,6 +113,7 @@ def get_linked_object( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, "select": select, @@ -144,6 +148,7 @@ def list_linked_objects( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.OrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -181,6 +186,8 @@ def list_linked_objects( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param order_by: :type order_by: Optional[OrderBy] :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. @@ -208,6 +215,7 @@ def list_linked_objects( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "orderBy": order_by, "pageSize": page_size, "pageToken": page_token, @@ -300,6 +308,7 @@ def get_linked_object( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, @@ -325,6 +334,8 @@ def get_linked_object( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param sdk_package_rid: The package rid of the generated SDK. :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The version of the generated SDK. @@ -344,6 +355,7 @@ def get_linked_object( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, "select": select, @@ -378,6 +390,7 @@ def list_linked_objects( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.OrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -415,6 +428,8 @@ def list_linked_objects( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param order_by: :type order_by: Optional[OrderBy] :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. @@ -442,6 +457,7 @@ def list_linked_objects( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "orderBy": order_by, "pageSize": page_size, "pageToken": page_token, diff --git a/foundry_sdk/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py index 0b865d1b..f2dece1d 100644 --- a/foundry_sdk/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -3241,6 +3241,15 @@ class NowDatetimeValue(core.ModelBase): type: typing.Literal["now"] = "now" +NullabilityPropertyTypeDataConstraint: typing_extensions.TypeAlias = typing.Literal[ + "NULLABLE", "NOT_NULLABLE" +] +""" +Indicates whether values in mapped datasources and values created through actions may be null. Null values may +still be observed for objects that are not present in the datasource mapping. +""" + + class NumberFormatAffix(core.ModelBase): """ Attach arbitrary text before and/or after the formatted number. @@ -4792,6 +4801,12 @@ class PropertyTimestampFormattingRule(core.ModelBase): """PropertyTypeApiName""" +class PropertyTypeDataConstraints(core.ModelBase): + """Data constraints for a property type, including nullability information.""" + + nullability: typing.Optional[NullabilityPropertyTypeDataConstraint] = None + + PropertyTypeMappingInfo: typing_extensions.TypeAlias = typing_extensions.Annotated[ typing.Union["StructPropertyMapping", "ColumnPropertyMapping", "EditOnlyPropertyMapping"], pydantic.Field(discriminator="type"), @@ -4852,6 +4867,7 @@ class PropertyV2(core.ModelBase): value_type_api_name: typing.Optional[ValueTypeApiName] = pydantic.Field(alias=str("valueTypeApiName"), default=None) # type: ignore[literal-required] value_formatting: typing.Optional[PropertyValueFormattingRule] = pydantic.Field(alias=str("valueFormatting"), default=None) # type: ignore[literal-required] type_classes: typing.Optional[typing.List[TypeClass]] = pydantic.Field(alias=str("typeClasses"), default=None) # type: ignore[literal-required] + data_constraints: typing.Optional[PropertyTypeDataConstraints] = pydantic.Field(alias=str("dataConstraints"), default=None) # type: ignore[literal-required] PropertyValue: typing_extensions.TypeAlias = typing.Any @@ -5540,6 +5556,15 @@ class SearchObjectsRequestV2(core.ModelBase): """ default_load_level: typing.Optional[PropertyLoadLevel] = pydantic.Field(alias=str("defaultLoadLevel"), default=None) # type: ignore[literal-required] + load_ontology_defined_derived_properties: typing.Optional[bool] = pydantic.Field(alias=str("loadOntologyDefinedDerivedProperties"), default=None) # type: ignore[literal-required] + """ + A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. + Only applies when no explicit property selection is provided; when specific properties are + selected, this flag has no effect and the selected properties are always returned. + + This feature is experimental and not yet generally available. + """ + exclude_rid: typing.Optional[bool] = pydantic.Field(alias=str("excludeRid"), default=None) # type: ignore[literal-required] """ A flag to exclude the retrieval of the `__rid` property. @@ -7033,6 +7058,7 @@ class WithinPolygonQuery(core.ModelBase): "NoLoadLevel", "NotQueryV2", "NowDatetimeValue", + "NullabilityPropertyTypeDataConstraint", "NumberFormatAffix", "NumberFormatCurrency", "NumberFormatCurrencyStyle", @@ -7182,6 +7208,7 @@ class WithinPolygonQuery(core.ModelBase): "PropertySecurity", "PropertyTimestampFormattingRule", "PropertyTypeApiName", + "PropertyTypeDataConstraints", "PropertyTypeMappingInfo", "PropertyTypeReference", "PropertyTypeReferenceOrStringConstant", diff --git a/foundry_sdk/v2/ontologies/ontology_interface.py b/foundry_sdk/v2/ontologies/ontology_interface.py index b4299ae1..11238088 100644 --- a/foundry_sdk/v2/ontologies/ontology_interface.py +++ b/foundry_sdk/v2/ontologies/ontology_interface.py @@ -320,6 +320,7 @@ def list_interface_linked_objects( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.OrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -358,6 +359,8 @@ def list_interface_linked_objects( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param order_by: :type order_by: Optional[OrderBy] :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. @@ -383,6 +386,7 @@ def list_interface_linked_objects( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "orderBy": order_by, "pageSize": page_size, "pageToken": page_token, @@ -1055,6 +1059,7 @@ def list_interface_linked_objects( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.OrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -1093,6 +1098,8 @@ def list_interface_linked_objects( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param order_by: :type order_by: Optional[OrderBy] :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. @@ -1118,6 +1125,7 @@ def list_interface_linked_objects( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "orderBy": order_by, "pageSize": page_size, "pageToken": page_token, diff --git a/foundry_sdk/v2/ontologies/ontology_object.py b/foundry_sdk/v2/ontologies/ontology_object.py index c10161b0..df2f1033 100644 --- a/foundry_sdk/v2/ontologies/ontology_object.py +++ b/foundry_sdk/v2/ontologies/ontology_object.py @@ -200,6 +200,7 @@ def get( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, @@ -219,6 +220,8 @@ def get( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param sdk_package_rid: The package rid of the generated SDK. :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The version of the generated SDK. @@ -238,6 +241,7 @@ def get( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, "select": select, @@ -268,6 +272,7 @@ def list( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.OrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -301,6 +306,8 @@ def list( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param order_by: :type order_by: Optional[OrderBy] :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. @@ -328,6 +335,7 @@ def list( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "orderBy": order_by, "pageSize": page_size, "pageToken": page_token, @@ -364,6 +372,7 @@ def search( default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: 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, @@ -422,6 +431,8 @@ def search( :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. :type execute_in_memory_only: Optional[bool] + :param load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -472,6 +483,7 @@ def search( select=select, select_v2=select_v2, default_load_level=default_load_level, + load_ontology_defined_derived_properties=load_ontology_defined_derived_properties, exclude_rid=exclude_rid, snapshot=snapshot, reference_signing_options=reference_signing_options, @@ -690,6 +702,7 @@ def get( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, select: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, @@ -709,6 +722,8 @@ def get( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param sdk_package_rid: The package rid of the generated SDK. :type sdk_package_rid: Optional[SdkPackageRid] :param sdk_version: The version of the generated SDK. @@ -728,6 +743,7 @@ def get( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, "select": select, @@ -758,6 +774,7 @@ def list( *, branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: typing.Optional[bool] = None, order_by: typing.Optional[ontologies_models.OrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -791,6 +808,8 @@ def list( :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 load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param order_by: :type order_by: Optional[OrderBy] :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. @@ -818,6 +837,7 @@ def list( query_params={ "branch": branch, "excludeRid": exclude_rid, + "loadOntologyDefinedDerivedProperties": load_ontology_defined_derived_properties, "orderBy": order_by, "pageSize": page_size, "pageToken": page_token, @@ -854,6 +874,7 @@ def search( default_load_level: typing.Optional[ontologies_models.PropertyLoadLevel] = None, exclude_rid: typing.Optional[bool] = None, execute_in_memory_only: typing.Optional[bool] = None, + load_ontology_defined_derived_properties: 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, @@ -912,6 +933,8 @@ def search( :type exclude_rid: Optional[bool] :param execute_in_memory_only: If true, the request fails with an error when it cannot be computed in-memory. Use this to opt into fast failure on requests that would otherwise require heavier computation. Defaults to false. :type execute_in_memory_only: Optional[bool] + :param load_ontology_defined_derived_properties: A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true. Only applies when no explicit property selection is provided; when specific properties are selected, this flag has no effect and the selected properties are always returned. This feature is experimental and not yet generally available. + :type load_ontology_defined_derived_properties: Optional[bool] :param order_by: :type order_by: Optional[SearchOrderByV2] :param page_size: @@ -962,6 +985,7 @@ def search( select=select, select_v2=select_v2, default_load_level=default_load_level, + load_ontology_defined_derived_properties=load_ontology_defined_derived_properties, exclude_rid=exclude_rid, snapshot=snapshot, reference_signing_options=reference_signing_options, diff --git a/foundry_sdk/v2/ontologies/query.py b/foundry_sdk/v2/ontologies/query.py index 2c7e5c16..c38a97fd 100644 --- a/foundry_sdk/v2/ontologies/query.py +++ b/foundry_sdk/v2/ontologies/query.py @@ -104,7 +104,7 @@ def execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] - :param version: The version of the Query to execute. If not specified, the latest version is used. The latest version is the one that was most recently published, including pre-release versions. When used with `branch`, the specified version must exist on the branch. + :param version: The semantic version range of the Query to execute. Function execution selects a satisfying version from this range. If not specified, the version most recently published is used. :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] @@ -240,7 +240,7 @@ def execute( :type trace_state: Optional[TraceState] :param transaction_id: The ID of an Ontology transaction to read from. Transactions are an experimental feature and all workflows may not be supported. :type transaction_id: Optional[OntologyTransactionId] - :param version: The version of the Query to execute. If not specified, the latest version is used. The latest version is the one that was most recently published, including pre-release versions. When used with `branch`, the specified version must exist on the branch. + :param version: The semantic version range of the Query to execute. Function execution selects a satisfying version from this range. If not specified, the version most recently published is used. :type version: Optional[FunctionVersion] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] diff --git a/foundry_sdk/v2/ontologies/query_type.py b/foundry_sdk/v2/ontologies/query_type.py index a2196b2f..0fb8f407 100644 --- a/foundry_sdk/v2/ontologies/query_type.py +++ b/foundry_sdk/v2/ontologies/query_type.py @@ -62,6 +62,7 @@ def get( ontology: ontologies_models.OntologyIdentifier, query_api_name: ontologies_models.QueryApiName, *, + branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, version: typing.Optional[ontologies_models.FunctionVersion] = None, @@ -75,6 +76,8 @@ def get( :type ontology: OntologyIdentifier :param query_api_name: The API name of the query type. To find the API name, use the **List query types** endpoint or check the **Ontology Manager**. :type query_api_name: QueryApiName + :param branch: The Foundry branch to load Query metadata from. 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 version of the generated SDK. @@ -92,6 +95,7 @@ def get( method="GET", resource_path="/v2/ontologies/{ontology}/queryTypes/{queryApiName}", query_params={ + "branch": branch, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, "version": version, @@ -295,6 +299,7 @@ def get( ontology: ontologies_models.OntologyIdentifier, query_api_name: ontologies_models.QueryApiName, *, + branch: typing.Optional[core_models.FoundryBranch] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, version: typing.Optional[ontologies_models.FunctionVersion] = None, @@ -308,6 +313,8 @@ def get( :type ontology: OntologyIdentifier :param query_api_name: The API name of the query type. To find the API name, use the **List query types** endpoint or check the **Ontology Manager**. :type query_api_name: QueryApiName + :param branch: The Foundry branch to load Query metadata from. 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 version of the generated SDK. @@ -325,6 +332,7 @@ def get( method="GET", resource_path="/v2/ontologies/{ontology}/queryTypes/{queryApiName}", query_params={ + "branch": branch, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, "version": version,