import type * as _Core from "@osdk/foundry.core"; import type { SharedClient as $OldClient, SharedClientContext as $OldClientContext } from "@osdk/shared.client"; import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2"; import type * as _Ontologies from "../_components.js"; /** * Creates a temporary `ObjectSet` from the given definition. This `ObjectSet` expires after one hour. * * @beta * * Required Scopes: [api:ontologies-read, api:ontologies-write] * URL: /v2/ontologies/{ontology}/objectSets/createTemporary */ export declare function createTemporary($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [ ontology: _Ontologies.OntologyIdentifier, $body: _Ontologies.CreateTemporaryObjectSetRequestV2, $queryParams?: { branch?: _Core.FoundryBranch | undefined; sdkPackageRid?: _Ontologies.SdkPackageRid | undefined; sdkVersion?: _Ontologies.SdkVersion | undefined; }, $headerParams?: { traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies.CreateTemporaryObjectSetResponseV2>; /** * Gets the definition of the `ObjectSet` with the given RID. * * @alpha * * Required Scopes: [] * URL: /v2/ontologies/{ontology}/objectSets/{objectSetRid} */ export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [ ontology: _Ontologies.OntologyIdentifier, objectSetRid: _Ontologies.ObjectSetRid ]): Promise<_Ontologies.ObjectSet>; /** * Load the ontology objects present in the `ObjectSet` from the provided object set definition. * * For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects * are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. * * Note that null value properties will not be returned. * * Vector properties will not be returned unless included in the `select` parameter. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectSets/loadObjects */ export declare function load($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [ ontology: _Ontologies.OntologyIdentifier, $body: _Ontologies.LoadObjectSetRequestV2, $queryParams?: { sdkPackageRid?: _Ontologies.SdkPackageRid | undefined; sdkVersion?: _Ontologies.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; transactionId?: _Ontologies.OntologyTransactionId | undefined; }, $headerParams?: { traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies.LoadObjectSetResponseV2>; /** * Load the ontology objects present in the `ObjectSet` from the provided object set definition. The resulting * objects may be scoped to an object type, in which all the selected properties on the object type are returned, or scoped * to an interface, in which only the object type properties that implement the properties of any interfaces in its * scope are returned. For objects that are scoped to an interface in the result, a mapping from interface to * object implementation is returned in order to interpret the objects as the interfaces that they implement. * * For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects * are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. * * Note that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey) * will be prefixed with '$' instead of '\_\_' as is the case in `loadObjects`. * * Vector properties will not be returned unless included in the `select` parameter. * * @beta * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectSets/loadObjectsMultipleObjectTypes */ export declare function loadMultipleObjectTypes($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [ ontology: _Ontologies.OntologyIdentifier, $body: _Ontologies.LoadObjectSetV2MultipleObjectTypesRequest, $queryParams?: { sdkPackageRid?: _Ontologies.SdkPackageRid | undefined; sdkVersion?: _Ontologies.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; transactionId?: _Ontologies.OntologyTransactionId | undefined; preview?: _Core.PreviewMode | undefined; }, $headerParams?: { traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies.LoadObjectSetV2MultipleObjectTypesResponse>; /** * Load the ontology objects present in the `ObjectSet` from the provided object set definition. If the requested * object set contains interfaces and the object can be viewed as an interface, it will contain the properties * defined by the interface. If not, it will contain the properties defined by its object type. This allows directly * loading all objects of an interface where all objects are viewed as the interface, for example. * * Note that the result object set cannot contain a mix of objects with "interface" properties and "object type" * properties. Attempting to load an object set like this will result in an error. * * For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects * are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. * * Note that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey) * will be prefixed with '$' instead of '\_\_' as is the case in `/loadObjects`. * * Vector properties will not be returned unless included in the `select` parameter. * * @beta * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectSets/loadObjectsOrInterfaces */ export declare function loadObjectsOrInterfaces($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [ ontology: _Ontologies.OntologyIdentifier, $body: _Ontologies.LoadObjectSetV2ObjectsOrInterfacesRequest, $queryParams?: { sdkPackageRid?: _Ontologies.SdkPackageRid | undefined; sdkVersion?: _Ontologies.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; transactionId?: _Ontologies.OntologyTransactionId | undefined; preview?: _Core.PreviewMode | undefined; }, $headerParams?: { traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies.LoadObjectSetV2ObjectsOrInterfacesResponse>; /** * Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectSets/aggregate */ export declare function aggregate($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [ ontology: _Ontologies.OntologyIdentifier, $body: _Ontologies.AggregateObjectSetRequestV2, $queryParams?: { sdkPackageRid?: _Ontologies.SdkPackageRid | undefined; sdkVersion?: _Ontologies.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; transactionId?: _Ontologies.OntologyTransactionId | undefined; }, $headerParams?: { traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies.AggregateObjectsResponseV2>; /** * Loads the specified links from the defined object set. * * Links are defined as a link type API name and object locators for the source and target objects * where only the `__primaryKey` and `__apiName` properties are loaded. * * Links are grouped by source object locator; however, the links for a given source object may be * split over multiple entries with the same source object locator. * * Please keep these limitations in mind: * * * Links returned may be stale. For example, primary keys returned by this endpoint may not exist anymore. * * This endpoint requests links for 1,000 objects at a time. If, for any page of 1,000 objects, there are more * than 100,000 links present, results are limited to 100,000 links and should be considered partial. * * This endpoint does not support OSv1 links and will return an error if links provided are backed by OSv1. * * This endpoint currently does not support interface object sets or interface links, but support will be added in the near future. * * @alpha * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectSets/loadLinks */ export declare function loadLinks($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [ ontology: _Ontologies.OntologyIdentifier, $body: _Ontologies.LoadObjectSetLinksRequestV2, $queryParams?: { sdkPackageRid?: _Ontologies.SdkPackageRid | undefined; sdkVersion?: _Ontologies.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; preview?: _Core.PreviewMode | undefined; }, $headerParams?: { traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies.LoadObjectSetLinksResponseV2>; //# sourceMappingURL=OntologyObjectSet.d.ts.map