diff --git a/README.md b/README.md index aaef2f4c..c6f1e40d 100644 --- a/README.md +++ b/README.md @@ -693,6 +693,7 @@ Namespace | Resource | Operation | HTTP request | **Admin** | Marking | [**get**](docs/v2/Admin/Marking.md#get) | **GET** /v2/admin/markings/{markingId} | **Admin** | Marking | [**get_batch**](docs/v2/Admin/Marking.md#get_batch) | **POST** /v2/admin/markings/getBatch | **Admin** | Marking | [**list**](docs/v2/Admin/Marking.md#list) | **GET** /v2/admin/markings | +**Admin** | Marking | [**parse_classifications**](docs/v2/Admin/Marking.md#parse_classifications) | **POST** /v2/admin/markings/parseClassifications | **Admin** | Marking | [**replace**](docs/v2/Admin/Marking.md#replace) | **PUT** /v2/admin/markings/{markingId} | **Admin** | MarkingCategory | [**create**](docs/v2/Admin/MarkingCategory.md#create) | **POST** /v2/admin/markingCategories | **Admin** | MarkingCategory | [**get**](docs/v2/Admin/MarkingCategory.md#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} | @@ -1075,6 +1076,8 @@ Namespace | Name | Import | **Admin** | [OrganizationGuestMember](docs/v2/Admin/models/OrganizationGuestMember.md) | `from foundry_sdk.v2.admin.models import OrganizationGuestMember` | **Admin** | [OrganizationName](docs/v2/Admin/models/OrganizationName.md) | `from foundry_sdk.v2.admin.models import OrganizationName` | **Admin** | [OrganizationRoleAssignment](docs/v2/Admin/models/OrganizationRoleAssignment.md) | `from foundry_sdk.v2.admin.models import OrganizationRoleAssignment` | +**Admin** | [ParseClassificationsRequest](docs/v2/Admin/models/ParseClassificationsRequest.md) | `from foundry_sdk.v2.admin.models import ParseClassificationsRequest` | +**Admin** | [ParseClassificationsResponse](docs/v2/Admin/models/ParseClassificationsResponse.md) | `from foundry_sdk.v2.admin.models import ParseClassificationsResponse` | **Admin** | [PreregisterGroupRequest](docs/v2/Admin/models/PreregisterGroupRequest.md) | `from foundry_sdk.v2.admin.models import PreregisterGroupRequest` | **Admin** | [PreregisterUserRequest](docs/v2/Admin/models/PreregisterUserRequest.md) | `from foundry_sdk.v2.admin.models import PreregisterUserRequest` | **Admin** | [PrincipalFilterType](docs/v2/Admin/models/PrincipalFilterType.md) | `from foundry_sdk.v2.admin.models import PrincipalFilterType` | @@ -2296,13 +2299,25 @@ Namespace | Name | Import | **Ontologies** | [ActionExecutionTime](docs/v2/Ontologies/models/ActionExecutionTime.md) | `from foundry_sdk.v2.ontologies.models import ActionExecutionTime` | **Ontologies** | [ActionLogicRule](docs/v2/Ontologies/models/ActionLogicRule.md) | `from foundry_sdk.v2.ontologies.models import ActionLogicRule` | **Ontologies** | [ActionParameterArrayType](docs/v2/Ontologies/models/ActionParameterArrayType.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterArrayType` | +**Ontologies** | [ActionParameterRid](docs/v2/Ontologies/models/ActionParameterRid.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterRid` | **Ontologies** | [ActionParameterType](docs/v2/Ontologies/models/ActionParameterType.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterType` | **Ontologies** | [ActionParameterV2](docs/v2/Ontologies/models/ActionParameterV2.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterV2` | **Ontologies** | [ActionResults](docs/v2/Ontologies/models/ActionResults.md) | `from foundry_sdk.v2.ontologies.models import ActionResults` | **Ontologies** | [ActionRid](docs/v2/Ontologies/models/ActionRid.md) | `from foundry_sdk.v2.ontologies.models import ActionRid` | +**Ontologies** | [ActionSectionRid](docs/v2/Ontologies/models/ActionSectionRid.md) | `from foundry_sdk.v2.ontologies.models import ActionSectionRid` | **Ontologies** | [ActionTypeApiName](docs/v2/Ontologies/models/ActionTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeApiName` | +**Ontologies** | [ActionTypeApiNameActionTypesQueryV2](docs/v2/Ontologies/models/ActionTypeApiNameActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeApiNameActionTypesQueryV2` | +**Ontologies** | [ActionTypeDescriptionActionTypesQueryV2](docs/v2/Ontologies/models/ActionTypeDescriptionActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeDescriptionActionTypesQueryV2` | +**Ontologies** | [ActionTypeDisplayNameActionTypesQueryV2](docs/v2/Ontologies/models/ActionTypeDisplayNameActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeDisplayNameActionTypesQueryV2` | **Ontologies** | [ActionTypeFullMetadata](docs/v2/Ontologies/models/ActionTypeFullMetadata.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeFullMetadata` | +**Ontologies** | [ActionTypeFuzziness](docs/v2/Ontologies/models/ActionTypeFuzziness.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeFuzziness` | +**Ontologies** | [ActionTypeLogicRuleTypeFilter](docs/v2/Ontologies/models/ActionTypeLogicRuleTypeFilter.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeLogicRuleTypeFilter` | +**Ontologies** | [ActionTypePermissionModelFilter](docs/v2/Ontologies/models/ActionTypePermissionModelFilter.md) | `from foundry_sdk.v2.ontologies.models import ActionTypePermissionModelFilter` | **Ontologies** | [ActionTypeRid](docs/v2/Ontologies/models/ActionTypeRid.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeRid` | +**Ontologies** | [ActionTypeRidActionTypesQueryV2](docs/v2/Ontologies/models/ActionTypeRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeRidActionTypesQueryV2` | +**Ontologies** | [ActionTypeSearchJsonQueryV2](docs/v2/Ontologies/models/ActionTypeSearchJsonQueryV2.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeSearchJsonQueryV2` | +**Ontologies** | [ActionTypeSortByV2](docs/v2/Ontologies/models/ActionTypeSortByV2.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeSortByV2` | +**Ontologies** | [ActionTypeStatusFilter](docs/v2/Ontologies/models/ActionTypeStatusFilter.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeStatusFilter` | **Ontologies** | [ActionTypeV2](docs/v2/Ontologies/models/ActionTypeV2.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeV2` | **Ontologies** | [ActivePropertyTypeStatus](docs/v2/Ontologies/models/ActivePropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import ActivePropertyTypeStatus` | **Ontologies** | [AddLink](docs/v2/Ontologies/models/AddLink.md) | `from foundry_sdk.v2.ontologies.models import AddLink` | @@ -2310,6 +2325,9 @@ Namespace | Name | Import | **Ontologies** | [AddObject](docs/v2/Ontologies/models/AddObject.md) | `from foundry_sdk.v2.ontologies.models import AddObject` | **Ontologies** | [AddObjectEdit](docs/v2/Ontologies/models/AddObjectEdit.md) | `from foundry_sdk.v2.ontologies.models import AddObjectEdit` | **Ontologies** | [AddPropertyExpression](docs/v2/Ontologies/models/AddPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import AddPropertyExpression` | +**Ontologies** | [AffectedInterfaceTypeRidActionTypesQueryV2](docs/v2/Ontologies/models/AffectedInterfaceTypeRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import AffectedInterfaceTypeRidActionTypesQueryV2` | +**Ontologies** | [AffectedLinkTypeRidActionTypesQueryV2](docs/v2/Ontologies/models/AffectedLinkTypeRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import AffectedLinkTypeRidActionTypesQueryV2` | +**Ontologies** | [AffectedObjectTypeRidActionTypesQueryV2](docs/v2/Ontologies/models/AffectedObjectTypeRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import AffectedObjectTypeRidActionTypesQueryV2` | **Ontologies** | [Affix](docs/v2/Ontologies/models/Affix.md) | `from foundry_sdk.v2.ontologies.models import Affix` | **Ontologies** | [AggregateObjectSetRequestV2](docs/v2/Ontologies/models/AggregateObjectSetRequestV2.md) | `from foundry_sdk.v2.ontologies.models import AggregateObjectSetRequestV2` | **Ontologies** | [AggregateObjectsRequestV2](docs/v2/Ontologies/models/AggregateObjectsRequestV2.md) | `from foundry_sdk.v2.ontologies.models import AggregateObjectsRequestV2` | @@ -2330,6 +2348,7 @@ Namespace | Name | Import | **Ontologies** | [AggregationRangeV2](docs/v2/Ontologies/models/AggregationRangeV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationRangeV2` | **Ontologies** | [AggregationV2](docs/v2/Ontologies/models/AggregationV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationV2` | **Ontologies** | [AllOfRule](docs/v2/Ontologies/models/AllOfRule.md) | `from foundry_sdk.v2.ontologies.models import AllOfRule` | +**Ontologies** | [AndActionTypesQueryV2](docs/v2/Ontologies/models/AndActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import AndActionTypesQueryV2` | **Ontologies** | [AndQueryV2](docs/v2/Ontologies/models/AndQueryV2.md) | `from foundry_sdk.v2.ontologies.models import AndQueryV2` | **Ontologies** | [AnyOfRule](docs/v2/Ontologies/models/AnyOfRule.md) | `from foundry_sdk.v2.ontologies.models import AnyOfRule` | **Ontologies** | [ApplyActionMode](docs/v2/Ontologies/models/ApplyActionMode.md) | `from foundry_sdk.v2.ontologies.models import ApplyActionMode` | @@ -2449,10 +2468,16 @@ Namespace | Name | Import | **Ontologies** | [ExtractPropertyExpression](docs/v2/Ontologies/models/ExtractPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import ExtractPropertyExpression` | **Ontologies** | [FilterValue](docs/v2/Ontologies/models/FilterValue.md) | `from foundry_sdk.v2.ontologies.models import FilterValue` | **Ontologies** | [FixedValuesMapKey](docs/v2/Ontologies/models/FixedValuesMapKey.md) | `from foundry_sdk.v2.ontologies.models import FixedValuesMapKey` | +**Ontologies** | [FullTextStringContainsPredicate](docs/v2/Ontologies/models/FullTextStringContainsPredicate.md) | `from foundry_sdk.v2.ontologies.models import FullTextStringContainsPredicate` | +**Ontologies** | [FullTextStringExactPredicate](docs/v2/Ontologies/models/FullTextStringExactPredicate.md) | `from foundry_sdk.v2.ontologies.models import FullTextStringExactPredicate` | +**Ontologies** | [FullTextStringPredicateV2](docs/v2/Ontologies/models/FullTextStringPredicateV2.md) | `from foundry_sdk.v2.ontologies.models import FullTextStringPredicateV2` | **Ontologies** | [FunctionLogicRule](docs/v2/Ontologies/models/FunctionLogicRule.md) | `from foundry_sdk.v2.ontologies.models import FunctionLogicRule` | **Ontologies** | [FunctionParameterName](docs/v2/Ontologies/models/FunctionParameterName.md) | `from foundry_sdk.v2.ontologies.models import FunctionParameterName` | **Ontologies** | [FunctionRid](docs/v2/Ontologies/models/FunctionRid.md) | `from foundry_sdk.v2.ontologies.models import FunctionRid` | +**Ontologies** | [FunctionRidActionTypesQueryV2](docs/v2/Ontologies/models/FunctionRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import FunctionRidActionTypesQueryV2` | **Ontologies** | [FunctionVersion](docs/v2/Ontologies/models/FunctionVersion.md) | `from foundry_sdk.v2.ontologies.models import FunctionVersion` | +**Ontologies** | [FuzzinessAuto](docs/v2/Ontologies/models/FuzzinessAuto.md) | `from foundry_sdk.v2.ontologies.models import FuzzinessAuto` | +**Ontologies** | [FuzzinessOff](docs/v2/Ontologies/models/FuzzinessOff.md) | `from foundry_sdk.v2.ontologies.models import FuzzinessOff` | **Ontologies** | [FuzzyRule](docs/v2/Ontologies/models/FuzzyRule.md) | `from foundry_sdk.v2.ontologies.models import FuzzyRule` | **Ontologies** | [FuzzyV2](docs/v2/Ontologies/models/FuzzyV2.md) | `from foundry_sdk.v2.ontologies.models import FuzzyV2` | **Ontologies** | [GeoJsonString](docs/v2/Ontologies/models/GeoJsonString.md) | `from foundry_sdk.v2.ontologies.models import GeoJsonString` | @@ -2474,8 +2499,12 @@ Namespace | Name | Import | **Ontologies** | [GroupMemberConstraint](docs/v2/Ontologies/models/GroupMemberConstraint.md) | `from foundry_sdk.v2.ontologies.models import GroupMemberConstraint` | **Ontologies** | [GteQueryV2](docs/v2/Ontologies/models/GteQueryV2.md) | `from foundry_sdk.v2.ontologies.models import GteQueryV2` | **Ontologies** | [GtQueryV2](docs/v2/Ontologies/models/GtQueryV2.md) | `from foundry_sdk.v2.ontologies.models import GtQueryV2` | +**Ontologies** | [HasActionLogActionTypesQueryV2](docs/v2/Ontologies/models/HasActionLogActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import HasActionLogActionTypesQueryV2` | +**Ontologies** | [HasNotificationActionTypesQueryV2](docs/v2/Ontologies/models/HasNotificationActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import HasNotificationActionTypesQueryV2` | +**Ontologies** | [HasWebhookActionTypesQueryV2](docs/v2/Ontologies/models/HasWebhookActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import HasWebhookActionTypesQueryV2` | **Ontologies** | [HumanReadableFormat](docs/v2/Ontologies/models/HumanReadableFormat.md) | `from foundry_sdk.v2.ontologies.models import HumanReadableFormat` | **Ontologies** | [Icon](docs/v2/Ontologies/models/Icon.md) | `from foundry_sdk.v2.ontologies.models import Icon` | +**Ontologies** | [InputObjectTypeRidActionTypesQueryV2](docs/v2/Ontologies/models/InputObjectTypeRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import InputObjectTypeRidActionTypesQueryV2` | **Ontologies** | [InQuery](docs/v2/Ontologies/models/InQuery.md) | `from foundry_sdk.v2.ontologies.models import InQuery` | **Ontologies** | [IntegerValue](docs/v2/Ontologies/models/IntegerValue.md) | `from foundry_sdk.v2.ontologies.models import IntegerValue` | **Ontologies** | [InterfaceDefinedPropertyType](docs/v2/Ontologies/models/InterfaceDefinedPropertyType.md) | `from foundry_sdk.v2.ontologies.models import InterfaceDefinedPropertyType` | @@ -2551,6 +2580,7 @@ Namespace | Name | Import | **Ontologies** | [LoadObjectSetV2ObjectsOrInterfacesResponse](docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponse.md) | `from foundry_sdk.v2.ontologies.models import LoadObjectSetV2ObjectsOrInterfacesResponse` | **Ontologies** | [LoadOntologyMetadataRequest](docs/v2/Ontologies/models/LoadOntologyMetadataRequest.md) | `from foundry_sdk.v2.ontologies.models import LoadOntologyMetadataRequest` | **Ontologies** | [LogicRule](docs/v2/Ontologies/models/LogicRule.md) | `from foundry_sdk.v2.ontologies.models import LogicRule` | +**Ontologies** | [LogicRuleActionTypesQueryV2](docs/v2/Ontologies/models/LogicRuleActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import LogicRuleActionTypesQueryV2` | **Ontologies** | [LogicRuleArgument](docs/v2/Ontologies/models/LogicRuleArgument.md) | `from foundry_sdk.v2.ontologies.models import LogicRuleArgument` | **Ontologies** | [LongValue](docs/v2/Ontologies/models/LongValue.md) | `from foundry_sdk.v2.ontologies.models import LongValue` | **Ontologies** | [LteQueryV2](docs/v2/Ontologies/models/LteQueryV2.md) | `from foundry_sdk.v2.ontologies.models import LteQueryV2` | @@ -2663,6 +2693,7 @@ Namespace | Name | Import | **Ontologies** | [OntologyTransactionId](docs/v2/Ontologies/models/OntologyTransactionId.md) | `from foundry_sdk.v2.ontologies.models import OntologyTransactionId` | **Ontologies** | [OntologyV2](docs/v2/Ontologies/models/OntologyV2.md) | `from foundry_sdk.v2.ontologies.models import OntologyV2` | **Ontologies** | [OntologyValueType](docs/v2/Ontologies/models/OntologyValueType.md) | `from foundry_sdk.v2.ontologies.models import OntologyValueType` | +**Ontologies** | [OrActionTypesQueryV2](docs/v2/Ontologies/models/OrActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import OrActionTypesQueryV2` | **Ontologies** | [OrderBy](docs/v2/Ontologies/models/OrderBy.md) | `from foundry_sdk.v2.ontologies.models import OrderBy` | **Ontologies** | [OrderByDirection](docs/v2/Ontologies/models/OrderByDirection.md) | `from foundry_sdk.v2.ontologies.models import OrderByDirection` | **Ontologies** | [OrQueryV2](docs/v2/Ontologies/models/OrQueryV2.md) | `from foundry_sdk.v2.ontologies.models import OrQueryV2` | @@ -2670,7 +2701,10 @@ Namespace | Name | Import | **Ontologies** | [ParameterEvaluationResult](docs/v2/Ontologies/models/ParameterEvaluationResult.md) | `from foundry_sdk.v2.ontologies.models import ParameterEvaluationResult` | **Ontologies** | [ParameterId](docs/v2/Ontologies/models/ParameterId.md) | `from foundry_sdk.v2.ontologies.models import ParameterId` | **Ontologies** | [ParameterIdArgument](docs/v2/Ontologies/models/ParameterIdArgument.md) | `from foundry_sdk.v2.ontologies.models import ParameterIdArgument` | +**Ontologies** | [ParameterNameActionTypesQueryV2](docs/v2/Ontologies/models/ParameterNameActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import ParameterNameActionTypesQueryV2` | **Ontologies** | [ParameterOption](docs/v2/Ontologies/models/ParameterOption.md) | `from foundry_sdk.v2.ontologies.models import ParameterOption` | +**Ontologies** | [ParameterRidActionTypesQueryV2](docs/v2/Ontologies/models/ParameterRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import ParameterRidActionTypesQueryV2` | +**Ontologies** | [PermissionModelActionTypesQueryV2](docs/v2/Ontologies/models/PermissionModelActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import PermissionModelActionTypesQueryV2` | **Ontologies** | [Plaintext](docs/v2/Ontologies/models/Plaintext.md) | `from foundry_sdk.v2.ontologies.models import Plaintext` | **Ontologies** | [PolygonValue](docs/v2/Ontologies/models/PolygonValue.md) | `from foundry_sdk.v2.ontologies.models import PolygonValue` | **Ontologies** | [PostTransactionEditsRequest](docs/v2/Ontologies/models/PostTransactionEditsRequest.md) | `from foundry_sdk.v2.ontologies.models import PostTransactionEditsRequest` | @@ -2748,11 +2782,15 @@ Namespace | Name | Import | **Ontologies** | [RequestId](docs/v2/Ontologies/models/RequestId.md) | `from foundry_sdk.v2.ontologies.models import RequestId` | **Ontologies** | [ResolvedInterfacePropertyType](docs/v2/Ontologies/models/ResolvedInterfacePropertyType.md) | `from foundry_sdk.v2.ontologies.models import ResolvedInterfacePropertyType` | **Ontologies** | [ReturnEditsMode](docs/v2/Ontologies/models/ReturnEditsMode.md) | `from foundry_sdk.v2.ontologies.models import ReturnEditsMode` | +**Ontologies** | [RevertActionEnabledActionTypesQueryV2](docs/v2/Ontologies/models/RevertActionEnabledActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import RevertActionEnabledActionTypesQueryV2` | **Ontologies** | [RidConstraint](docs/v2/Ontologies/models/RidConstraint.md) | `from foundry_sdk.v2.ontologies.models import RidConstraint` | **Ontologies** | [RollingAggregateWindowPoints](docs/v2/Ontologies/models/RollingAggregateWindowPoints.md) | `from foundry_sdk.v2.ontologies.models import RollingAggregateWindowPoints` | **Ontologies** | [SdkPackageName](docs/v2/Ontologies/models/SdkPackageName.md) | `from foundry_sdk.v2.ontologies.models import SdkPackageName` | **Ontologies** | [SdkPackageRid](docs/v2/Ontologies/models/SdkPackageRid.md) | `from foundry_sdk.v2.ontologies.models import SdkPackageRid` | **Ontologies** | [SdkVersion](docs/v2/Ontologies/models/SdkVersion.md) | `from foundry_sdk.v2.ontologies.models import SdkVersion` | +**Ontologies** | [SearchActionTypesOrderByV2](docs/v2/Ontologies/models/SearchActionTypesOrderByV2.md) | `from foundry_sdk.v2.ontologies.models import SearchActionTypesOrderByV2` | +**Ontologies** | [SearchActionTypesRequestV2](docs/v2/Ontologies/models/SearchActionTypesRequestV2.md) | `from foundry_sdk.v2.ontologies.models import SearchActionTypesRequestV2` | +**Ontologies** | [SearchActionTypesResponseV2](docs/v2/Ontologies/models/SearchActionTypesResponseV2.md) | `from foundry_sdk.v2.ontologies.models import SearchActionTypesResponseV2` | **Ontologies** | [SearchJsonQueryV2](docs/v2/Ontologies/models/SearchJsonQueryV2.md) | `from foundry_sdk.v2.ontologies.models import SearchJsonQueryV2` | **Ontologies** | [SearchObjectsForInterfaceRequest](docs/v2/Ontologies/models/SearchObjectsForInterfaceRequest.md) | `from foundry_sdk.v2.ontologies.models import SearchObjectsForInterfaceRequest` | **Ontologies** | [SearchObjectsRequestV2](docs/v2/Ontologies/models/SearchObjectsRequestV2.md) | `from foundry_sdk.v2.ontologies.models import SearchObjectsRequestV2` | @@ -2760,6 +2798,7 @@ Namespace | Name | Import | **Ontologies** | [SearchOrderByType](docs/v2/Ontologies/models/SearchOrderByType.md) | `from foundry_sdk.v2.ontologies.models import SearchOrderByType` | **Ontologies** | [SearchOrderByV2](docs/v2/Ontologies/models/SearchOrderByV2.md) | `from foundry_sdk.v2.ontologies.models import SearchOrderByV2` | **Ontologies** | [SearchOrderingV2](docs/v2/Ontologies/models/SearchOrderingV2.md) | `from foundry_sdk.v2.ontologies.models import SearchOrderingV2` | +**Ontologies** | [SectionRidActionTypesQueryV2](docs/v2/Ontologies/models/SectionRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import SectionRidActionTypesQueryV2` | **Ontologies** | [SelectedPropertyApiName](docs/v2/Ontologies/models/SelectedPropertyApiName.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyApiName` | **Ontologies** | [SelectedPropertyApproximateDistinctAggregation](docs/v2/Ontologies/models/SelectedPropertyApproximateDistinctAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyApproximateDistinctAggregation` | **Ontologies** | [SelectedPropertyApproximatePercentileAggregation](docs/v2/Ontologies/models/SelectedPropertyApproximatePercentileAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyApproximatePercentileAggregation` | @@ -2779,6 +2818,7 @@ Namespace | Name | Import | **Ontologies** | [SpatialFilterMode](docs/v2/Ontologies/models/SpatialFilterMode.md) | `from foundry_sdk.v2.ontologies.models import SpatialFilterMode` | **Ontologies** | [StartsWithQuery](docs/v2/Ontologies/models/StartsWithQuery.md) | `from foundry_sdk.v2.ontologies.models import StartsWithQuery` | **Ontologies** | [StaticArgument](docs/v2/Ontologies/models/StaticArgument.md) | `from foundry_sdk.v2.ontologies.models import StaticArgument` | +**Ontologies** | [StatusActionTypesQueryV2](docs/v2/Ontologies/models/StatusActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import StatusActionTypesQueryV2` | **Ontologies** | [StreamingOutputFormat](docs/v2/Ontologies/models/StreamingOutputFormat.md) | `from foundry_sdk.v2.ontologies.models import StreamingOutputFormat` | **Ontologies** | [StreamMessage](docs/v2/Ontologies/models/StreamMessage.md) | `from foundry_sdk.v2.ontologies.models import StreamMessage` | **Ontologies** | [StreamTimeSeriesPointsRequest](docs/v2/Ontologies/models/StreamTimeSeriesPointsRequest.md) | `from foundry_sdk.v2.ontologies.models import StreamTimeSeriesPointsRequest` | @@ -2830,6 +2870,8 @@ Namespace | Name | Import | **Ontologies** | [TransactionEdit](docs/v2/Ontologies/models/TransactionEdit.md) | `from foundry_sdk.v2.ontologies.models import TransactionEdit` | **Ontologies** | [TwoDimensionalAggregation](docs/v2/Ontologies/models/TwoDimensionalAggregation.md) | `from foundry_sdk.v2.ontologies.models import TwoDimensionalAggregation` | **Ontologies** | [TypeClass](docs/v2/Ontologies/models/TypeClass.md) | `from foundry_sdk.v2.ontologies.models import TypeClass` | +**Ontologies** | [TypeClassesActionTypesQueryV2](docs/v2/Ontologies/models/TypeClassesActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import TypeClassesActionTypesQueryV2` | +**Ontologies** | [TypeClassPredicateV2](docs/v2/Ontologies/models/TypeClassPredicateV2.md) | `from foundry_sdk.v2.ontologies.models import TypeClassPredicateV2` | **Ontologies** | [TypeReferenceIdentifier](docs/v2/Ontologies/models/TypeReferenceIdentifier.md) | `from foundry_sdk.v2.ontologies.models import TypeReferenceIdentifier` | **Ontologies** | [UnevaluableConstraint](docs/v2/Ontologies/models/UnevaluableConstraint.md) | `from foundry_sdk.v2.ontologies.models import UnevaluableConstraint` | **Ontologies** | [UniqueIdentifierArgument](docs/v2/Ontologies/models/UniqueIdentifierArgument.md) | `from foundry_sdk.v2.ontologies.models import UniqueIdentifierArgument` | @@ -2854,6 +2896,8 @@ Namespace | Name | Import | **Ontologies** | [ValueTypeStructType](docs/v2/Ontologies/models/ValueTypeStructType.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeStructType` | **Ontologies** | [ValueTypeUnionType](docs/v2/Ontologies/models/ValueTypeUnionType.md) | `from foundry_sdk.v2.ontologies.models import ValueTypeUnionType` | **Ontologies** | [VersionedQueryTypeApiName](docs/v2/Ontologies/models/VersionedQueryTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import VersionedQueryTypeApiName` | +**Ontologies** | [WebhookRid](docs/v2/Ontologies/models/WebhookRid.md) | `from foundry_sdk.v2.ontologies.models import WebhookRid` | +**Ontologies** | [WebhookRidActionTypesQueryV2](docs/v2/Ontologies/models/WebhookRidActionTypesQueryV2.md) | `from foundry_sdk.v2.ontologies.models import WebhookRidActionTypesQueryV2` | **Ontologies** | [WildcardQuery](docs/v2/Ontologies/models/WildcardQuery.md) | `from foundry_sdk.v2.ontologies.models import WildcardQuery` | **Ontologies** | [WithinBoundingBoxPoint](docs/v2/Ontologies/models/WithinBoundingBoxPoint.md) | `from foundry_sdk.v2.ontologies.models import WithinBoundingBoxPoint` | **Ontologies** | [WithinBoundingBoxQuery](docs/v2/Ontologies/models/WithinBoundingBoxQuery.md) | `from foundry_sdk.v2.ontologies.models import WithinBoundingBoxQuery` | @@ -3365,6 +3409,7 @@ Namespace | Name | Import | **Admin** | OrganizationMarkingAdministerRoleNotSupported | `from foundry_sdk.v2.admin.errors import OrganizationMarkingAdministerRoleNotSupported` | **Admin** | OrganizationNameAlreadyExists | `from foundry_sdk.v2.admin.errors import OrganizationNameAlreadyExists` | **Admin** | OrganizationNotFound | `from foundry_sdk.v2.admin.errors import OrganizationNotFound` | +**Admin** | ParseClassificationsPermissionDenied | `from foundry_sdk.v2.admin.errors import ParseClassificationsPermissionDenied` | **Admin** | PreregisterGroupPermissionDenied | `from foundry_sdk.v2.admin.errors import PreregisterGroupPermissionDenied` | **Admin** | PreregisterUserPermissionDenied | `from foundry_sdk.v2.admin.errors import PreregisterUserPermissionDenied` | **Admin** | PrincipalNotFound | `from foundry_sdk.v2.admin.errors import PrincipalNotFound` | @@ -3679,6 +3724,7 @@ Namespace | Name | Import | **Functions** | QueryRuntimeError | `from foundry_sdk.v2.functions.errors import QueryRuntimeError` | **Functions** | QueryTimeExceededLimit | `from foundry_sdk.v2.functions.errors import QueryTimeExceededLimit` | **Functions** | QueryVersionNotFound | `from foundry_sdk.v2.functions.errors import QueryVersionNotFound` | +**Functions** | StreamingExecuteEventsQueryPermissionDenied | `from foundry_sdk.v2.functions.errors import StreamingExecuteEventsQueryPermissionDenied` | **Functions** | StreamingExecuteQueryPermissionDenied | `from foundry_sdk.v2.functions.errors import StreamingExecuteQueryPermissionDenied` | **Functions** | UnknownParameter | `from foundry_sdk.v2.functions.errors import UnknownParameter` | **Functions** | ValueTypeNotFound | `from foundry_sdk.v2.functions.errors import ValueTypeNotFound` | @@ -3949,7 +3995,11 @@ Namespace | Name | Import | **SqlQueries** | ExecuteSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ExecuteSqlQueryPermissionDenied` | **SqlQueries** | GetResultsSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetResultsSqlQueryPermissionDenied` | **SqlQueries** | GetStatusSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetStatusSqlQueryPermissionDenied` | +**SqlQueries** | OntologyObjectTypeNotFound | `from foundry_sdk.v2.sql_queries.errors import OntologyObjectTypeNotFound` | **SqlQueries** | OntologyQueryFailed | `from foundry_sdk.v2.sql_queries.errors import OntologyQueryFailed` | +**SqlQueries** | OntologyQueryInvalidObjectBackend | `from foundry_sdk.v2.sql_queries.errors import OntologyQueryInvalidObjectBackend` | +**SqlQueries** | OntologyQueryNestedObjectSetTooLarge | `from foundry_sdk.v2.sql_queries.errors import OntologyQueryNestedObjectSetTooLarge` | +**SqlQueries** | OntologyQueryStringColumnTooLong | `from foundry_sdk.v2.sql_queries.errors import OntologyQueryStringColumnTooLong` | **SqlQueries** | QueryCanceled | `from foundry_sdk.v2.sql_queries.errors import QueryCanceled` | **SqlQueries** | QueryFailed | `from foundry_sdk.v2.sql_queries.errors import QueryFailed` | **SqlQueries** | QueryParseError | `from foundry_sdk.v2.sql_queries.errors import QueryParseError` | diff --git a/docs-snippets-npm/package.json b/docs-snippets-npm/package.json index 2fad911a..6010e650 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.1630.0", + "minVersion": "1.1642.1", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index 32e1e5ff..d2504ec8 100644 --- a/docs-snippets-npm/src/index.ts +++ b/docs-snippets-npm/src/index.ts @@ -393,6 +393,11 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets admin_models.ParseClassificationsResponse: + """ + Parses classification marking strings (e.g. 'S//NF') into their component marking IDs. Strings that cannot be parsed are returned in 'errors' with a human-readable message. + :param classification_strings: The classification strings to parse, e.g. 'S//NF'. Duplicate entries are ignored. At most 1000 entries are accepted. + :type classification_strings: List[str] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: admin_models.ParseClassificationsResponse + + :raises CbacUnavailable: CBAC is not available. + :raises ParseClassificationsPermissionDenied: The provided token does not have permission to parse the given classification strings. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/admin/markings/parseClassifications", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=admin_models.ParseClassificationsRequest( + classification_strings=classification_strings, + ), + response_type=admin_models.ParseClassificationsResponse, + request_timeout=request_timeout, + throwable_errors={ + "CbacUnavailable": admin_errors.CbacUnavailable, + "ParseClassificationsPermissionDenied": admin_errors.ParseClassificationsPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -354,12 +405,16 @@ def create(_: admin_models.Marking): ... def get(_: admin_models.Marking): ... def get_batch(_: admin_models.GetMarkingsBatchResponse): ... def list(_: admin_models.ListMarkingsResponse): ... + def parse_classifications(_: admin_models.ParseClassificationsResponse): ... def replace(_: admin_models.Marking): ... self.create = core.with_raw_response(create, client.create) self.get = core.with_raw_response(get, client.get) self.get_batch = core.with_raw_response(get_batch, client.get_batch) self.list = core.with_raw_response(list, client.list) + self.parse_classifications = core.with_raw_response( + parse_classifications, client.parse_classifications + ) self.replace = core.with_raw_response(replace, client.replace) @@ -369,12 +424,16 @@ def create(_: admin_models.Marking): ... def get(_: admin_models.Marking): ... def get_batch(_: admin_models.GetMarkingsBatchResponse): ... def list(_: admin_models.ListMarkingsResponse): ... + def parse_classifications(_: admin_models.ParseClassificationsResponse): ... def replace(_: admin_models.Marking): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.get_batch = core.with_streaming_response(get_batch, client.get_batch) self.list = core.with_streaming_response(list, client.list) + self.parse_classifications = core.with_streaming_response( + parse_classifications, client.parse_classifications + ) self.replace = core.with_streaming_response(replace, client.replace) @@ -636,6 +695,57 @@ def list( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def parse_classifications( + self, + *, + classification_strings: typing.List[str], + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[admin_models.ParseClassificationsResponse]: + """ + Parses classification marking strings (e.g. 'S//NF') into their component marking IDs. Strings that cannot be parsed are returned in 'errors' with a human-readable message. + :param classification_strings: The classification strings to parse, e.g. 'S//NF'. Duplicate entries are ignored. At most 1000 entries are accepted. + :type classification_strings: List[str] + :param preview: Enables the use of preview functionality. + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: typing.Awaitable[admin_models.ParseClassificationsResponse] + + :raises CbacUnavailable: CBAC is not available. + :raises ParseClassificationsPermissionDenied: The provided token does not have permission to parse the given classification strings. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/admin/markings/parseClassifications", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=admin_models.ParseClassificationsRequest( + classification_strings=classification_strings, + ), + response_type=admin_models.ParseClassificationsResponse, + request_timeout=request_timeout, + throwable_errors={ + "CbacUnavailable": admin_errors.CbacUnavailable, + "ParseClassificationsPermissionDenied": admin_errors.ParseClassificationsPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -706,12 +816,16 @@ def create(_: admin_models.Marking): ... def get(_: admin_models.Marking): ... def get_batch(_: admin_models.GetMarkingsBatchResponse): ... def list(_: admin_models.ListMarkingsResponse): ... + def parse_classifications(_: admin_models.ParseClassificationsResponse): ... def replace(_: admin_models.Marking): ... self.create = core.async_with_raw_response(create, client.create) self.get = core.async_with_raw_response(get, client.get) self.get_batch = core.async_with_raw_response(get_batch, client.get_batch) self.list = core.async_with_raw_response(list, client.list) + self.parse_classifications = core.async_with_raw_response( + parse_classifications, client.parse_classifications + ) self.replace = core.async_with_raw_response(replace, client.replace) @@ -721,10 +835,14 @@ def create(_: admin_models.Marking): ... def get(_: admin_models.Marking): ... def get_batch(_: admin_models.GetMarkingsBatchResponse): ... def list(_: admin_models.ListMarkingsResponse): ... + def parse_classifications(_: admin_models.ParseClassificationsResponse): ... def replace(_: admin_models.Marking): ... self.create = core.async_with_streaming_response(create, client.create) self.get = core.async_with_streaming_response(get, client.get) self.get_batch = core.async_with_streaming_response(get_batch, client.get_batch) self.list = core.async_with_streaming_response(list, client.list) + self.parse_classifications = core.async_with_streaming_response( + parse_classifications, client.parse_classifications + ) self.replace = core.async_with_streaming_response(replace, client.replace) diff --git a/foundry_sdk/v2/admin/models.py b/foundry_sdk/v2/admin/models.py index eda07f8d..bbf8f3e7 100644 --- a/foundry_sdk/v2/admin/models.py +++ b/foundry_sdk/v2/admin/models.py @@ -664,6 +664,23 @@ class OrganizationRoleAssignment(core.ModelBase): role_id: core_models.RoleId = pydantic.Field(alias=str("roleId")) # type: ignore[literal-required] +class ParseClassificationsRequest(core.ModelBase): + """ParseClassificationsRequest""" + + classification_strings: typing.List[str] = pydantic.Field(alias=str("classificationStrings")) # type: ignore[literal-required] + """The classification strings to parse, e.g. 'S//NF'. Duplicate entries are ignored. At most 1000 entries are accepted.""" + + +class ParseClassificationsResponse(core.ModelBase): + """ParseClassificationsResponse""" + + parsed: typing.Dict[str, typing.List[core_models.MarkingId]] + """Map of valid classification strings to their component marking IDs. Strings that could not be parsed are absent from this map and appear in 'errors' instead.""" + + errors: typing.Dict[str, str] + """Map of classification strings that could not be parsed to a human-readable error message.""" + + class PreregisterGroupRequest(core.ModelBase): """PreregisterGroupRequest""" @@ -1026,6 +1043,8 @@ class UserSearchFilter(core.ModelBase): "OrganizationGuestMember", "OrganizationName", "OrganizationRoleAssignment", + "ParseClassificationsRequest", + "ParseClassificationsResponse", "PreregisterGroupRequest", "PreregisterUserRequest", "PrincipalFilterType", diff --git a/foundry_sdk/v2/cli.py b/foundry_sdk/v2/cli.py index fdac65ee..6e961841 100644 --- a/foundry_sdk/v2/cli.py +++ b/foundry_sdk/v2/cli.py @@ -876,6 +876,32 @@ def admin_marking_op_list( click.echo(repr(result)) +@admin_marking.command("parse_classifications") +@click.option( + "--classification_strings", + type=str, + required=True, + help="""The classification strings to parse, e.g. 'S//NF'. Duplicate entries are ignored. At most 1000 entries are accepted.""", +) +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) +@click.pass_obj +def admin_marking_op_parse_classifications( + client: FoundryClient, + classification_strings: str, + preview: typing.Optional[bool], +): + """ + Parses classification marking strings (e.g. 'S//NF') into their component marking IDs. Strings that cannot be parsed are returned in 'errors' with a human-readable message. + """ + result = client.admin.Marking.parse_classifications( + classification_strings=json.loads(classification_strings), + preview=preview, + ) + click.echo(repr(result)) + + @admin_marking.command("replace") @click.argument("marking_id", type=str, required=True) @click.option("--name", type=str, required=True, help="""""") @@ -5656,7 +5682,7 @@ def functions_query(): "--transaction_id", type=str, required=False, - help="""The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.""", + help="""The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported.""", ) @click.option( "--version", @@ -5731,7 +5757,7 @@ def functions_query_op_execute( "--transaction_id", type=str, required=False, - help="""The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.""", + help="""The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported.""", ) @click.option( "--version", @@ -5896,7 +5922,7 @@ def functions_query_op_get_by_rid_batch( "--transaction_id", type=str, required=False, - help="""The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.""", + help="""The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported.""", ) @click.option( "--version", @@ -8356,6 +8382,7 @@ def ontologies_query_op_execute( ): """ Executes a Query using the given parameters. By default, the latest version of the Query is executed. + The latest version is the one that was most recently published, which may be a pre-release version. Optional parameters do not need to be supplied. @@ -8977,6 +9004,17 @@ def ontologies_ontology_object_set_op_get( Setting this to true may improve performance of this endpoint for object types in OSV2. """, ) +@click.option( + "--execute_in_memory_only", + type=bool, + required=False, + help="""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. +""", +) @click.option("--include_compute_usage", type=bool, required=False, help="""""") @click.option( "--load_property_securities", @@ -9061,6 +9099,7 @@ def ontologies_ontology_object_set_op_load( select: str, branch: typing.Optional[str], exclude_rid: typing.Optional[bool], + execute_in_memory_only: typing.Optional[bool], include_compute_usage: typing.Optional[bool], load_property_securities: typing.Optional[bool], order_by: typing.Optional[str], @@ -9092,6 +9131,7 @@ def ontologies_ontology_object_set_op_load( select=json.loads(select), branch=branch, exclude_rid=exclude_rid, + execute_in_memory_only=execute_in_memory_only, 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), @@ -9239,6 +9279,17 @@ def ontologies_ontology_object_set_op_load_links( Setting this to true may improve performance of this endpoint for object types in OSV2. """, ) +@click.option( + "--execute_in_memory_only", + type=bool, + required=False, + help="""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. +""", +) @click.option("--include_compute_usage", type=bool, required=False, help="""""") @click.option( "--load_property_securities", @@ -9330,6 +9381,7 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( select: str, branch: typing.Optional[str], exclude_rid: typing.Optional[bool], + execute_in_memory_only: typing.Optional[bool], include_compute_usage: typing.Optional[bool], load_property_securities: typing.Optional[bool], order_by: typing.Optional[str], @@ -9367,6 +9419,7 @@ def ontologies_ontology_object_set_op_load_multiple_object_types( select=json.loads(select), branch=branch, exclude_rid=exclude_rid, + execute_in_memory_only=execute_in_memory_only, 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), @@ -11373,6 +11426,62 @@ def ontologies_ontology_action_type_op_list( click.echo(repr(result)) +@ontologies_ontology_action_type.command("search") +@click.argument("ontology", type=str, required=True) +@click.option( + "--branch", + type=str, + required=False, + help="""The Foundry branch to search the action types from. If not specified, the default branch will be used. +Branches are an experimental feature and not all workflows are supported. +""", +) +@click.option("--fuzziness", type=str, required=False, help="""""") +@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="""""") +@click.option( + "--preview", + type=bool, + required=False, + help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. +""", +) +@click.option("--where", type=str, required=False, help="""""") +@click.pass_obj +def ontologies_ontology_action_type_op_search( + client: FoundryClient, + ontology: str, + branch: typing.Optional[str], + fuzziness: typing.Optional[str], + order_by: typing.Optional[str], + page_size: typing.Optional[int], + page_token: typing.Optional[str], + preview: typing.Optional[bool], + where: typing.Optional[str], +): + """ + Search for action types in the given Ontology that match the provided filters. Results are returned by + relevance of the match unless an explicit `orderBy` is provided. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. Search results are eventually + consistent with the latest Ontology version and may lag slightly behind the last Ontology modification. + + """ + result = client.ontologies.Ontology.ActionType.search( + ontology=ontology, + branch=branch, + fuzziness=None if fuzziness is None else json.loads(fuzziness), + order_by=None if order_by is None else json.loads(order_by), + page_size=page_size, + page_token=page_token, + preview=preview, + where=None if where is None else json.loads(where), + ) + click.echo(repr(result)) + + @ontologies.group("media_reference_property") def ontologies_media_reference_property(): pass @@ -11383,6 +11492,13 @@ def ontologies_media_reference_property(): @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @click.argument("property", type=str, required=True) +@click.option( + "--branch", + type=str, + required=False, + help="""The Foundry branch to read from. If not specified, the default branch will be used. +""", +) @click.option( "--preview", type=bool, @@ -11411,6 +11527,7 @@ def ontologies_media_reference_property_op_get_media_content( object_type: str, primary_key: str, property: str, + branch: typing.Optional[str], preview: typing.Optional[bool], sdk_package_rid: typing.Optional[str], sdk_version: typing.Optional[str], @@ -11424,6 +11541,7 @@ def ontologies_media_reference_property_op_get_media_content( object_type=object_type, primary_key=primary_key, property=property, + branch=branch, preview=preview, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, @@ -11436,6 +11554,13 @@ def ontologies_media_reference_property_op_get_media_content( @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @click.argument("property", type=str, required=True) +@click.option( + "--branch", + type=str, + required=False, + help="""The Foundry branch to read from. If not specified, the default branch will be used. +""", +) @click.option( "--preview", type=bool, @@ -11464,6 +11589,7 @@ def ontologies_media_reference_property_op_get_media_metadata( object_type: str, primary_key: str, property: str, + branch: typing.Optional[str], preview: typing.Optional[bool], sdk_package_rid: typing.Optional[str], sdk_version: typing.Optional[str], @@ -11477,6 +11603,7 @@ def ontologies_media_reference_property_op_get_media_metadata( object_type=object_type, primary_key=primary_key, property=property, + branch=branch, preview=preview, sdk_package_rid=sdk_package_rid, sdk_version=sdk_version, diff --git a/foundry_sdk/v2/functions/errors.py b/foundry_sdk/v2/functions/errors.py index fa2324f8..f730ed5b 100644 --- a/foundry_sdk/v2/functions/errors.py +++ b/foundry_sdk/v2/functions/errors.py @@ -481,6 +481,21 @@ class QueryVersionNotFound(errors.NotFoundError): error_instance_id: str +class StreamingExecuteEventsQueryPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not streamingExecuteEvents the Query.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + queryApiName: functions_models.QueryApiName + + +@dataclass +class StreamingExecuteEventsQueryPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["StreamingExecuteEventsQueryPermissionDenied"] + parameters: StreamingExecuteEventsQueryPermissionDeniedParameters + error_instance_id: str + + class StreamingExecuteQueryPermissionDeniedParameters(typing_extensions.TypedDict): """Could not streamingExecute the Query.""" @@ -574,6 +589,7 @@ class VersionIdNotFound(errors.NotFoundError): "QueryRuntimeError", "QueryTimeExceededLimit", "QueryVersionNotFound", + "StreamingExecuteEventsQueryPermissionDenied", "StreamingExecuteQueryPermissionDenied", "UnknownParameter", "ValueTypeNotFound", diff --git a/foundry_sdk/v2/functions/query.py b/foundry_sdk/v2/functions/query.py index 5a1aa717..53639392 100644 --- a/foundry_sdk/v2/functions/query.py +++ b/foundry_sdk/v2/functions/query.py @@ -98,7 +98,7 @@ def execute( :type trace_parent: Optional[TraceParent] :param trace_state: :type trace_state: Optional[TraceState] - :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. + :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported. :type transaction_id: Optional[TransactionId] :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. :type version: Optional[FunctionVersion] @@ -186,7 +186,7 @@ def execute_async( :type trace_parent: Optional[TraceParent] :param trace_state: :type trace_state: Optional[TraceState] - :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. + :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported. :type transaction_id: Optional[TransactionId] :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. :type version: Optional[FunctionVersion] @@ -455,7 +455,7 @@ def streaming_execute( :type trace_parent: Optional[TraceParent] :param trace_state: :type trace_state: Optional[TraceState] - :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. + :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported. :type transaction_id: Optional[TransactionId] :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. :type version: Optional[FunctionVersion] @@ -610,7 +610,7 @@ def execute( :type trace_parent: Optional[TraceParent] :param trace_state: :type trace_state: Optional[TraceState] - :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. + :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported. :type transaction_id: Optional[TransactionId] :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. :type version: Optional[FunctionVersion] @@ -698,7 +698,7 @@ def execute_async( :type trace_parent: Optional[TraceParent] :param trace_state: :type trace_state: Optional[TraceState] - :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. + :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported. :type transaction_id: Optional[TransactionId] :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. :type version: Optional[FunctionVersion] @@ -967,7 +967,7 @@ def streaming_execute( :type trace_parent: Optional[TraceParent] :param trace_state: :type trace_state: Optional[TraceState] - :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. + :param transaction_id: The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported. :type transaction_id: Optional[TransactionId] :param version: The version of the query to execute. When used with `branch`, the specified version must exist on the branch. :type version: Optional[FunctionVersion] diff --git a/foundry_sdk/v2/ontologies/action_type.py b/foundry_sdk/v2/ontologies/action_type.py index bbc97245..db785bb6 100644 --- a/foundry_sdk/v2/ontologies/action_type.py +++ b/foundry_sdk/v2/ontologies/action_type.py @@ -271,6 +271,82 @@ def list( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def search( + self, + ontology: ontologies_models.OntologyIdentifier, + *, + branch: typing.Optional[core_models.FoundryBranch] = None, + fuzziness: typing.Optional[ontologies_models.ActionTypeFuzziness] = None, + order_by: typing.Optional[ontologies_models.SearchActionTypesOrderByV2] = None, + page_size: typing.Optional[core_models.PageSize] = None, + page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, + where: typing.Optional[ontologies_models.ActionTypeSearchJsonQueryV2] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> ontologies_models.SearchActionTypesResponseV2: + """ + Search for action types in the given Ontology that match the provided filters. Results are returned by + relevance of the match unless an explicit `orderBy` is provided. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. Search results are eventually + consistent with the latest Ontology version and may lag slightly behind the last Ontology modification. + + :param ontology: + :type ontology: OntologyIdentifier + :param branch: The Foundry branch to search the action types 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 fuzziness: + :type fuzziness: Optional[ActionTypeFuzziness] + :param order_by: + :type order_by: Optional[SearchActionTypesOrderByV2] + :param page_size: + :type page_size: Optional[PageSize] + :param page_token: + :type page_token: Optional[PageToken] + :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. + :type preview: Optional[PreviewMode] + :param where: + :type where: Optional[ActionTypeSearchJsonQueryV2] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ontologies_models.SearchActionTypesResponseV2 + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/actionTypes/search", + query_params={ + "branch": branch, + "preview": preview, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=ontologies_models.SearchActionTypesRequestV2( + where=where, + order_by=order_by, + fuzziness=fuzziness, + page_size=page_size, + page_token=page_token, + ), + response_type=ontologies_models.SearchActionTypesResponseV2, + request_timeout=request_timeout, + throwable_errors={}, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + class _ActionTypeClientRaw: def __init__(self, client: ActionTypeClient) -> None: @@ -278,11 +354,13 @@ def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... def get_by_rid_batch(_: ontologies_models.GetActionTypeByRidBatchResponse): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... + def search(_: ontologies_models.SearchActionTypesResponseV2): ... self.get = core.with_raw_response(get, client.get) self.get_by_rid = core.with_raw_response(get_by_rid, client.get_by_rid) self.get_by_rid_batch = core.with_raw_response(get_by_rid_batch, client.get_by_rid_batch) self.list = core.with_raw_response(list, client.list) + self.search = core.with_raw_response(search, client.search) class _ActionTypeClientStreaming: @@ -291,6 +369,7 @@ def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... def get_by_rid_batch(_: ontologies_models.GetActionTypeByRidBatchResponse): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... + def search(_: ontologies_models.SearchActionTypesResponseV2): ... self.get = core.with_streaming_response(get, client.get) self.get_by_rid = core.with_streaming_response(get_by_rid, client.get_by_rid) @@ -298,6 +377,7 @@ def list(_: ontologies_models.ListActionTypesResponseV2): ... get_by_rid_batch, client.get_by_rid_batch ) self.list = core.with_streaming_response(list, client.list) + self.search = core.with_streaming_response(search, client.search) class AsyncActionTypeClient: @@ -546,6 +626,82 @@ def list( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def search( + self, + ontology: ontologies_models.OntologyIdentifier, + *, + branch: typing.Optional[core_models.FoundryBranch] = None, + fuzziness: typing.Optional[ontologies_models.ActionTypeFuzziness] = None, + order_by: typing.Optional[ontologies_models.SearchActionTypesOrderByV2] = None, + page_size: typing.Optional[core_models.PageSize] = None, + page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, + where: typing.Optional[ontologies_models.ActionTypeSearchJsonQueryV2] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[ontologies_models.SearchActionTypesResponseV2]: + """ + Search for action types in the given Ontology that match the provided filters. Results are returned by + relevance of the match unless an explicit `orderBy` is provided. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. Search results are eventually + consistent with the latest Ontology version and may lag slightly behind the last Ontology modification. + + :param ontology: + :type ontology: OntologyIdentifier + :param branch: The Foundry branch to search the action types 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 fuzziness: + :type fuzziness: Optional[ActionTypeFuzziness] + :param order_by: + :type order_by: Optional[SearchActionTypesOrderByV2] + :param page_size: + :type page_size: Optional[PageSize] + :param page_token: + :type page_token: Optional[PageToken] + :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. + :type preview: Optional[PreviewMode] + :param where: + :type where: Optional[ActionTypeSearchJsonQueryV2] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: typing.Awaitable[ontologies_models.SearchActionTypesResponseV2] + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/actionTypes/search", + query_params={ + "branch": branch, + "preview": preview, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=ontologies_models.SearchActionTypesRequestV2( + where=where, + order_by=order_by, + fuzziness=fuzziness, + page_size=page_size, + page_token=page_token, + ), + response_type=ontologies_models.SearchActionTypesResponseV2, + request_timeout=request_timeout, + throwable_errors={}, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + class _AsyncActionTypeClientRaw: def __init__(self, client: AsyncActionTypeClient) -> None: @@ -553,6 +709,7 @@ def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... def get_by_rid_batch(_: ontologies_models.GetActionTypeByRidBatchResponse): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... + def search(_: ontologies_models.SearchActionTypesResponseV2): ... self.get = core.async_with_raw_response(get, client.get) self.get_by_rid = core.async_with_raw_response(get_by_rid, client.get_by_rid) @@ -560,6 +717,7 @@ def list(_: ontologies_models.ListActionTypesResponseV2): ... get_by_rid_batch, client.get_by_rid_batch ) self.list = core.async_with_raw_response(list, client.list) + self.search = core.async_with_raw_response(search, client.search) class _AsyncActionTypeClientStreaming: @@ -568,6 +726,7 @@ def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... def get_by_rid_batch(_: ontologies_models.GetActionTypeByRidBatchResponse): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... + def search(_: ontologies_models.SearchActionTypesResponseV2): ... self.get = core.async_with_streaming_response(get, client.get) self.get_by_rid = core.async_with_streaming_response(get_by_rid, client.get_by_rid) @@ -575,3 +734,4 @@ def list(_: ontologies_models.ListActionTypesResponseV2): ... get_by_rid_batch, client.get_by_rid_batch ) self.list = core.async_with_streaming_response(list, client.list) + self.search = core.async_with_streaming_response(search, client.search) diff --git a/foundry_sdk/v2/ontologies/media_reference_property.py b/foundry_sdk/v2/ontologies/media_reference_property.py index 893c2a5a..585ed446 100644 --- a/foundry_sdk/v2/ontologies/media_reference_property.py +++ b/foundry_sdk/v2/ontologies/media_reference_property.py @@ -63,6 +63,7 @@ def get_media_content( primary_key: ontologies_models.PropertyValueEscapedString, property: ontologies_models.PropertyApiName, *, + branch: typing.Optional[core_models.FoundryBranch] = None, preview: typing.Optional[core_models.PreviewMode] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, @@ -80,6 +81,8 @@ def get_media_content( :type primary_key: PropertyValueEscapedString :param property: The API name of the media reference property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint. :type property: PropertyApiName + :param branch: The Foundry branch to read from. If not specified, the default branch will be used. + :type branch: Optional[FoundryBranch] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param sdk_package_rid: The package rid of the generated SDK. @@ -97,6 +100,7 @@ def get_media_content( method="GET", resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/content", query_params={ + "branch": branch, "preview": preview, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, @@ -128,6 +132,7 @@ def get_media_metadata( primary_key: ontologies_models.PropertyValueEscapedString, property: ontologies_models.PropertyApiName, *, + branch: typing.Optional[core_models.FoundryBranch] = None, preview: typing.Optional[core_models.PreviewMode] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, @@ -145,6 +150,8 @@ def get_media_metadata( :type primary_key: PropertyValueEscapedString :param property: The API name of the media reference backed property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint. :type property: PropertyApiName + :param branch: The Foundry branch to read from. If not specified, the default branch will be used. + :type branch: Optional[FoundryBranch] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param sdk_package_rid: The package rid of the generated SDK. @@ -162,6 +169,7 @@ def get_media_metadata( method="GET", resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/metadata", query_params={ + "branch": branch, "preview": preview, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, @@ -313,6 +321,7 @@ def get_media_content( primary_key: ontologies_models.PropertyValueEscapedString, property: ontologies_models.PropertyApiName, *, + branch: typing.Optional[core_models.FoundryBranch] = None, preview: typing.Optional[core_models.PreviewMode] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, @@ -330,6 +339,8 @@ def get_media_content( :type primary_key: PropertyValueEscapedString :param property: The API name of the media reference property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint. :type property: PropertyApiName + :param branch: The Foundry branch to read from. If not specified, the default branch will be used. + :type branch: Optional[FoundryBranch] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param sdk_package_rid: The package rid of the generated SDK. @@ -347,6 +358,7 @@ def get_media_content( method="GET", resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/content", query_params={ + "branch": branch, "preview": preview, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, @@ -378,6 +390,7 @@ def get_media_metadata( primary_key: ontologies_models.PropertyValueEscapedString, property: ontologies_models.PropertyApiName, *, + branch: typing.Optional[core_models.FoundryBranch] = None, preview: typing.Optional[core_models.PreviewMode] = None, sdk_package_rid: typing.Optional[ontologies_models.SdkPackageRid] = None, sdk_version: typing.Optional[ontologies_models.SdkVersion] = None, @@ -395,6 +408,8 @@ def get_media_metadata( :type primary_key: PropertyValueEscapedString :param property: The API name of the media reference backed property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint. :type property: PropertyApiName + :param branch: The Foundry branch to read from. If not specified, the default branch will be used. + :type branch: Optional[FoundryBranch] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param sdk_package_rid: The package rid of the generated SDK. @@ -412,6 +427,7 @@ def get_media_metadata( method="GET", resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/metadata", query_params={ + "branch": branch, "preview": preview, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, diff --git a/foundry_sdk/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py index e26245d2..68e50739 100644 --- a/foundry_sdk/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -75,6 +75,10 @@ class ActionParameterArrayType(core.ModelBase): type: typing.Literal["array"] = "array" +ActionParameterRid = core.RID +"""The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs.""" + + ActionParameterType = typing_extensions.Annotated[ typing.Union[ core_models.DateType, @@ -123,6 +127,10 @@ class ActionParameterV2(core.ModelBase): """The unique resource identifier for an action.""" +ActionSectionRid = core.RID +"""The unique resource identifier of an action section, useful for interacting with other Foundry APIs.""" + + ActionTypeApiName = str """ The name of the action type in the API. To find the API name for your Action Type, use the `List action types` @@ -130,6 +138,27 @@ class ActionParameterV2(core.ModelBase): """ +class ActionTypeApiNameActionTypesQueryV2(core.ModelBase): + """Returns action types with an api name matching the given string predicate.""" + + value: FullTextStringPredicateV2 + type: typing.Literal["actionTypeApiName"] = "actionTypeApiName" + + +class ActionTypeDescriptionActionTypesQueryV2(core.ModelBase): + """Returns action types with a description matching the given string predicate.""" + + value: FullTextStringPredicateV2 + type: typing.Literal["actionTypeDescription"] = "actionTypeDescription" + + +class ActionTypeDisplayNameActionTypesQueryV2(core.ModelBase): + """Returns action types with a display name matching the given string predicate.""" + + value: FullTextStringPredicateV2 + type: typing.Literal["actionTypeDisplayName"] = "actionTypeDisplayName" + + class ActionTypeFullMetadata(core.ModelBase): """Returns the full metadata for an Action type in the Ontology.""" @@ -137,10 +166,85 @@ class ActionTypeFullMetadata(core.ModelBase): full_logic_rules: typing.List[ActionLogicRule] = pydantic.Field(alias=str("fullLogicRules")) # type: ignore[literal-required] +ActionTypeFuzziness = typing_extensions.Annotated[ + typing.Union["FuzzinessAuto", "FuzzinessOff"], pydantic.Field(discriminator="type") +] +""" +Fuzziness setting applied to `contains` full-text string predicates in the search query. If not provided, +`auto` is used. +""" + + +ActionTypeLogicRuleTypeFilter = typing.Literal[ + "ADD_OBJECT", + "MODIFY_OBJECT", + "DELETE_OBJECT", + "ADD_LINK", + "DELETE_LINK", + "FUNCTION", + "BATCHED_FUNCTION", + "ADD_OR_MODIFY_OBJECT", + "ADD_OR_MODIFY_OBJECT_V2", +] +"""Filter action types by the type of logic rule they contain.""" + + +ActionTypePermissionModelFilter = typing.Literal[ + "DATASOURCE_DERIVED_PERMISSIONS", "ONTOLOGY_ROLES", "COMPASS_PROJECT" +] +"""Filter action types by permission model.""" + + ActionTypeRid = core.RID """The unique resource identifier of an action type, useful for interacting with other Foundry APIs.""" +class ActionTypeRidActionTypesQueryV2(core.ModelBase): + """Returns action types with the given rid.""" + + value: ActionTypeRid + type: typing.Literal["actionTypeRid"] = "actionTypeRid" + + +ActionTypeSearchJsonQueryV2 = typing_extensions.Annotated[ + typing.Union[ + "WebhookRidActionTypesQueryV2", + "HasActionLogActionTypesQueryV2", + "ActionTypeApiNameActionTypesQueryV2", + "OrActionTypesQueryV2", + "PermissionModelActionTypesQueryV2", + "HasWebhookActionTypesQueryV2", + "ActionTypeDisplayNameActionTypesQueryV2", + "AffectedLinkTypeRidActionTypesQueryV2", + "ActionTypeDescriptionActionTypesQueryV2", + "SectionRidActionTypesQueryV2", + "ParameterRidActionTypesQueryV2", + "ParameterNameActionTypesQueryV2", + "HasNotificationActionTypesQueryV2", + "FunctionRidActionTypesQueryV2", + "InputObjectTypeRidActionTypesQueryV2", + "RevertActionEnabledActionTypesQueryV2", + "LogicRuleActionTypesQueryV2", + "TypeClassesActionTypesQueryV2", + "AffectedInterfaceTypeRidActionTypesQueryV2", + "AndActionTypesQueryV2", + "ActionTypeRidActionTypesQueryV2", + "AffectedObjectTypeRidActionTypesQueryV2", + "StatusActionTypesQueryV2", + ], + pydantic.Field(discriminator="type"), +] +"""Represents the search query for an action type search. Supports filters for various action type features.""" + + +ActionTypeSortByV2 = typing.Literal["actionTypeDisplayName"] +"""Specifies the field to sort action types by.""" + + +ActionTypeStatusFilter = typing.Literal["EXPERIMENTAL", "ACTIVE", "DEPRECATED", "EXAMPLE"] +"""Filter action types by status.""" + + class ActionTypeV2(core.ModelBase): """Represents an action type in the Ontology.""" @@ -207,6 +311,27 @@ class AddPropertyExpression(core.ModelBase): type: typing.Literal["add"] = "add" +class AffectedInterfaceTypeRidActionTypesQueryV2(core.ModelBase): + """Returns action types which edit the interface type with the given rid.""" + + value: InterfaceTypeRid + type: typing.Literal["affectedInterfaceTypeRid"] = "affectedInterfaceTypeRid" + + +class AffectedLinkTypeRidActionTypesQueryV2(core.ModelBase): + """Returns action types which edit the link type with the given rid.""" + + value: LinkTypeRid + type: typing.Literal["affectedLinkTypeRid"] = "affectedLinkTypeRid" + + +class AffectedObjectTypeRidActionTypesQueryV2(core.ModelBase): + """Returns action types which edit the object type with the given rid.""" + + value: ObjectTypeRid + type: typing.Literal["affectedObjectTypeRid"] = "affectedObjectTypeRid" + + class Affix(core.ModelBase): """Affix""" @@ -222,14 +347,6 @@ class AggregateObjectSetRequestV2(core.ModelBase): group_by: typing.List[AggregationGroupByV2] = pydantic.Field(alias=str("groupBy")) # type: ignore[literal-required] accuracy: typing.Optional[AggregationAccuracyRequest] = None include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = pydantic.Field(alias=str("includeComputeUsage"), default=None) # type: ignore[literal-required] - execute_in_memory_only: typing.Optional[bool] = pydantic.Field(alias=str("executeInMemoryOnly"), default=None) # type: ignore[literal-required] - """ - 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. - """ class AggregateObjectsRequestV2(core.ModelBase): @@ -430,6 +547,13 @@ class AllOfRule(core.ModelBase): type: typing.Literal["allOf"] = "allOf" +class AndActionTypesQueryV2(core.ModelBase): + """Returns action types where every query is satisfied. An empty list matches all action types.""" + + value: typing.List[ActionTypeSearchJsonQueryV2] + type: typing.Literal["and"] = "and" + + class AndQueryV2(core.ModelBase): """Returns objects where every query is satisfied.""" @@ -1445,6 +1569,30 @@ class ExtractPropertyExpression(core.ModelBase): """Integer key for fixed value mapping.""" +class FullTextStringContainsPredicate(core.ModelBase): + """ + Matches strings which contain the given string or parts of the given string. The exact behaviour can vary + depending on the attribute searched for due to optimized text analysis. + """ + + value: str + type: typing.Literal["contains"] = "contains" + + +class FullTextStringExactPredicate(core.ModelBase): + """Matches strings representing the same sequence of characters as the given string.""" + + value: str + type: typing.Literal["exact"] = "exact" + + +FullTextStringPredicateV2 = typing_extensions.Annotated[ + typing.Union["FullTextStringContainsPredicate", "FullTextStringExactPredicate"], + pydantic.Field(discriminator="type"), +] +"""A predicate for matching strings.""" + + class FunctionLogicRule(core.ModelBase): """FunctionLogicRule""" @@ -1462,6 +1610,13 @@ class FunctionLogicRule(core.ModelBase): """The unique resource identifier of a Function, useful for interacting with other Foundry APIs.""" +class FunctionRidActionTypesQueryV2(core.ModelBase): + """Returns action types which use the function with the given rid.""" + + value: FunctionRid + type: typing.Literal["functionRid"] = "functionRid" + + FunctionVersion = str """ The version of the given Function, written `..-`, where `-` is optional. @@ -1469,6 +1624,24 @@ class FunctionLogicRule(core.ModelBase): """ +class FuzzinessAuto(core.ModelBase): + """ + Fuzzy search is activated, which can help discover additional results based on small differences in + spelling, although some additional results may be less relevant. + """ + + type: typing.Literal["auto"] = "auto" + + +class FuzzinessOff(core.ModelBase): + """ + Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are + not returned. + """ + + type: typing.Literal["off"] = "off" + + class FuzzyRule(core.ModelBase): """ Matches intervals containing terms that are similar to the provided term, within an edit distance @@ -1654,6 +1827,27 @@ class GteQueryV2(core.ModelBase): type: typing.Literal["gte"] = "gte" +class HasActionLogActionTypesQueryV2(core.ModelBase): + """Returns action types based on whether they have an action log.""" + + value: bool + type: typing.Literal["hasActionLog"] = "hasActionLog" + + +class HasNotificationActionTypesQueryV2(core.ModelBase): + """Returns action types based on whether they have a notification.""" + + value: bool + type: typing.Literal["hasNotification"] = "hasNotification" + + +class HasWebhookActionTypesQueryV2(core.ModelBase): + """Returns action types based on whether they reference a webhook.""" + + value: bool + type: typing.Literal["hasWebhook"] = "hasWebhook" + + class HumanReadableFormat(core.ModelBase): """Formats the duration as a human-readable written string.""" @@ -1678,6 +1872,13 @@ class InQuery(core.ModelBase): type: typing.Literal["in"] = "in" +class InputObjectTypeRidActionTypesQueryV2(core.ModelBase): + """Returns action types which reference the object type with the given rid as an input or product.""" + + value: ObjectTypeRid + type: typing.Literal["inputObjectTypeRid"] = "inputObjectTypeRid" + + class IntegerValue(core.ModelBase): """IntegerValue""" @@ -2305,14 +2506,6 @@ class LoadObjectSetLinksRequestV2(core.ModelBase): links: typing.List[LinkTypeApiName] page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("pageToken"), default=None) # type: ignore[literal-required] include_compute_usage: typing.Optional[core_models.IncludeComputeUsage] = pydantic.Field(alias=str("includeComputeUsage"), default=None) # type: ignore[literal-required] - execute_in_memory_only: typing.Optional[bool] = pydantic.Field(alias=str("executeInMemoryOnly"), default=None) # type: ignore[literal-required] - """ - 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. - """ class LoadObjectSetLinksResponseV2(core.ModelBase): @@ -2470,15 +2663,6 @@ class LoadObjectSetV2ObjectsOrInterfacesRequest(core.ModelBase): This defaults to false if not specified, which means you will always get the latest results. """ - execute_in_memory_only: typing.Optional[bool] = pydantic.Field(alias=str("executeInMemoryOnly"), default=None) # type: ignore[literal-required] - """ - 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. - """ - class LoadObjectSetV2ObjectsOrInterfacesResponse(core.ModelBase): """ @@ -2521,6 +2705,13 @@ class LoadOntologyMetadataRequest(core.ModelBase): """LogicRule""" +class LogicRuleActionTypesQueryV2(core.ModelBase): + """Returns action types which contain a logic rule of the given type.""" + + value: ActionTypeLogicRuleTypeFilter + type: typing.Literal["logicRule"] = "logicRule" + + LogicRuleArgument = typing_extensions.Annotated[ typing.Union[ "CurrentTimeArgument", @@ -3622,6 +3813,13 @@ class OntologyValueType(core.ModelBase): constraints: typing.List[ValueTypeConstraint] +class OrActionTypesQueryV2(core.ModelBase): + """Returns action types where at least one query is satisfied. An empty list matches no action types.""" + + value: typing.List[ActionTypeSearchJsonQueryV2] + type: typing.Literal["or"] = "or" + + class OrQueryV2(core.ModelBase): """Returns objects where at least 1 query is satisfied.""" @@ -3708,6 +3906,13 @@ class ParameterIdArgument(core.ModelBase): type: typing.Literal["parameterId"] = "parameterId" +class ParameterNameActionTypesQueryV2(core.ModelBase): + """Returns action types with a parameter whose name matches the given string predicate.""" + + value: FullTextStringPredicateV2 + type: typing.Literal["parameterName"] = "parameterName" + + class ParameterOption(core.ModelBase): """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" @@ -3716,6 +3921,20 @@ class ParameterOption(core.ModelBase): """An allowed configured value for a parameter within an action.""" +class ParameterRidActionTypesQueryV2(core.ModelBase): + """Returns action types with a parameter matching the given parameter rid.""" + + value: ActionParameterRid + type: typing.Literal["parameterRid"] = "parameterRid" + + +class PermissionModelActionTypesQueryV2(core.ModelBase): + """Returns action types with the given permission model.""" + + value: ActionTypePermissionModelFilter + type: typing.Literal["permissionModel"] = "permissionModel" + + Plaintext = str """Plaintext""" @@ -4452,6 +4671,13 @@ class ResolvedInterfacePropertyType(core.ModelBase): """If not specified, defaults to `NONE`.""" +class RevertActionEnabledActionTypesQueryV2(core.ModelBase): + """Returns action types based on whether they are revertible.""" + + value: bool + type: typing.Literal["revertActionEnabled"] = "revertActionEnabled" + + class RidConstraint(core.ModelBase): """The string must be a valid RID (Resource Identifier).""" @@ -4477,6 +4703,35 @@ class RollingAggregateWindowPoints(core.ModelBase): """SdkVersion""" +class SearchActionTypesOrderByV2(core.ModelBase): + """ + Specifies the ordering of action type search results by a field and an ordering direction. If not provided, + results are ordered by relevance of the match. + """ + + field: ActionTypeSortByV2 + direction: typing.Optional[str] = None + """Specifies the ordering direction (can be either `asc` or `desc`)""" + + +class SearchActionTypesRequestV2(core.ModelBase): + """SearchActionTypesRequestV2""" + + where: typing.Optional[ActionTypeSearchJsonQueryV2] = None + order_by: typing.Optional[SearchActionTypesOrderByV2] = pydantic.Field(alias=str("orderBy"), default=None) # type: ignore[literal-required] + fuzziness: typing.Optional[ActionTypeFuzziness] = None + page_size: typing.Optional[core_models.PageSize] = pydantic.Field(alias=str("pageSize"), default=None) # type: ignore[literal-required] + page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("pageToken"), default=None) # type: ignore[literal-required] + + +class SearchActionTypesResponseV2(core.ModelBase): + """SearchActionTypesResponseV2""" + + data: typing.List[ActionTypeV2] + 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] + + SearchJsonQueryV2 = typing_extensions.Annotated[ typing.Union[ "LtQueryV2", @@ -4598,15 +4853,6 @@ class SearchObjectsRequestV2(core.ModelBase): This defaults to false if not specified, which means you will always get the latest results. """ - execute_in_memory_only: typing.Optional[bool] = pydantic.Field(alias=str("executeInMemoryOnly"), default=None) # type: ignore[literal-required] - """ - 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. - """ - class SearchObjectsResponseV2(core.ModelBase): """SearchObjectsResponseV2""" @@ -4635,6 +4881,13 @@ class SearchOrderingV2(core.ModelBase): """Specifies the ordering direction (can be either `asc` or `desc`)""" +class SectionRidActionTypesQueryV2(core.ModelBase): + """Returns action types with a section matching the given section rid.""" + + value: ActionSectionRid + type: typing.Literal["sectionRid"] = "sectionRid" + + SelectedPropertyApiName = str """ By default, whenever an object is requested, all of its properties are returned, except for properties of the @@ -4832,6 +5085,13 @@ class StaticArgument(core.ModelBase): type: typing.Literal["staticValue"] = "staticValue" +class StatusActionTypesQueryV2(core.ModelBase): + """Returns action types with the given status.""" + + value: ActionTypeStatusFilter + type: typing.Literal["status"] = "status" + + StreamMessage = typing_extensions.Annotated[ typing.Union[ "ObjectSetUpdates", "RefreshObjectSet", "SubscriptionClosed", "ObjectSetSubscribeResponses" @@ -5309,6 +5569,27 @@ class TypeClass(core.ModelBase): """The value of the type class.""" +class TypeClassPredicateV2(core.ModelBase): + """ + A predicate for matching type classes. Matches a type class when `kind`, and `name` if provided, match the + corresponding attribute of the type class. If `name` is empty, only `kind` is required to match. You can + search for both parameter type classes and action type type classes. + """ + + kind: str + """Exact match predicate for the `kind` attribute of a type class.""" + + name: typing.Optional[str] = None + """Exact match predicate for the `name` attribute of a type class.""" + + +class TypeClassesActionTypesQueryV2(core.ModelBase): + """Returns action types whose type class satisfies the given type class predicate.""" + + value: TypeClassPredicateV2 + type: typing.Literal["typeClasses"] = "typeClasses" + + TypeReferenceIdentifier = str """ The unique identifier of a type reference. This identifier is used to look up the @@ -5521,6 +5802,17 @@ class ValueTypeUnionType(core.ModelBase): """ +WebhookRid = core.RID +"""The unique resource identifier of a webhook, useful for interacting with other Foundry APIs.""" + + +class WebhookRidActionTypesQueryV2(core.ModelBase): + """Returns action types which reference the webhook with the given rid.""" + + value: WebhookRid + type: typing.Literal["webhookRid"] = "webhookRid" + + class WildcardQuery(core.ModelBase): """ Returns objects where the specified field matches the wildcard pattern provided. @@ -5611,6 +5903,8 @@ class WithinPolygonQuery(core.ModelBase): core.resolve_forward_references(ActionLogicRule, globalns=globals(), localns=locals()) core.resolve_forward_references(ActionParameterType, globalns=globals(), localns=locals()) core.resolve_forward_references(ActionResults, globalns=globals(), localns=locals()) +core.resolve_forward_references(ActionTypeFuzziness, globalns=globals(), localns=locals()) +core.resolve_forward_references(ActionTypeSearchJsonQueryV2, globalns=globals(), localns=locals()) core.resolve_forward_references(AggregationGroupByV2, globalns=globals(), localns=locals()) core.resolve_forward_references(AggregationV2, globalns=globals(), localns=locals()) core.resolve_forward_references(AttachmentMetadataResponse, globalns=globals(), localns=locals()) @@ -5630,6 +5924,7 @@ class WithinPolygonQuery(core.ModelBase): core.resolve_forward_references(DurationFormatStyle, globalns=globals(), localns=locals()) core.resolve_forward_references(EditHistoryEdit, globalns=globals(), localns=locals()) core.resolve_forward_references(EditsHistoryFilter, globalns=globals(), localns=locals()) +core.resolve_forward_references(FullTextStringPredicateV2, globalns=globals(), localns=locals()) core.resolve_forward_references(GeoShapeV2Geometry, globalns=globals(), localns=locals()) core.resolve_forward_references(GeotemporalSeriesEntry, globalns=globals(), localns=locals()) core.resolve_forward_references( @@ -5709,13 +6004,25 @@ class WithinPolygonQuery(core.ModelBase): "ActionExecutionTime", "ActionLogicRule", "ActionParameterArrayType", + "ActionParameterRid", "ActionParameterType", "ActionParameterV2", "ActionResults", "ActionRid", + "ActionSectionRid", "ActionTypeApiName", + "ActionTypeApiNameActionTypesQueryV2", + "ActionTypeDescriptionActionTypesQueryV2", + "ActionTypeDisplayNameActionTypesQueryV2", "ActionTypeFullMetadata", + "ActionTypeFuzziness", + "ActionTypeLogicRuleTypeFilter", + "ActionTypePermissionModelFilter", "ActionTypeRid", + "ActionTypeRidActionTypesQueryV2", + "ActionTypeSearchJsonQueryV2", + "ActionTypeSortByV2", + "ActionTypeStatusFilter", "ActionTypeV2", "ActivePropertyTypeStatus", "AddLink", @@ -5723,6 +6030,9 @@ class WithinPolygonQuery(core.ModelBase): "AddObject", "AddObjectEdit", "AddPropertyExpression", + "AffectedInterfaceTypeRidActionTypesQueryV2", + "AffectedLinkTypeRidActionTypesQueryV2", + "AffectedObjectTypeRidActionTypesQueryV2", "Affix", "AggregateObjectSetRequestV2", "AggregateObjectsRequestV2", @@ -5743,6 +6053,7 @@ class WithinPolygonQuery(core.ModelBase): "AggregationRangesGroupingV2", "AggregationV2", "AllOfRule", + "AndActionTypesQueryV2", "AndQueryV2", "AnyOfRule", "ApplyActionMode", @@ -5862,10 +6173,16 @@ class WithinPolygonQuery(core.ModelBase): "ExtractPropertyExpression", "FilterValue", "FixedValuesMapKey", + "FullTextStringContainsPredicate", + "FullTextStringExactPredicate", + "FullTextStringPredicateV2", "FunctionLogicRule", "FunctionParameterName", "FunctionRid", + "FunctionRidActionTypesQueryV2", "FunctionVersion", + "FuzzinessAuto", + "FuzzinessOff", "FuzzyRule", "FuzzyV2", "GeoJsonString", @@ -5887,9 +6204,13 @@ class WithinPolygonQuery(core.ModelBase): "GroupMemberConstraint", "GtQueryV2", "GteQueryV2", + "HasActionLogActionTypesQueryV2", + "HasNotificationActionTypesQueryV2", + "HasWebhookActionTypesQueryV2", "HumanReadableFormat", "Icon", "InQuery", + "InputObjectTypeRidActionTypesQueryV2", "IntegerValue", "InterfaceDefinedPropertyType", "InterfaceLinkType", @@ -5964,6 +6285,7 @@ class WithinPolygonQuery(core.ModelBase): "LoadObjectSetV2ObjectsOrInterfacesResponse", "LoadOntologyMetadataRequest", "LogicRule", + "LogicRuleActionTypesQueryV2", "LogicRuleArgument", "LongValue", "LtQueryV2", @@ -6076,6 +6398,7 @@ class WithinPolygonQuery(core.ModelBase): "OntologyTransactionId", "OntologyV2", "OntologyValueType", + "OrActionTypesQueryV2", "OrQueryV2", "OrderBy", "OrderByDirection", @@ -6083,7 +6406,10 @@ class WithinPolygonQuery(core.ModelBase): "ParameterEvaluationResult", "ParameterId", "ParameterIdArgument", + "ParameterNameActionTypesQueryV2", "ParameterOption", + "ParameterRidActionTypesQueryV2", + "PermissionModelActionTypesQueryV2", "Plaintext", "PolygonValue", "PostTransactionEditsRequest", @@ -6161,11 +6487,15 @@ class WithinPolygonQuery(core.ModelBase): "RequestId", "ResolvedInterfacePropertyType", "ReturnEditsMode", + "RevertActionEnabledActionTypesQueryV2", "RidConstraint", "RollingAggregateWindowPoints", "SdkPackageName", "SdkPackageRid", "SdkVersion", + "SearchActionTypesOrderByV2", + "SearchActionTypesRequestV2", + "SearchActionTypesResponseV2", "SearchJsonQueryV2", "SearchObjectsForInterfaceRequest", "SearchObjectsRequestV2", @@ -6173,6 +6503,7 @@ class WithinPolygonQuery(core.ModelBase): "SearchOrderByType", "SearchOrderByV2", "SearchOrderingV2", + "SectionRidActionTypesQueryV2", "SelectedPropertyApiName", "SelectedPropertyApproximateDistinctAggregation", "SelectedPropertyApproximatePercentileAggregation", @@ -6192,6 +6523,7 @@ class WithinPolygonQuery(core.ModelBase): "SpatialFilterMode", "StartsWithQuery", "StaticArgument", + "StatusActionTypesQueryV2", "StreamMessage", "StreamTimeSeriesPointsRequest", "StreamTimeSeriesValuesRequest", @@ -6243,6 +6575,8 @@ class WithinPolygonQuery(core.ModelBase): "TransactionEdit", "TwoDimensionalAggregation", "TypeClass", + "TypeClassPredicateV2", + "TypeClassesActionTypesQueryV2", "TypeReferenceIdentifier", "UnevaluableConstraint", "UniqueIdentifierArgument", @@ -6267,6 +6601,8 @@ class WithinPolygonQuery(core.ModelBase): "ValueTypeStructType", "ValueTypeUnionType", "VersionedQueryTypeApiName", + "WebhookRid", + "WebhookRidActionTypesQueryV2", "WildcardQuery", "WithinBoundingBoxPoint", "WithinBoundingBoxQuery", diff --git a/foundry_sdk/v2/ontologies/ontology_object.py b/foundry_sdk/v2/ontologies/ontology_object.py index 171b2ba8..bc241606 100644 --- a/foundry_sdk/v2/ontologies/ontology_object.py +++ b/foundry_sdk/v2/ontologies/ontology_object.py @@ -439,6 +439,7 @@ def search( resource_path="/v2/ontologies/{ontology}/objects/{objectType}/search", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, }, @@ -459,7 +460,6 @@ def search( select_v2=select_v2, exclude_rid=exclude_rid, snapshot=snapshot, - execute_in_memory_only=execute_in_memory_only, ), response_type=ontologies_models.SearchObjectsResponseV2, request_timeout=request_timeout, @@ -914,6 +914,7 @@ def search( resource_path="/v2/ontologies/{ontology}/objects/{objectType}/search", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, }, @@ -934,7 +935,6 @@ def search( select_v2=select_v2, exclude_rid=exclude_rid, snapshot=snapshot, - execute_in_memory_only=execute_in_memory_only, ), response_type=ontologies_models.SearchObjectsResponseV2, request_timeout=request_timeout, diff --git a/foundry_sdk/v2/ontologies/ontology_object_set.py b/foundry_sdk/v2/ontologies/ontology_object_set.py index 485e5b10..006c4aa9 100644 --- a/foundry_sdk/v2/ontologies/ontology_object_set.py +++ b/foundry_sdk/v2/ontologies/ontology_object_set.py @@ -119,6 +119,7 @@ def aggregate( resource_path="/v2/ontologies/{ontology}/objectSets/aggregate", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "scenarioRid": scenario_rid, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, @@ -139,7 +140,6 @@ def aggregate( group_by=group_by, accuracy=accuracy, include_compute_usage=include_compute_usage, - execute_in_memory_only=execute_in_memory_only, ), response_type=ontologies_models.AggregateObjectsResponseV2, request_timeout=request_timeout, @@ -279,6 +279,7 @@ def load( select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + execute_in_memory_only: 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, @@ -315,6 +316,8 @@ def load( :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 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 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. @@ -353,6 +356,7 @@ def load( resource_path="/v2/ontologies/{ontology}/objectSets/loadObjects", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "scenarioRid": scenario_rid, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, @@ -459,6 +463,7 @@ def load_links( resource_path="/v2/ontologies/{ontology}/objectSets/loadLinks", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "preview": preview, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, @@ -477,7 +482,6 @@ def load_links( links=links, page_token=page_token, include_compute_usage=include_compute_usage, - execute_in_memory_only=execute_in_memory_only, ), response_type=ontologies_models.LoadObjectSetLinksResponseV2, request_timeout=request_timeout, @@ -497,6 +501,7 @@ def load_multiple_object_types( select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + execute_in_memory_only: 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, @@ -539,6 +544,8 @@ def load_multiple_object_types( :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 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 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. @@ -579,6 +586,7 @@ def load_multiple_object_types( resource_path="/v2/ontologies/{ontology}/objectSets/loadObjectsMultipleObjectTypes", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "preview": preview, "scenarioRid": scenario_rid, "sdkPackageRid": sdk_package_rid, @@ -705,6 +713,7 @@ def load_objects_or_interfaces( resource_path="/v2/ontologies/{ontology}/objectSets/loadObjectsOrInterfaces", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "preview": preview, "scenarioRid": scenario_rid, "sdkPackageRid": sdk_package_rid, @@ -729,7 +738,6 @@ def load_objects_or_interfaces( page_size=page_size, exclude_rid=exclude_rid, snapshot=snapshot, - execute_in_memory_only=execute_in_memory_only, ), response_type=ontologies_models.LoadObjectSetV2ObjectsOrInterfacesResponse, request_timeout=request_timeout, @@ -890,6 +898,7 @@ def aggregate( resource_path="/v2/ontologies/{ontology}/objectSets/aggregate", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "scenarioRid": scenario_rid, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, @@ -910,7 +919,6 @@ def aggregate( group_by=group_by, accuracy=accuracy, include_compute_usage=include_compute_usage, - execute_in_memory_only=execute_in_memory_only, ), response_type=ontologies_models.AggregateObjectsResponseV2, request_timeout=request_timeout, @@ -1050,6 +1058,7 @@ def load( select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + execute_in_memory_only: 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, @@ -1086,6 +1095,8 @@ def load( :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 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 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. @@ -1124,6 +1135,7 @@ def load( resource_path="/v2/ontologies/{ontology}/objectSets/loadObjects", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "scenarioRid": scenario_rid, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, @@ -1230,6 +1242,7 @@ def load_links( resource_path="/v2/ontologies/{ontology}/objectSets/loadLinks", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "preview": preview, "sdkPackageRid": sdk_package_rid, "sdkVersion": sdk_version, @@ -1248,7 +1261,6 @@ def load_links( links=links, page_token=page_token, include_compute_usage=include_compute_usage, - execute_in_memory_only=execute_in_memory_only, ), response_type=ontologies_models.LoadObjectSetLinksResponseV2, request_timeout=request_timeout, @@ -1268,6 +1280,7 @@ def load_multiple_object_types( select: typing.List[ontologies_models.SelectedPropertyApiName], branch: typing.Optional[core_models.FoundryBranch] = None, exclude_rid: typing.Optional[bool] = None, + execute_in_memory_only: 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, @@ -1310,6 +1323,8 @@ def load_multiple_object_types( :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 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 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. @@ -1350,6 +1365,7 @@ def load_multiple_object_types( resource_path="/v2/ontologies/{ontology}/objectSets/loadObjectsMultipleObjectTypes", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "preview": preview, "scenarioRid": scenario_rid, "sdkPackageRid": sdk_package_rid, @@ -1476,6 +1492,7 @@ def load_objects_or_interfaces( resource_path="/v2/ontologies/{ontology}/objectSets/loadObjectsOrInterfaces", query_params={ "branch": branch, + "executeInMemoryOnly": execute_in_memory_only, "preview": preview, "scenarioRid": scenario_rid, "sdkPackageRid": sdk_package_rid, @@ -1500,7 +1517,6 @@ def load_objects_or_interfaces( page_size=page_size, exclude_rid=exclude_rid, snapshot=snapshot, - execute_in_memory_only=execute_in_memory_only, ), response_type=ontologies_models.LoadObjectSetV2ObjectsOrInterfacesResponse, request_timeout=request_timeout, diff --git a/foundry_sdk/v2/ontologies/query.py b/foundry_sdk/v2/ontologies/query.py index 645014bf..74367eae 100644 --- a/foundry_sdk/v2/ontologies/query.py +++ b/foundry_sdk/v2/ontologies/query.py @@ -78,6 +78,7 @@ def execute( ) -> ontologies_models.ExecuteQueryResponse: """ Executes a Query using the given parameters. By default, the latest version of the Query is executed. + The latest version is the one that was most recently published, which may be a pre-release version. Optional parameters do not need to be supplied. @@ -213,6 +214,7 @@ def execute( ) -> typing.Awaitable[ontologies_models.ExecuteQueryResponse]: """ Executes a Query using the given parameters. By default, the latest version of the Query is executed. + The latest version is the one that was most recently published, which may be a pre-release version. Optional parameters do not need to be supplied. diff --git a/foundry_sdk/v2/sql_queries/errors.py b/foundry_sdk/v2/sql_queries/errors.py index b3d97140..034b1b26 100644 --- a/foundry_sdk/v2/sql_queries/errors.py +++ b/foundry_sdk/v2/sql_queries/errors.py @@ -100,6 +100,25 @@ class GetStatusSqlQueryPermissionDenied(errors.PermissionDeniedError): error_instance_id: str +class OntologyObjectTypeNotFoundParameters(typing_extensions.TypedDict): + """ + The ontology query referenced an object type RID that does not exist or + is not visible to the requesting user. Verify the RID (e.g. via + list-object-types or get-object-type-details) and retry. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectTypeRid: core.RID + + +@dataclass +class OntologyObjectTypeNotFound(errors.NotFoundError): + name: typing.Literal["OntologyObjectTypeNotFound"] + parameters: OntologyObjectTypeNotFoundParameters + error_instance_id: str + + class OntologyQueryFailedParameters(typing_extensions.TypedDict): """The Ontology query failed.""" @@ -115,6 +134,66 @@ class OntologyQueryFailed(errors.InternalServerError): error_instance_id: str +class OntologyQueryInvalidObjectBackendParameters(typing_extensions.TypedDict): + """ + The ontology query references object types or link types indexed in Object + Storage V1, which is incompatible with Ontology SQL. Migrate the entities + to Object Storage V2 or remove them from the query. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectTypeRids: typing.List[core.RID] + linkTypeRids: typing.List[core.RID] + + +@dataclass +class OntologyQueryInvalidObjectBackend(errors.BadRequestError): + name: typing.Literal["OntologyQueryInvalidObjectBackend"] + parameters: OntologyQueryInvalidObjectBackendParameters + error_instance_id: str + + +class OntologyQueryNestedObjectSetTooLargeParameters(typing_extensions.TypedDict): + """ + The query references too many objects across joins, link lookups, or + sub-queries. Narrow the scope (add filters, reduce joins, restrict + object types) and retry. The actual and maximum object counts are + returned as parameters. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nestedObjectSetSize: core.Long + maxAllowedNestedObjectSetSize: core.Long + + +@dataclass +class OntologyQueryNestedObjectSetTooLarge(errors.BadRequestError): + name: typing.Literal["OntologyQueryNestedObjectSetTooLarge"] + parameters: OntologyQueryNestedObjectSetTooLargeParameters + error_instance_id: str + + +class OntologyQueryStringColumnTooLongParameters(typing_extensions.TypedDict): + """ + A string column in the query result contains a value larger than + the platform's per-cell size limit. Exclude or filter the column, + or scope the query to skip the oversized rows. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + columnName: str + + +@dataclass +class OntologyQueryStringColumnTooLong(errors.BadRequestError): + name: typing.Literal["OntologyQueryStringColumnTooLong"] + parameters: OntologyQueryStringColumnTooLongParameters + error_instance_id: str + + class QueryCanceledParameters(typing_extensions.TypedDict): """The query was canceled.""" @@ -207,7 +286,11 @@ class ReadQueryInputsPermissionDenied(errors.PermissionDeniedError): "ExecuteSqlQueryPermissionDenied", "GetResultsSqlQueryPermissionDenied", "GetStatusSqlQueryPermissionDenied", + "OntologyObjectTypeNotFound", "OntologyQueryFailed", + "OntologyQueryInvalidObjectBackend", + "OntologyQueryNestedObjectSetTooLarge", + "OntologyQueryStringColumnTooLong", "QueryCanceled", "QueryFailed", "QueryParseError", diff --git a/foundry_sdk/v2/sql_queries/sql_query.py b/foundry_sdk/v2/sql_queries/sql_query.py index a8ad92df..1110a20b 100644 --- a/foundry_sdk/v2/sql_queries/sql_query.py +++ b/foundry_sdk/v2/sql_queries/sql_query.py @@ -211,7 +211,11 @@ def execute_ontology( :rtype: bytes :raises ExecuteOntologySqlQueryPermissionDenied: Could not executeOntology the SqlQuery. + :raises OntologyObjectTypeNotFound: The ontology query referenced an object type RID that does not exist or is not visible to the requesting user. Verify the RID (e.g. via list-object-types or get-object-type-details) and retry. :raises OntologyQueryFailed: The Ontology query failed. + :raises OntologyQueryInvalidObjectBackend: The ontology query references object types or link types indexed in Object Storage V1, which is incompatible with Ontology SQL. Migrate the entities to Object Storage V2 or remove them from the query. + :raises OntologyQueryNestedObjectSetTooLarge: The query references too many objects across joins, link lookups, or sub-queries. Narrow the scope (add filters, reduce joins, restrict object types) and retry. The actual and maximum object counts are returned as parameters. + :raises OntologyQueryStringColumnTooLong: A string column in the query result contains a value larger than the platform's per-cell size limit. Exclude or filter the column, or scope the query to skip the oversized rows. :raises QueryParseError: The query cannot be parsed. """ @@ -237,7 +241,11 @@ def execute_ontology( request_timeout=request_timeout, throwable_errors={ "ExecuteOntologySqlQueryPermissionDenied": sql_queries_errors.ExecuteOntologySqlQueryPermissionDenied, + "OntologyObjectTypeNotFound": sql_queries_errors.OntologyObjectTypeNotFound, "OntologyQueryFailed": sql_queries_errors.OntologyQueryFailed, + "OntologyQueryInvalidObjectBackend": sql_queries_errors.OntologyQueryInvalidObjectBackend, + "OntologyQueryNestedObjectSetTooLarge": sql_queries_errors.OntologyQueryNestedObjectSetTooLarge, + "OntologyQueryStringColumnTooLong": sql_queries_errors.OntologyQueryStringColumnTooLong, "QueryParseError": sql_queries_errors.QueryParseError, }, response_mode=_sdk_internal.get("response_mode"), @@ -578,7 +586,11 @@ def execute_ontology( :rtype: typing.Awaitable[bytes] :raises ExecuteOntologySqlQueryPermissionDenied: Could not executeOntology the SqlQuery. + :raises OntologyObjectTypeNotFound: The ontology query referenced an object type RID that does not exist or is not visible to the requesting user. Verify the RID (e.g. via list-object-types or get-object-type-details) and retry. :raises OntologyQueryFailed: The Ontology query failed. + :raises OntologyQueryInvalidObjectBackend: The ontology query references object types or link types indexed in Object Storage V1, which is incompatible with Ontology SQL. Migrate the entities to Object Storage V2 or remove them from the query. + :raises OntologyQueryNestedObjectSetTooLarge: The query references too many objects across joins, link lookups, or sub-queries. Narrow the scope (add filters, reduce joins, restrict object types) and retry. The actual and maximum object counts are returned as parameters. + :raises OntologyQueryStringColumnTooLong: A string column in the query result contains a value larger than the platform's per-cell size limit. Exclude or filter the column, or scope the query to skip the oversized rows. :raises QueryParseError: The query cannot be parsed. """ @@ -604,7 +616,11 @@ def execute_ontology( request_timeout=request_timeout, throwable_errors={ "ExecuteOntologySqlQueryPermissionDenied": sql_queries_errors.ExecuteOntologySqlQueryPermissionDenied, + "OntologyObjectTypeNotFound": sql_queries_errors.OntologyObjectTypeNotFound, "OntologyQueryFailed": sql_queries_errors.OntologyQueryFailed, + "OntologyQueryInvalidObjectBackend": sql_queries_errors.OntologyQueryInvalidObjectBackend, + "OntologyQueryNestedObjectSetTooLarge": sql_queries_errors.OntologyQueryNestedObjectSetTooLarge, + "OntologyQueryStringColumnTooLong": sql_queries_errors.OntologyQueryStringColumnTooLong, "QueryParseError": sql_queries_errors.QueryParseError, }, response_mode=_sdk_internal.get("response_mode"),