/** * Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is * not updated. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/{datasetRid}/transactions/{transactionRid}/abort */ declare function abort($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, transactionRid: _Datasets_2.TransactionRid ]): Promise<_Datasets_2.Transaction>; /* Excluded from this release type: abort_2 */ /** * If any job in the build is unsuccessful, immediately finish the build by cancelling all other jobs. * * Log Safety: SAFE */ declare type AbortOnFailure = boolean; /** * The provided token does not have permission to abort the given transaction on the given dataset. * * Log Safety: SAFE */ declare interface AbortTransactionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AbortTransactionPermissionDenied"; errorDescription: "The provided token does not have permission to abort the given transaction on the given dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; }; } /** * ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. * * Log Safety: UNSAFE */ declare interface AbsoluteTimeRange { startTime?: string; endTime?: string; } /** * Calculates absolute value of a numeric value. * * Log Safety: UNSAFE */ declare interface AbsoluteValuePropertyExpression { property: DerivedPropertyDefinition; } /** * Access requirements for a resource are composed of Markings and Organizations. Organizations are disjunctive, while Markings are conjunctive. * * Log Safety: UNSAFE */ declare interface AccessRequirements { organizations: Array; markings: Array; } /** * Checkpoint justification that requires the user to mark a checkbox. * * Log Safety: UNSAFE */ declare interface AcknowledgementJustification { prompt: string; description?: string; title: string; } /** * User that performed the checkpoint action. * * Log Safety: UNSAFE */ declare interface ActingUser { userId: _Core.UserId; username: RedactableString; organizationRid?: OrganizationRid_2; } /** * Log Safety: UNSAFE */ declare type Action = LooselyBrandedString_5<"Action">; /** * Log Safety: UNSAFE */ declare interface Action_2 { target: BuildTarget; branchName: _Core.BranchName; fallbackBranches: FallbackBranches; forceBuild: ForceBuild; retryCount?: RetryCount; retryBackoffDuration?: RetryBackoffDuration; abortOnFailure: AbortOnFailure; notificationsEnabled: NotificationsEnabled; } /** * The given action request has multiple edits on the same object. * * Log Safety: SAFE */ declare interface ActionContainsDuplicateEdits { errorCode: "CONFLICT"; errorName: "ActionContainsDuplicateEdits"; errorDescription: "The given action request has multiple edits on the same object."; errorInstanceId: string; parameters: {}; } /** * Actions attempted to edit properties that could not be found on the object type. Please contact the Ontology administrator to resolve this issue. * * Log Safety: SAFE */ declare interface ActionEditedPropertiesNotFound { errorCode: "INVALID_ARGUMENT"; errorName: "ActionEditedPropertiesNotFound"; errorDescription: "Actions attempted to edit properties that could not be found on the object type. Please contact the Ontology administrator to resolve this issue."; errorInstanceId: string; parameters: {}; } /** * Returning action edits is not supported when using marketplace bindings. * * Log Safety: SAFE */ declare interface ActionEditsNotSupportedWithMarketplace { errorCode: "INVALID_ARGUMENT"; errorName: "ActionEditsNotSupportedWithMarketplace"; errorDescription: "Returning action edits is not supported when using marketplace bindings."; errorInstanceId: string; parameters: {}; } /** * The given action request performs edits on a type that is read-only or does not allow edits. * * Log Safety: SAFE */ declare interface ActionEditsReadOnlyEntity { errorCode: "INVALID_ARGUMENT"; errorName: "ActionEditsReadOnlyEntity"; errorDescription: "The given action request performs edits on a type that is read-only or does not allow edits."; errorInstanceId: string; parameters: { entityTypeRid: unknown; }; } /** * An ISO 8601 timestamp. * * Log Safety: SAFE */ declare type ActionExecutionTime = string; /** * A detailed operation for an Action * * Log Safety: UNSAFE */ declare type ActionLogicRule = ({ type: "modifyInterface"; } & ModifyInterfaceLogicRule) | ({ type: "createOrModifyObject"; } & CreateOrModifyObjectLogicRule) | ({ type: "modifyObject"; } & ModifyObjectLogicRule) | ({ type: "deleteLink"; } & DeleteLinkLogicRule) | ({ type: "createObject"; } & CreateObjectLogicRule) | ({ type: "createLink"; } & CreateLinkLogicRule) | ({ type: "batchedFunction"; } & BatchedFunctionLogicRule) | ({ type: "createOrModifyObjectV2"; } & CreateOrModifyObjectLogicRuleV2) | ({ type: "deleteInterfaceLink"; } & DeleteInterfaceLinkLogicRule) | ({ type: "deleteObject"; } & DeleteObjectLogicRule) | ({ type: "function"; } & FunctionLogicRule) | ({ type: "createInterfaceLink"; } & CreateInterfaceLinkLogicRule) | ({ type: "createInterface"; } & CreateInterfaceLogicRule) | ({ type: "applyScenario"; } & ApplyScenarioLogicRule); /** * Log Safety: SAFE */ declare type ActionMode = "ASYNC" | "RUN" | "VALIDATE"; /** * The action is not found, or the user does not have access to it. * * Log Safety: SAFE */ declare interface ActionNotFound { errorCode: "NOT_FOUND"; errorName: "ActionNotFound"; errorDescription: "The action is not found, or the user does not have access to it."; errorInstanceId: string; parameters: { actionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ActionParameterArrayType { subType: ActionParameterType; } /** * The parameter references an interface type that could not be found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface ActionParameterInterfaceTypeNotFound { errorCode: "NOT_FOUND"; errorName: "ActionParameterInterfaceTypeNotFound"; errorDescription: "The parameter references an interface type that could not be found, or the client token does not have access to it."; errorInstanceId: string; parameters: { parameterId: unknown; }; } /** * The parameter object reference or parameter default value is not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface ActionParameterObjectNotFound { errorCode: "NOT_FOUND"; errorName: "ActionParameterObjectNotFound"; errorDescription: "The parameter object reference or parameter default value is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { parameterId: unknown; }; } /** * The parameter references an object type that could not be found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface ActionParameterObjectTypeNotFound { errorCode: "NOT_FOUND"; errorName: "ActionParameterObjectTypeNotFound"; errorDescription: "The parameter references an object type that could not be found, or the client token does not have access to it."; errorInstanceId: string; parameters: { parameterId: unknown; }; } /** * The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type ActionParameterRid = LooselyBrandedString_5<"ActionParameterRid">; /** * A union of all the types supported by Ontology Action parameters. * * Log Safety: UNSAFE */ declare type ActionParameterType = ({ type: "date"; } & _Core.DateType) | ({ type: "interfaceObject"; } & OntologyInterfaceObjectType) | ({ type: "struct"; } & OntologyStructType) | ({ type: "string"; } & _Core.StringType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "geoshape"; } & _Core.GeoShapeType) | ({ type: "long"; } & _Core.LongType) | ({ type: "objectType"; } & OntologyObjectTypeReferenceType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "marking"; } & _Core.MarkingType) | ({ type: "scenarioReference"; } & _Core.ScenarioReferenceType) | ({ type: "attachment"; } & _Core.AttachmentType) | ({ type: "mediaReference"; } & _Core.MediaReferenceType) | ({ type: "array"; } & ActionParameterArrayType) | ({ type: "objectSet"; } & OntologyObjectSetType) | ({ type: "geohash"; } & _Core.GeohashType) | ({ type: "vector"; } & _Core.VectorType) | ({ type: "object"; } & OntologyObjectType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * Details about a parameter of an action. * * Log Safety: UNSAFE */ declare interface ActionParameterV2 { displayName: _Core.DisplayName; description?: string; dataType: ActionParameterType; required: boolean; typeClasses: Array; validation?: ActionParameterValidation; } /** * Validation metadata surfaced for a parameter. * * Log Safety: UNSAFE */ declare interface ActionParameterValidation { defaultValidation: ActionParameterValidationBlock; } /** * Validation constraints for a parameter. * * Log Safety: UNSAFE */ declare interface ActionParameterValidationBlock { allowedValues?: ParameterAllowedValues; arraySize?: ParameterArraySize; } /** * Log Safety: UNSAFE */ declare type ActionResults = ({ type: "edits"; } & ObjectEdits) | ({ type: "largeScaleEdits"; } & ObjectTypeEdits); /** * The unique resource identifier for an action. * * Log Safety: SAFE */ declare type ActionRid = LooselyBrandedString_5<"ActionRid">; export declare namespace Actions { export { apply, applyBatch } } /** * The unique resource identifier of an action section, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type ActionSectionRid = LooselyBrandedString_5<"ActionSectionRid">; /** * Represents an action type in the Ontology. * * Log Safety: UNSAFE */ declare interface ActionType { apiName: ActionTypeApiName; description?: string; displayName?: _Core.DisplayName; status: _Core.ReleaseStatus; parameters: Record; rid: ActionTypeRid; operations: Array; } /** * The name of the action type in the API. To find the API name for your Action Type, use the List action types endpoint or check the Ontology Manager. * * Log Safety: UNSAFE */ declare type ActionTypeApiName = LooselyBrandedString_5<"ActionTypeApiName">; /** * Returns action types with an api name matching the given string predicate. * * Log Safety: UNSAFE */ declare interface ActionTypeApiNameActionTypesQueryV2 { value: FullTextStringPredicateV2; } /** * Returns action types with a description matching the given string predicate. * * Log Safety: UNSAFE */ declare interface ActionTypeDescriptionActionTypesQueryV2 { value: FullTextStringPredicateV2; } /** * Returns action types with a display name matching the given string predicate. * * Log Safety: UNSAFE */ declare interface ActionTypeDisplayNameActionTypesQueryV2 { value: FullTextStringPredicateV2; } /** * Returns the full metadata for an Action type in the Ontology. * * Log Safety: UNSAFE */ declare interface ActionTypeFullMetadata { actionType: ActionTypeV2; fullLogicRules: Array; } /** * Fuzziness setting applied to contains full-text string predicates in the search query. If not provided, auto is used. * * Log Safety: UNSAFE */ declare type ActionTypeFuzziness = ({ type: "auto"; } & FuzzinessAuto) | ({ type: "off"; } & FuzzinessOff); /** * Filter action types by the type of logic rule they contain. * * Log Safety: SAFE */ declare type ActionTypeLogicRuleTypeFilter = "ADD_OBJECT" | "MODIFY_OBJECT" | "DELETE_OBJECT" | "ADD_LINK" | "DELETE_LINK" | "FUNCTION" | "BATCHED_FUNCTION" | "ADD_OR_MODIFY_OBJECT" | "ADD_OR_MODIFY_OBJECT_V2"; /** * The action type is not found, or the user does not have access to it. * * Log Safety: UNSAFE */ declare interface ActionTypeNotFound { errorCode: "NOT_FOUND"; errorName: "ActionTypeNotFound"; errorDescription: "The action type is not found, or the user does not have access to it."; errorInstanceId: string; parameters: { actionType: unknown; rid: unknown; }; } /** * An action tool configured on the Agent references an action type that could not be found. This can surface at runtime if the action type was deleted or is not accessible to the calling token. Verify the action type exists and is accessible, then review the Agent's tools in AIP Chatbot Studio. * * Log Safety: SAFE */ declare interface ActionTypeNotFound_2 { errorCode: "INVALID_ARGUMENT"; errorName: "ActionTypeNotFound"; errorDescription: "An action tool configured on the Agent references an action type that could not be found. This can surface at runtime if the action type was deleted or is not accessible to the calling token. Verify the action type exists and is accessible, then review the Agent's tools in AIP Chatbot Studio."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; actionRid: unknown; }; } /** * Filter action types by permission model. * * Log Safety: SAFE */ declare type ActionTypePermissionModelFilter = "DATASOURCE_DERIVED_PERMISSIONS" | "ONTOLOGY_ROLES" | "COMPASS_PROJECT"; /** * The unique resource identifier of an action type, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type ActionTypeRid = LooselyBrandedString_5<"ActionTypeRid">; /** * Returns action types with the given rid. * * Log Safety: SAFE */ declare interface ActionTypeRidActionTypesQueryV2 { value: ActionTypeRid; } /** * Represents the search query for an action type search. Supports filters for various action type features. * * Log Safety: UNSAFE */ declare type ActionTypeSearchJsonQueryV2 = ({ type: "webhookRid"; } & WebhookRidActionTypesQueryV2) | ({ type: "hasActionLog"; } & HasActionLogActionTypesQueryV2) | ({ type: "actionTypeApiName"; } & ActionTypeApiNameActionTypesQueryV2) | ({ type: "or"; } & OrActionTypesQueryV2) | ({ type: "permissionModel"; } & PermissionModelActionTypesQueryV2) | ({ type: "hasWebhook"; } & HasWebhookActionTypesQueryV2) | ({ type: "actionTypeDisplayName"; } & ActionTypeDisplayNameActionTypesQueryV2) | ({ type: "affectedLinkTypeRid"; } & AffectedLinkTypeRidActionTypesQueryV2) | ({ type: "actionTypeDescription"; } & ActionTypeDescriptionActionTypesQueryV2) | ({ type: "sectionRid"; } & SectionRidActionTypesQueryV2) | ({ type: "parameterRid"; } & ParameterRidActionTypesQueryV2) | ({ type: "parameterName"; } & ParameterNameActionTypesQueryV2) | ({ type: "hasNotification"; } & HasNotificationActionTypesQueryV2) | ({ type: "functionRid"; } & FunctionRidActionTypesQueryV2) | ({ type: "inputObjectTypeRid"; } & InputObjectTypeRidActionTypesQueryV2) | ({ type: "revertActionEnabled"; } & RevertActionEnabledActionTypesQueryV2) | ({ type: "logicRule"; } & LogicRuleActionTypesQueryV2) | ({ type: "typeClasses"; } & TypeClassesActionTypesQueryV2) | ({ type: "affectedInterfaceTypeRid"; } & AffectedInterfaceTypeRidActionTypesQueryV2) | ({ type: "and"; } & AndActionTypesQueryV2) | ({ type: "actionTypeRid"; } & ActionTypeRidActionTypesQueryV2) | ({ type: "affectedObjectTypeRid"; } & AffectedObjectTypeRidActionTypesQueryV2) | ({ type: "status"; } & StatusActionTypesQueryV2); export declare namespace ActionTypesFullMetadata { export { } } /** * Specifies the field to sort action types by. * * Log Safety: SAFE */ declare type ActionTypeSortByV2 = "actionTypeDisplayName"; /** * Filter action types by status. * * Log Safety: SAFE */ declare type ActionTypeStatusFilter = "EXPERIMENTAL" | "ACTIVE" | "DEPRECATED" | "EXAMPLE"; export declare namespace ActionTypesV2 { export { list_21 as list, get_26 as get, getByRid } } /** * Represents an action type in the Ontology. * * Log Safety: UNSAFE */ declare interface ActionTypeV2 { apiName: ActionTypeApiName; description?: string; displayName?: _Core.DisplayName; status: _Core.ReleaseStatus; parameters: Record; rid: ActionTypeRid; operations: Array; toolDescription?: string; } /** * The validation failed for the given action parameters. Please use the validateAction endpoint for more details. * * Log Safety: UNSAFE */ declare interface ActionValidationFailed { errorCode: "INVALID_ARGUMENT"; errorName: "ActionValidationFailed"; errorDescription: "The validation failed for the given action parameters. Please use the validateAction endpoint for more details."; errorInstanceId: string; parameters: { actionType: unknown; }; } /** * This status indicates that the PropertyType will not change on short notice and should thus be safe to use in user facing workflows. * * Log Safety: SAFE */ declare interface ActivePropertyTypeStatus { } /** * Activity event broadcast to all clients after being applied on server. * * Log Safety: UNSAFE */ declare type ActivityCollaborativeUpdate = ({ type: "activityDeleted"; } & ActivityDeleted) | ({ type: "activityCreated"; } & ActivityCreated) | ({ type: "error"; } & ErrorMessage); /** * The event that gets published to PACK channels to update a users activity feed as new events are added to a particular resource. * * Log Safety: UNSAFE */ declare interface ActivityCreated { activityEvent: ActivityEvent; } /** * The event that gets published to PACK channels to update a users activity feed whenever an event is removed from a particular resource. * * Log Safety: UNSAFE */ declare interface ActivityDeleted { eventId: EventId; aggregationKey?: string; } /** * A single activity event associated with a particular document. The eventData union discriminant determines the type of event: platform-defined events (e.g. document create, rename, security changes) and custom application-defined events. * * Log Safety: UNSAFE */ declare interface ActivityEvent { eventId: EventId; eventData: EventDataUnion; isRead: boolean; aggregationKey: string; createdBy: _Core.CreatedBy; createdTime: _Core.CreatedTime; } /* Excluded from this release type: add */ /** * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/groups/{groupId}/groupMembers/add */ declare function add_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [groupId: _Core.GroupId, $body: _Admin.AddGroupMembersRequest]): Promise; /** * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/markings/{markingId}/markingMembers/add */ declare function add_3($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [markingId: _Core.MarkingId, $body: _Admin.AddMarkingMembersRequest]): Promise; /** * Adds role assignments for the given Marking. For Organization markings, only the USE and DECLASSIFY * roles are supported; the ADMINISTER role must be managed via the Organization Role Assignment endpoints. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/markings/{markingId}/roleAssignments/add */ declare function add_4($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ markingId: _Core.MarkingId, $body: _Admin.AddMarkingRoleAssignmentsRequest ]): Promise; /* Excluded from this release type: add_5 */ /** * Assign roles to principals for the given Organization. At most 100 role assignments can be added in a single request. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/organizations/{organizationRid}/roleAssignments/add */ declare function add_6($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ organizationRid: _Core.OrganizationRid, $body: _Admin.AddOrganizationRoleAssignmentsRequest ]): Promise; /** * Add references to the given project * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/projects/{projectRid}/references/add */ declare function add_7($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ projectRid: _Filesystem_2.ProjectRid, $body: _Filesystem_2.AddProjectResourceReferencesRequest ]): Promise; /** * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/resources/{resourceRid}/roles/add */ declare function add_8($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ resourceRid: _Filesystem_2.ResourceRid, $body: _Filesystem_2.AddResourceRolesRequest ]): Promise; /* Excluded from this release type: add_9 */ /** * Adds one or more backing datasets to a View. Any duplicates with the same dataset RID and branch name are * ignored. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/views/{viewDatasetRid}/addBackingDatasets */ declare function addBackingDatasets($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ viewDatasetRid: _Core.DatasetRid, $body: _Datasets_2.AddBackingDatasetsRequest ]): Promise<_Datasets_2.View>; /** * Could not addBackingDatasets the View. * * Log Safety: SAFE */ declare interface AddBackingDatasetsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddBackingDatasetsPermissionDenied"; errorDescription: "Could not addBackingDatasets the View."; errorInstanceId: string; parameters: { viewDatasetRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface AddBackingDatasetsRequest { branch?: _Core.BranchName; backingDatasets: Array; } /** * Could not add the EnrollmentRoleAssignment. * * Log Safety: SAFE */ declare interface AddEnrollmentRoleAssignmentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddEnrollmentRoleAssignmentsPermissionDenied"; errorDescription: "Could not add the EnrollmentRoleAssignment."; errorInstanceId: string; parameters: { enrollmentRid: unknown; }; } /** * Log Safety: SAFE */ declare interface AddEnrollmentRoleAssignmentsRequest { roleAssignments: Array<_Core.RoleAssignmentUpdate>; } /** * A request to add an external resource as a reference to a project * * Log Safety: UNSAFE */ declare interface AddExternalResourceReferenceRequest { resourceRid: string; importName: string; } /** * A request to add a resource from the filesystem as a reference to a project * * Log Safety: UNSAFE */ declare interface AddFilesystemResourceReferenceRequest { resourceRid: ResourceRid; } /** * Could not add the GroupMember. * * Log Safety: SAFE */ declare interface AddGroupMembersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddGroupMembersPermissionDenied"; errorDescription: "Could not add the GroupMember."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * Log Safety: SAFE */ declare interface AddGroupMembersRequest { principalIds: Array<_Core.PrincipalId>; expiration?: GroupMembershipExpiration; } /** * The user is not authorized to add a a group to the parent group required to create the project from template. * * Log Safety: UNSAFE */ declare interface AddGroupToParentGroupPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddGroupToParentGroupPermissionDenied"; errorDescription: "The user is not authorized to add a a group to the parent group required to create the project from template."; errorInstanceId: string; parameters: { parentGroupsWithoutPermission: unknown; }; } /** * The additional secrets must be specified as a plaintext value map. * * Log Safety: SAFE */ declare interface AdditionalSecretsMustBeSpecifiedAsPlaintextValueMap { errorCode: "INVALID_ARGUMENT"; errorName: "AdditionalSecretsMustBeSpecifiedAsPlaintextValueMap"; errorDescription: "The additional secrets must be specified as a plaintext value map."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface AddLink { linkTypeApiNameAtoB: LinkTypeApiName_2; linkTypeApiNameBtoA: LinkTypeApiName_2; aSideObject: LinkSideObject; bSideObject: LinkSideObject; } /** * Log Safety: UNSAFE */ declare interface AddLinkEdit { objectType: ObjectTypeApiName; primaryKey: PrimaryKeyValue; linkType: LinkTypeApiName_2; linkedObjectPrimaryKey: PrimaryKeyValue; } /** * Could not add the MarkingMember. * * Log Safety: UNSAFE */ declare interface AddMarkingMembersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddMarkingMembersPermissionDenied"; errorDescription: "Could not add the MarkingMember."; errorInstanceId: string; parameters: { markingId: unknown; }; } /** * Log Safety: SAFE */ declare interface AddMarkingMembersRequest { principalIds: Array<_Core.PrincipalId>; } /** * Could not add the MarkingRoleAssignment. * * Log Safety: UNSAFE */ declare interface AddMarkingRoleAssignmentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddMarkingRoleAssignmentsPermissionDenied"; errorDescription: "Could not add the MarkingRoleAssignment."; errorInstanceId: string; parameters: { markingId: unknown; }; } /** * Log Safety: SAFE */ declare interface AddMarkingRoleAssignmentsRequest { roleAssignments: Array; } /** * Adds a list of Markings to a resource. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/resources/{resourceRid}/addMarkings */ declare function addMarkings($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ resourceRid: _Filesystem_2.ResourceRid, $body: _Filesystem_2.AddMarkingsRequest ]): Promise; /** * Could not addMarkings the Resource. * * Log Safety: UNSAFE */ declare interface AddMarkingsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddMarkingsPermissionDenied"; errorDescription: "Could not addMarkings the Resource."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface AddMarkingsRequest { markingIds: Array<_Core.MarkingId>; } /** * Log Safety: UNSAFE */ declare interface AddObject { primaryKey: PropertyValue_2; objectType: ObjectTypeApiName; } /** * Log Safety: UNSAFE */ declare interface AddObjectEdit { objectType: ObjectTypeApiName; properties: Record; } /** * Could not add the OrganizationGuestMember. * * Log Safety: SAFE */ declare interface AddOrganizationGuestMembersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddOrganizationGuestMembersPermissionDenied"; errorDescription: "Could not add the OrganizationGuestMember."; errorInstanceId: string; parameters: { organizationRid: unknown; }; } /** * Log Safety: SAFE */ declare interface AddOrganizationGuestMembersRequest { principalIds: Array<_Core.PrincipalId>; } /** * Could not add the OrganizationRoleAssignment. * * Log Safety: SAFE */ declare interface AddOrganizationRoleAssignmentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddOrganizationRoleAssignmentsPermissionDenied"; errorDescription: "Could not add the OrganizationRoleAssignment."; errorInstanceId: string; parameters: { organizationRid: unknown; }; } /** * Log Safety: SAFE */ declare interface AddOrganizationRoleAssignmentsRequest { roleAssignments: Array<_Core.RoleAssignmentUpdate>; } /** * Adds a list of Organizations to a Project. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/projects/{projectRid}/addOrganizations */ declare function addOrganizations($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ projectRid: _Filesystem_2.ProjectRid, $body: _Filesystem_2.AddOrganizationsRequest ]): Promise; /** * Could not addOrganizations the Project. * * Log Safety: SAFE */ declare interface AddOrganizationsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddOrganizationsPermissionDenied"; errorDescription: "Could not addOrganizations the Project."; errorInstanceId: string; parameters: { projectRid: unknown; }; } /** * Log Safety: SAFE */ declare interface AddOrganizationsRequest { organizationRids: Array<_Core.OrganizationRid>; } /** * Adds a primary key to a View that does not already have one. Primary keys are treated as * guarantees provided by the creator of the dataset. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/views/{viewDatasetRid}/addPrimaryKey */ declare function addPrimaryKey($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ viewDatasetRid: _Core.DatasetRid, $body: _Datasets_2.AddPrimaryKeyRequest ]): Promise<_Datasets_2.View>; /** * Could not addPrimaryKey the View. * * Log Safety: SAFE */ declare interface AddPrimaryKeyPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddPrimaryKeyPermissionDenied"; errorDescription: "Could not addPrimaryKey the View."; errorInstanceId: string; parameters: { viewDatasetRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface AddPrimaryKeyRequest { branch?: _Core.BranchName; primaryKey: ViewPrimaryKey; } /** * Could not add the ProjectResourceReference. * * Log Safety: SAFE */ declare interface AddProjectResourceReferencesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddProjectResourceReferencesPermissionDenied"; errorDescription: "Could not add the ProjectResourceReference."; errorInstanceId: string; parameters: { projectRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface AddProjectResourceReferencesRequest { resources: Array; } /** * Adds two or more numeric values. * * Log Safety: UNSAFE */ declare interface AddPropertyExpression { properties: Array; } /** * A request to add a resource as a reference to a project * * Log Safety: UNSAFE */ declare type AddResourceReferenceRequest = ({ type: "external"; } & AddExternalResourceReferenceRequest) | ({ type: "filesystem"; } & AddFilesystemResourceReferenceRequest); /** * Could not add the ResourceRole. * * Log Safety: UNSAFE */ declare interface AddResourceRolesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddResourceRolesPermissionDenied"; errorDescription: "Could not add the ResourceRole."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Log Safety: SAFE */ declare interface AddResourceRolesRequest { roles: Array; } /** * Could not add the ResourceTag. * * Log Safety: UNSAFE */ declare interface AddResourceTagsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AddResourceTagsPermissionDenied"; errorDescription: "Could not add the ResourceTag."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Log Safety: SAFE */ declare interface AddResourceTagsRequest { tagRids: Array; } export declare namespace Admin { export { AddEnrollmentRoleAssignmentsRequest, AddGroupMembersRequest, AddMarkingMembersRequest, AddMarkingRoleAssignmentsRequest, AddOrganizationGuestMembersRequest, AddOrganizationRoleAssignmentsRequest, AttributeName, AttributeValue, AttributeValues, AuthenticationProtocol, AuthenticationProvider, AuthenticationProviderEnabled, AuthenticationProviderName, AuthenticationProviderRid, CbacBanner, CbacBannerClassificationString, CbacMarkingRestrictions, CbacMarkingRestrictionsIsValid, CbacMarkingRestrictionsUserSatisfiesMarkings, CertificateInfo, CertificateUsageType, ClassificationBannerDisplayType, CreateGroupRequest, CreateMarkingCategoryRequest, CreateMarkingRequest, CreateOrganizationRequest, Enrollment, EnrollmentName, EnrollmentRoleAssignment, GetGroupsBatchRequestElement, GetGroupsBatchResponse, GetMarkingsBatchRequestElement, GetMarkingsBatchResponse, GetRolesBatchRequestElement, GetRolesBatchResponse, GetUserMarkingsResponse, GetUsersBatchRequestElement, GetUsersBatchResponse, Group, GroupMember, GroupMembership, GroupMembershipExpiration, GroupMembershipExpirationPolicy, GroupName_2 as GroupName, GroupProviderInfo, GroupSearchFilter, Host, HostName, ListAuthenticationProvidersResponse, ListAvailableOrganizationRolesResponse, ListCurrentGroupsResponse, ListDeletedUsersResponse, ListEnrollmentRoleAssignmentsResponse, ListGroupMembershipsResponse, ListGroupMembersResponse, ListGroupsResponse, ListHostsResponse, ListMarkingCategoriesResponse, ListMarkingMembersResponse, ListMarkingRoleAssignmentsResponse, ListMarkingsResponse, ListOrganizationGuestMembersResponse, ListOrganizationRoleAssignmentsResponse, ListUsersResponse, Marking, MarkingCategory, MarkingCategoryDescription, MarkingCategoryId, MarkingCategoryName, MarkingCategoryPermissions, MarkingCategoryPermissionsIsPublic, MarkingCategoryRole, MarkingCategoryRoleAssignment, MarkingCategoryType, MarkingMember, MarkingName, MarkingRole, MarkingRoleAssignment, MarkingRoleUpdate, MarkingType_2 as MarkingType, OidcAuthenticationProtocol, Organization, OrganizationGuestMember, OrganizationName, OrganizationRoleAssignment, ParseClassificationsRequest, ParseClassificationsResponse, PreregisterGroupRequest, PreregisterUserRequest, PrincipalFilterType, ProviderId, RemoveEnrollmentRoleAssignmentsRequest, RemoveGroupMembersRequest, RemoveMarkingMembersRequest, RemoveMarkingRoleAssignmentsRequest, RemoveOrganizationGuestMembersRequest, RemoveOrganizationRoleAssignmentsRequest, ReplaceGroupMembershipExpirationPolicyRequest, ReplaceGroupProviderInfoRequest, ReplaceGroupRequest, ReplaceMarkingCategoryRequest, ReplaceMarkingRequest, ReplaceOrganizationRequest, ReplaceUserProviderInfoRequest, Role_2 as Role, RoleDescription, RoleDisplayName, SamlAuthenticationProtocol, SamlServiceProviderMetadata, SearchGroupsRequest, SearchGroupsResponse, SearchUsersRequest, SearchUsersResponse, User, UserProviderInfo, UserSearchFilter, UserUsername, AddEnrollmentRoleAssignmentsPermissionDenied, AddGroupMembersPermissionDenied, AddMarkingMembersPermissionDenied, AddMarkingRoleAssignmentsPermissionDenied, AddOrganizationGuestMembersPermissionDenied, AddOrganizationRoleAssignmentsPermissionDenied, AttributesNotEditable, AuthenticationProviderNotFound, CannotReplaceProviderInfoForPrincipalInProtectedRealm, CbacBannerNotFound, CbacMarkingRestrictionsNotFound, CbacUnavailable, CreateGroupPermissionDenied, CreateMarkingCategoryMissingInitialAdminRole, CreateMarkingCategoryMissingOrganization, CreateMarkingCategoryPermissionDenied, CreateMarkingMissingInitialAdminRole, CreateMarkingPermissionDenied, CreateOrganizationMissingInitialAdminRole, CreateOrganizationPermissionDenied, DeleteGroupPermissionDenied, DeleteUserPermissionDenied, EnrollmentNotFound, EnrollmentRoleNotFound, ExpirationForTransitiveGroupMembersNotSupported, GetCbacBannerPermissionDenied, GetCbacMarkingRestrictionInfoPermissionDenied, GetCurrentEnrollmentPermissionDenied, GetCurrentUserPermissionDenied, GetGroupProviderInfoPermissionDenied, GetMarkingCategoryPermissionDenied, GetMarkingPermissionDenied, GetMarkingsUserPermissionDenied, GetProfilePictureOfUserPermissionDenied, GetUserProviderInfoPermissionDenied, GroupMembershipExpirationPolicyNotFound, GroupNameAlreadyExists, GroupNotFound, GroupProviderInfoNotFound, InvalidGroupMembershipExpiration, InvalidGroupOrganizations, InvalidHostName, InvalidProfilePicture, ListAvailableRolesOrganizationPermissionDenied, ListCurrentGroupsPermissionDenied, ListEnrollmentRoleAssignmentsPermissionDenied, ListGroupMembersPermissionDenied, ListHostsPermissionDenied, ListMarkingMembersPermissionDenied, ListMarkingRoleAssignmentsPermissionDenied, ListOrganizationGuestMembersPermissionDenied, ListOrganizationRoleAssignmentsPermissionDenied, MarkingCategoryNotFound, MarkingNameInCategoryAlreadyExists, MarkingNameIsEmpty, MarkingNotFound, OrganizationMarkingAdministerRoleNotSupported, OrganizationNameAlreadyExists, OrganizationNotFound, ParseClassificationsPermissionDenied, PreregisterGroupPermissionDenied, PreregisterUserPermissionDenied, PrincipalNotFound, ProfilePictureNotFound, ProfileServiceNotPresent, RemoveEnrollmentRoleAssignmentsPermissionDenied, RemoveGroupMembersPermissionDenied, RemoveMarkingMembersPermissionDenied, RemoveMarkingRoleAssignmentsPermissionDenied, RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed, RemoveOrganizationGuestMembersPermissionDenied, RemoveOrganizationRoleAssignmentsPermissionDenied, ReplaceGroupMembershipExpirationPolicyPermissionDenied, ReplaceGroupPermissionDenied, ReplaceGroupProviderInfoPermissionDenied, ReplaceMarkingCategoryPermissionDenied, ReplaceMarkingPermissionDenied, ReplaceOrganizationPermissionDenied, ReplaceUserProviderInfoPermissionDenied, RevokeAllTokensUserPermissionDenied, RoleNotFound, SearchGroupsPermissionDenied, SearchUsersPermissionDenied, UnknownClassificationBannerDisplayType, UserDeleted, UserIsActive, UserNotFound, UserProviderInfoNotFound, AuthenticationProviders, CbacBanners, CbacMarkingRestrictionsObjects, Enrollments, EnrollmentRoleAssignments, Groups, GroupMembers, GroupMemberships, GroupMembershipExpirationPolicies, GroupProviderInfos, Hosts, Markings, MarkingCategories, MarkingMembers, MarkingRoleAssignments, Organizations, OrganizationGuestMembers, OrganizationRoleAssignments, Roles, Users, UserProviderInfos } } declare namespace _Admin { export { LooselyBrandedString_3 as LooselyBrandedString, AddEnrollmentRoleAssignmentsRequest, AddGroupMembersRequest, AddMarkingMembersRequest, AddMarkingRoleAssignmentsRequest, AddOrganizationGuestMembersRequest, AddOrganizationRoleAssignmentsRequest, AttributeName, AttributeValue, AttributeValues, AuthenticationProtocol, AuthenticationProvider, AuthenticationProviderEnabled, AuthenticationProviderName, AuthenticationProviderRid, CbacBanner, CbacBannerClassificationString, CbacMarkingRestrictions, CbacMarkingRestrictionsIsValid, CbacMarkingRestrictionsUserSatisfiesMarkings, CertificateInfo, CertificateUsageType, ClassificationBannerDisplayType, CreateGroupRequest, CreateMarkingCategoryRequest, CreateMarkingRequest, CreateOrganizationRequest, Enrollment, EnrollmentName, EnrollmentRoleAssignment, GetGroupsBatchRequestElement, GetGroupsBatchResponse, GetMarkingsBatchRequestElement, GetMarkingsBatchResponse, GetRolesBatchRequestElement, GetRolesBatchResponse, GetUserMarkingsResponse, GetUsersBatchRequestElement, GetUsersBatchResponse, Group, GroupMember, GroupMembership, GroupMembershipExpiration, GroupMembershipExpirationPolicy, GroupName_2 as GroupName, GroupProviderInfo, GroupSearchFilter, Host, HostName, ListAuthenticationProvidersResponse, ListAvailableOrganizationRolesResponse, ListCurrentGroupsResponse, ListDeletedUsersResponse, ListEnrollmentRoleAssignmentsResponse, ListGroupMembershipsResponse, ListGroupMembersResponse, ListGroupsResponse, ListHostsResponse, ListMarkingCategoriesResponse, ListMarkingMembersResponse, ListMarkingRoleAssignmentsResponse, ListMarkingsResponse, ListOrganizationGuestMembersResponse, ListOrganizationRoleAssignmentsResponse, ListUsersResponse, Marking, MarkingCategory, MarkingCategoryDescription, MarkingCategoryId, MarkingCategoryName, MarkingCategoryPermissions, MarkingCategoryPermissionsIsPublic, MarkingCategoryRole, MarkingCategoryRoleAssignment, MarkingCategoryType, MarkingMember, MarkingName, MarkingRole, MarkingRoleAssignment, MarkingRoleUpdate, MarkingType_2 as MarkingType, OidcAuthenticationProtocol, Organization, OrganizationGuestMember, OrganizationName, OrganizationRoleAssignment, ParseClassificationsRequest, ParseClassificationsResponse, PreregisterGroupRequest, PreregisterUserRequest, PrincipalFilterType, ProviderId, RemoveEnrollmentRoleAssignmentsRequest, RemoveGroupMembersRequest, RemoveMarkingMembersRequest, RemoveMarkingRoleAssignmentsRequest, RemoveOrganizationGuestMembersRequest, RemoveOrganizationRoleAssignmentsRequest, ReplaceGroupMembershipExpirationPolicyRequest, ReplaceGroupProviderInfoRequest, ReplaceGroupRequest, ReplaceMarkingCategoryRequest, ReplaceMarkingRequest, ReplaceOrganizationRequest, ReplaceUserProviderInfoRequest, Role_2 as Role, RoleDescription, RoleDisplayName, SamlAuthenticationProtocol, SamlServiceProviderMetadata, SearchGroupsRequest, SearchGroupsResponse, SearchUsersRequest, SearchUsersResponse, User, UserProviderInfo, UserSearchFilter, UserUsername } } /** * Returns action types which edit the interface type with the given rid. * * Log Safety: SAFE */ declare interface AffectedInterfaceTypeRidActionTypesQueryV2 { value: InterfaceTypeRid; } /** * Returns action types which edit the link type with the given rid. * * Log Safety: SAFE */ declare interface AffectedLinkTypeRidActionTypesQueryV2 { value: LinkTypeRid; } /** * Returns action types which edit the object type with the given rid. * * Log Safety: SAFE */ declare interface AffectedObjectTypeRidActionTypesQueryV2 { value: ObjectTypeRid_2; } /** * Log Safety: SAFE */ declare interface AffectedResourcesResponse { datasets: Array; } /** * An affine transformation for geo-referencing. * * Log Safety: UNSAFE */ declare interface AffineTransform { xTranslate?: number; xScale?: number; xShear?: number; yTranslate?: number; yShear?: number; yScale?: number; } /** * Log Safety: UNSAFE */ declare interface Affix { prefix?: PropertyTypeReferenceOrStringConstant; postfix?: PropertyTypeReferenceOrStringConstant; } /** * Log Safety: UNSAFE */ declare interface Agent { rid: AgentRid; version: AgentVersionString; metadata: AgentMetadata; parameters: Record; } /** * The Agent was unable to produce an answer in the set number of maximum iterations. This can happen if the Agent gets confused or stuck in a loop, or if the query is too complex. Try a different query or review the Agent configuration in AIP Chatbot Studio. * * Log Safety: UNSAFE */ declare interface AgentIterationsExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "AgentIterationsExceededLimit"; errorDescription: "The Agent was unable to produce an answer in the set number of maximum iterations. This can happen if the Agent gets confused or stuck in a loop, or if the query is too complex. Try a different query or review the Agent configuration in AIP Chatbot Studio."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * The final answer for an exchange. Responses are formatted using markdown. * * Log Safety: UNSAFE */ declare type AgentMarkdownResponse = LooselyBrandedString_4<"AgentMarkdownResponse">; /** * Metadata for an Agent. * * Log Safety: UNSAFE */ declare interface AgentMetadata { displayName: string; description?: string; inputPlaceholder?: string; suggestedPrompts: Array; } /** * The given Agent could not be found. * * Log Safety: SAFE */ declare interface AgentNotFound { errorCode: "NOT_FOUND"; errorName: "AgentNotFound"; errorDescription: "The given Agent could not be found."; errorInstanceId: string; parameters: { agentRid: unknown; }; } /** * An RID identifying an Agent created in AIP Chatbot Studio. * * Log Safety: SAFE */ declare type AgentRid = LooselyBrandedString_4<"AgentRid">; /** * The Resource Identifier (RID) of an Agent. * * Log Safety: UNSAFE */ declare type AgentRid_2 = LooselyBrandedString_12<"AgentRid">; export declare namespace Agents { export { } } /** * Context retrieved from an Agent's configured context data sources which was relevant to the supplied user message. * * Log Safety: UNSAFE */ declare interface AgentSessionRagContextResponse { objectContexts: Array; functionRetrievedContexts: Array; } /** * A page of results for sessions across all accessible Agents for the calling user. Sessions are returned in order of most recently updated first. * * Log Safety: UNSAFE */ declare interface AgentsSessionsPage { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: SAFE */ declare interface AgentVersion { string: AgentVersionString; version: AgentVersionDetails; } /** * Semantic version details for an Agent. * * Log Safety: SAFE */ declare interface AgentVersionDetails { major: number; minor: number; } /** * The given AgentVersion could not be found. * * Log Safety: SAFE */ declare interface AgentVersionNotFound { errorCode: "NOT_FOUND"; errorName: "AgentVersionNotFound"; errorDescription: "The given AgentVersion could not be found."; errorInstanceId: string; parameters: { agentRid: unknown; agentVersionString: unknown; }; } export declare namespace AgentVersions { export { } } /** * The semantic version of the Agent, formatted as "majorVersion.minorVersion". * * Log Safety: SAFE */ declare type AgentVersionString = LooselyBrandedString_4<"AgentVersionString">; /* Excluded from this release type: aggregate */ /** * 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 */ declare function aggregate_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, $body: _Ontologies_2.AggregateObjectSetRequestV2, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; transactionId?: _Ontologies_2.OntologyTransactionId | undefined; scenarioRid?: _Ontologies_2.OntologyScenarioRid | undefined; executeInMemoryOnly?: boolean | undefined; }, $headerParams?: { traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies_2.AggregateObjectsResponseV2>; /** * Perform functions on object fields in the specified ontology and object type. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/aggregate */ declare function aggregate_3($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, $body: _Ontologies_2.AggregateObjectsRequestV2, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.AggregateObjectsResponseV2>; /** * Log Safety: UNSAFE */ declare interface AggregateObjectSetRequestV2 { aggregation: Array; objectSet: ObjectSet_2; groupBy: Array; accuracy?: AggregationAccuracyRequest; includeComputeUsage?: _Core.IncludeComputeUsage; } /** * Log Safety: UNSAFE */ declare interface AggregateObjectsRequest { aggregation: Array; query?: SearchJsonQuery; groupBy: Array; } /** * Log Safety: UNSAFE */ declare interface AggregateObjectsRequestV2 { aggregation: Array; where?: SearchJsonQueryV2_2; groupBy: Array; accuracy?: AggregationAccuracyRequest; } /** * Log Safety: UNSAFE */ declare interface AggregateObjectsResponse { excludedItems?: number; nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface AggregateObjectsResponseItem { group: Record; metrics: Array; } /** * Log Safety: UNSAFE */ declare interface AggregateObjectsResponseItemV2 { group: Record; metrics: Array; } /** * Log Safety: UNSAFE */ declare interface AggregateObjectsResponseV2 { excludedItems?: number; accuracy: AggregationAccuracy; data: Array; computeUsage?: _Core.ComputeSeconds; } /** * Log Safety: UNSAFE */ declare interface AggregateTimeSeries { method: TimeSeriesAggregationMethod; strategy: TimeSeriesAggregationStrategy; } /** * Specifies an aggregation function. * * Log Safety: UNSAFE */ declare type Aggregation = ({ type: "approximateDistinct"; } & ApproximateDistinctAggregation) | ({ type: "min"; } & MinAggregation) | ({ type: "avg"; } & AvgAggregation) | ({ type: "max"; } & MaxAggregation) | ({ type: "count"; } & CountAggregation) | ({ type: "sum"; } & SumAggregation); /** * Log Safety: SAFE */ declare type AggregationAccuracy = "ACCURATE" | "APPROXIMATE"; /** * The given aggregation cannot be performed with the requested accuracy. Try allowing approximate results or adjust your aggregation request. * * Log Safety: SAFE */ declare interface AggregationAccuracyNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "AggregationAccuracyNotSupported"; errorDescription: "The given aggregation cannot be performed with the requested accuracy. Try allowing approximate results or adjust your aggregation request."; errorInstanceId: string; parameters: {}; } /** * Specifies the accuracy requirement for aggregation results. REQUIRE_ACCURATE: Only return results if they are guaranteed to be accurate. If accuracy cannot be guaranteed (e.g., due to a low maxGroupCount relative to distinct values), the request will fail with an AggregationAccuracyNotSupported error. ALLOW_APPROXIMATE: Allow approximate results when exact computation is not feasible. This is the default behavior if not specified. * * Log Safety: SAFE */ declare type AggregationAccuracyRequest = "REQUIRE_ACCURATE" | "ALLOW_APPROXIMATE"; /** * The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the number of nested groupings in your request. * * Log Safety: SAFE */ declare interface AggregationDepthExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "AggregationDepthExceededLimit"; errorDescription: "The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the number of nested groupings in your request."; errorInstanceId: string; parameters: { depth: unknown; depthLimit: unknown; }; } /** * Divides objects into groups according to an interval. Note that this grouping applies only on date types. The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. * * Log Safety: UNSAFE */ declare interface AggregationDurationGrouping { field: FieldNameV1; duration: Duration_2; } /** * Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. When grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface AggregationDurationGroupingV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: number; unit: TimeUnit_2; } /** * Divides objects into groups according to an exact value. * * Log Safety: UNSAFE */ declare interface AggregationExactGrouping { field: FieldNameV1; maxGroupCount?: number; } /** * Divides objects into groups according to an exact value. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface AggregationExactGroupingV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; maxGroupCount?: number; defaultValue?: string; includeNullValues?: boolean; } /** * Divides objects into groups with the specified width. * * Log Safety: UNSAFE */ declare interface AggregationFixedWidthGrouping { field: FieldNameV1; fixedWidth: number; } /** * Divides objects into groups with the specified width. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface AggregationFixedWidthGroupingV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; fixedWidth: number; } /** * Specifies a grouping for aggregation results. * * Log Safety: UNSAFE */ declare type AggregationGroupBy = ({ type: "duration"; } & AggregationDurationGrouping) | ({ type: "fixedWidth"; } & AggregationFixedWidthGrouping) | ({ type: "ranges"; } & AggregationRangesGrouping) | ({ type: "exact"; } & AggregationExactGrouping); /** * Specifies a grouping for aggregation results. * * Log Safety: UNSAFE */ declare type AggregationGroupByV2 = ({ type: "duration"; } & AggregationDurationGroupingV2) | ({ type: "fixedWidth"; } & AggregationFixedWidthGroupingV2) | ({ type: "ranges"; } & AggregationRangesGroupingV2) | ({ type: "exact"; } & AggregationExactGroupingV2); /** * The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by adjusting your query to reduce the number of groups created by your aggregation. For instance: If you are using multiple groupBy clauses, try reducing the number of clauses. If you are using a groupBy clause with a high cardinality property, try filtering the data first to reduce the number of groups. * * Log Safety: SAFE */ declare interface AggregationGroupCountExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "AggregationGroupCountExceededLimit"; errorDescription: "The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by adjusting your query to reduce the number of groups created by your aggregation. For instance: If you are using multiple groupBy clauses, try reducing the number of clauses. If you are using a groupBy clause with a high cardinality property, try filtering the data first to reduce the number of groups."; errorInstanceId: string; parameters: { groupsCount: unknown; groupsLimit: unknown; }; } /** * Log Safety: UNSAFE */ declare type AggregationGroupKey = LooselyBrandedString_5<"AggregationGroupKey">; /** * Log Safety: UNSAFE */ declare type AggregationGroupKeyV2 = LooselyBrandedString_5<"AggregationGroupKeyV2">; /** * Log Safety: UNSAFE */ declare type AggregationGroupValue = any; /** * Log Safety: UNSAFE */ declare type AggregationGroupValueV2 = any; /** * The amount of memory used in the request exceeded the limit. This can typically be fixed by adjusting your query to reduce the number of groups created by your aggregation. For instance: If you are using multiple groupBy clauses, try reducing the number of clauses. If you are using a groupBy clause with a high cardinality property, try filtering the data first to reduce the number of groups. * * Log Safety: SAFE */ declare interface AggregationMemoryExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "AggregationMemoryExceededLimit"; errorDescription: "The amount of memory used in the request exceeded the limit. This can typically be fixed by adjusting your query to reduce the number of groups created by your aggregation. For instance: If you are using multiple groupBy clauses, try reducing the number of clauses. If you are using a groupBy clause with a high cardinality property, try filtering the data first to reduce the number of groups."; errorInstanceId: string; parameters: { memoryUsedBytes: unknown; memoryLimitBytes: unknown; }; } /** * A user-specified alias for an aggregation metric name. * * Log Safety: UNSAFE */ declare type AggregationMetricName = LooselyBrandedString_5<"AggregationMetricName">; /** * The requested aggregation metric is not supported by the storage backend. Consider migrating queried object types to Object Storage V2. See https://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration for more details. * * Log Safety: SAFE */ declare interface AggregationMetricNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "AggregationMetricNotSupported"; errorDescription: "The requested aggregation metric is not supported by the storage backend. Consider migrating queried object types to Object Storage V2. See https://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration for more details."; errorInstanceId: string; parameters: { metricType: unknown; }; } /** * Log Safety: UNSAFE */ declare interface AggregationMetricResult { name: string; value?: number; } /** * Log Safety: UNSAFE */ declare interface AggregationMetricResultV2 { name: string; value?: any; } /** * A nested object set within the aggregation exceeded the allowed limit. This can be fixed by aggregating over fewer objects, such as by applying a filter. * * Log Safety: SAFE */ declare interface AggregationNestedObjectSetSizeExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "AggregationNestedObjectSetSizeExceededLimit"; errorDescription: "A nested object set within the aggregation exceeded the allowed limit. This can be fixed by aggregating over fewer objects, such as by applying a filter."; errorInstanceId: string; parameters: { objectsCount: unknown; objectsLimit: unknown; }; } /** * Divides objects into groups based on their object type. This grouping is only useful when aggregating across multiple object types, such as when aggregating over an interface type. * * Log Safety: SAFE */ declare interface AggregationObjectTypeGrouping { } /** * Log Safety: UNSAFE */ declare interface AggregationOrderBy { metricName: string; } /** * Specifies a date range from an inclusive start date to an exclusive end date. * * Log Safety: UNSAFE */ declare interface AggregationRange { lt?: any; lte?: any; gt?: any; gte?: any; } /** * Divides objects into groups according to specified ranges. * * Log Safety: UNSAFE */ declare interface AggregationRangesGrouping { field: FieldNameV1; ranges: Array; } /** * Divides objects into groups according to specified ranges. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface AggregationRangesGroupingV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; ranges: Array; } /** * Specifies a range from an inclusive start value to an exclusive end value. * * Log Safety: UNSAFE */ declare interface AggregationRangeV2 { startValue: any; endValue: any; } /** * Specifies an aggregation function. * * Log Safety: UNSAFE */ declare type AggregationV2 = ({ type: "approximateDistinct"; } & ApproximateDistinctAggregationV2) | ({ type: "min"; } & MinAggregationV2) | ({ type: "avg"; } & AvgAggregationV2) | ({ type: "max"; } & MaxAggregationV2) | ({ type: "approximatePercentile"; } & ApproximatePercentileAggregationV2) | ({ type: "count"; } & CountAggregationV2) | ({ type: "sum"; } & SumAggregationV2) | ({ type: "exactDistinct"; } & ExactDistinctAggregationV2); export declare namespace AipAgents { export { Agent, AgentMarkdownResponse, AgentMetadata, AgentRid, AgentSessionRagContextResponse, AgentsSessionsPage, AgentVersion, AgentVersionDetails, AgentVersionString, BlockingContinueSessionRequest, CancelSessionRequest, CancelSessionResponse, Content, CreateSessionRequest, FailureToolCallOutput, FunctionRetrievedContext, GetRagContextForSessionRequest, InputContext, ListAgentVersionsResponse, ListSessionsResponse, MessageId, ModelPurpose, ObjectContext, ObjectSetParameter, ObjectSetParameterValue, ObjectSetParameterValueUpdate, Parameter, ParameterAccessMode, ParameterId, ParameterType, ParameterValue, ParameterValueUpdate, RidToolInputValue, RidToolOutputValue, Session, SessionExchange, SessionExchangeContexts, SessionExchangeResult, SessionMetadata, SessionRid, SessionTrace, SessionTraceId, SessionTraceStatus, StreamingContinueSessionRequest, StringParameter, StringParameterValue, StringToolInputValue, StringToolOutputValue, SuccessToolCallOutput, ToolCall, ToolCallGroup, ToolCallInput, ToolCallOutput, ToolInputName, ToolInputValue, ToolMetadata, ToolOutputValue, ToolType, UpdateSessionTitleRequest, UserTextInput, ActionTypeNotFound_2 as ActionTypeNotFound, AgentIterationsExceededLimit, AgentNotFound, AgentVersionNotFound, BlockingContinueSessionPermissionDenied, CancelSessionFailedMessageNotInProgress, CancelSessionPermissionDenied, ContentNotFound, ContextSizeExceededLimit, CreateSessionPermissionDenied, DeleteSessionPermissionDenied, FunctionLocatorNotFound, GetAllSessionsAgentsPermissionDenied, GetRagContextForSessionPermissionDenied, InvalidAgentVersion, InvalidParameter, InvalidParameterType, ListSessionsForAgentsPermissionDenied, NoPublishedAgentVersion, ObjectTypeIdsNotFound, ObjectTypeRidsNotFound, OntologyEntitiesNotFound, RateLimitExceeded, RetryAttemptsExceeded, RetryDeadlineExceeded, SessionExecutionFailed, SessionNotFound, SessionTraceIdAlreadyExists, SessionTraceNotFound, StreamingContinueSessionPermissionDenied, UnsupportedLanguageModelRid, UpdateSessionTitlePermissionDenied, Agents, AgentVersions, Contents, Sessions, SessionTraces } } declare namespace _AipAgents { export { LooselyBrandedString_4 as LooselyBrandedString, Agent, AgentMarkdownResponse, AgentMetadata, AgentRid, AgentSessionRagContextResponse, AgentsSessionsPage, AgentVersion, AgentVersionDetails, AgentVersionString, BlockingContinueSessionRequest, CancelSessionRequest, CancelSessionResponse, Content, CreateSessionRequest, FailureToolCallOutput, FunctionRetrievedContext, GetRagContextForSessionRequest, InputContext, ListAgentVersionsResponse, ListSessionsResponse, MessageId, ModelPurpose, ObjectContext, ObjectSetParameter, ObjectSetParameterValue, ObjectSetParameterValueUpdate, Parameter, ParameterAccessMode, ParameterId, ParameterType, ParameterValue, ParameterValueUpdate, RidToolInputValue, RidToolOutputValue, Session, SessionExchange, SessionExchangeContexts, SessionExchangeResult, SessionMetadata, SessionRid, SessionTrace, SessionTraceId, SessionTraceStatus, StreamingContinueSessionRequest, StringParameter, StringParameterValue, StringToolInputValue, StringToolOutputValue, SuccessToolCallOutput, ToolCall, ToolCallGroup, ToolCallInput, ToolCallOutput, ToolInputName, ToolInputValue, ToolMetadata, ToolOutputValue, ToolType, UpdateSessionTitleRequest, UserTextInput } } /** * Matches intervals satisfying all the rules in the query * * Log Safety: UNSAFE */ declare interface AllOfRule { rules: Array; maxGaps?: number; ordered: boolean; } /** * Checks that values in a column are within an allowed set of values. * * Log Safety: UNSAFE */ declare interface AllowedColumnValuesCheckConfig { subject: DatasetSubject; columnName: ColumnName_3; allowedValues: Array; allowNull?: boolean; severity: SeverityLevel; } /** * An empty type representing all users in the system. Useful for expressing operations that should be allowed by what is typically the 'Everyone' group, or for expressing that anyone who satisfies Mandatory security is granted discretionary access. * * Log Safety: SAFE */ declare interface AllPrincipal { } /* Excluded from this release type: allSessions */ /** * Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching. * * Log Safety: UNSAFE */ declare interface AllTermsQuery { field: FieldNameV1; value: string; fuzzy?: Fuzzy; } /** * Returns action types where every query is satisfied. An empty list matches all action types. * * Log Safety: UNSAFE */ declare interface AndActionTypesQueryV2 { value: Array; } /** * Returns objects where every query is satisfied. * * Log Safety: UNSAFE */ declare interface AndQuery { value: Array; } /** * @deprecated Use `AndQueryV2` in the `foundry.ontologies` package * * Returns objects where every query is satisfied. * * Log Safety: UNSAFE */ declare interface AndQueryV2 { value: Array; } /** * Returns objects where every query is satisfied. * * Log Safety: UNSAFE */ declare interface AndQueryV2_2 { value: Array; } /** * Trigger after all of the given triggers emit an event. * * Log Safety: UNSAFE */ declare interface AndTrigger { triggers: Array; } /** * The geometry for an annotation. * * Log Safety: UNSAFE */ declare type AnnotateGeometry = { type: "boundingBox"; } & BoundingBoxGeometry; /** * Annotates an image with bounding boxes, labels, and colors. * * Log Safety: UNSAFE */ declare interface AnnotateImageOperation { annotations: Array; } /** * An annotation to draw on an image. * * Log Safety: UNSAFE */ declare interface Annotation { geometry: AnnotateGeometry; label?: string; color?: Color_2; thickness?: number; fontSize?: number; } export declare namespace Anthropic { export { } } /** * Log Safety: SAFE */ declare interface AnthropicAnyToolChoice { disableParallelToolUse?: AnthropicDisableParallelToolUse; } /** * Log Safety: SAFE */ declare interface AnthropicAutoToolChoice { disableParallelToolUse?: AnthropicDisableParallelToolUse; } /** * Log Safety: UNSAFE */ declare interface AnthropicBase64PdfDocumentSource { data: string; } /** * Log Safety: SAFE */ declare type AnthropicCacheControl = { type: "ephemeral"; } & AnthropicEphemeralCacheControl; /** * Log Safety: UNSAFE */ declare interface AnthropicCharacterLocationCitation { citedText: string; documentIndex: number; documentTitle?: string; startCharIndex: number; endCharIndex: number; } /** * Log Safety: UNSAFE */ declare type AnthropicCompletionCitation = { type: "charLocation"; } & AnthropicCharacterLocationCitation; /** * Log Safety: UNSAFE */ declare type AnthropicCompletionContent = ({ type: "toolUse"; } & AnthropicCompletionToolUse) | ({ type: "text"; } & AnthropicCompletionText) | ({ type: "thinking"; } & AnthropicCompletionThinking) | ({ type: "redactedThinking"; } & AnthropicCompletionRedactedThinking); /** * Log Safety: UNSAFE */ declare interface AnthropicCompletionRedactedThinking { data: string; } /** * Log Safety: UNSAFE */ declare interface AnthropicCompletionText { text: string; citations?: Array; } /** * Log Safety: UNSAFE */ declare interface AnthropicCompletionThinking { signature: string; thinking: string; } /** * Log Safety: UNSAFE */ declare interface AnthropicCompletionToolUse { id: string; input: any; name: string; } /** * Log Safety: UNSAFE */ declare interface AnthropicCustomTool { name: string; description?: string; inputSchema: JsonSchema; } /** * Log Safety: SAFE */ declare interface AnthropicDisabledThinking { } /** * Whether to disable parallel tool use. Defaults to false. If set to true, the model will output exactly one tool use. * * Log Safety: SAFE */ declare type AnthropicDisableParallelToolUse = boolean; /** * Log Safety: UNSAFE */ declare interface AnthropicDocument { source: AnthropicDocumentSource; cacheControl?: AnthropicCacheControl; citations?: AnthropicDocumentCitations; context?: string; title?: string; } /** * Log Safety: SAFE */ declare interface AnthropicDocumentCitations { enabled: boolean; } /** * Log Safety: UNSAFE */ declare type AnthropicDocumentSource = ({ type: "pdf"; } & AnthropicBase64PdfDocumentSource) | ({ type: "text"; } & AnthropicTextDocumentSource); /** * https://docs.anthropic.com/en/docs/build-with-claude/extended-thinking#effort Controls how many tokens Claude uses when responding. Supported by Claude models beginning with Opus 4.5. Setting effort to HIGH produces the same behavior as omitting the parameter entirely. * * Log Safety: SAFE */ declare type AnthropicEffort = "LOW" | "MEDIUM" | "HIGH" | "MAX"; /** * Log Safety: SAFE */ declare interface AnthropicEnabledThinking { budgetTokens: number; } /** * This currently does not support the ttl field, but will in the future. * * Log Safety: SAFE */ declare interface AnthropicEphemeralCacheControl { } /** * Log Safety: UNSAFE */ declare interface AnthropicImage { source: AnthropicImageSource; cacheControl?: AnthropicCacheControl; } /** * Log Safety: UNSAFE */ declare interface AnthropicImageBase64Source { data: string; mediaType: AnthropicMediaType; } /** * Log Safety: UNSAFE */ declare type AnthropicImageSource = { type: "base64"; } & AnthropicImageBase64Source; /** * Log Safety: UNSAFE */ declare interface AnthropicJsonSchemaOutputFormat { schema: JsonSchema; } /** * Log Safety: SAFE */ declare type AnthropicMediaType = "IMAGE_JPEG" | "IMAGE_PNG" | "IMAGE_GIF" | "IMAGE_WEBP"; /** * Log Safety: UNSAFE */ declare interface AnthropicMessage { content: Array; role: AnthropicMessageRole; } /** * Log Safety: UNSAFE */ declare type AnthropicMessageContent = ({ type: "image"; } & AnthropicImage) | ({ type: "toolUse"; } & AnthropicToolUse) | ({ type: "document"; } & AnthropicDocument) | ({ type: "text"; } & AnthropicText) | ({ type: "toolResult"; } & AnthropicToolResult) | ({ type: "thinking"; } & AnthropicThinking) | ({ type: "redactedThinking"; } & AnthropicRedactedThinking); /** * Log Safety: SAFE */ declare type AnthropicMessageRole = "USER" | "ASSISTANT"; /** * Could not messages the AnthropicModel. * * Log Safety: SAFE */ declare interface AnthropicMessagesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "AnthropicMessagesPermissionDenied"; errorDescription: "Could not messages the AnthropicModel."; errorInstanceId: string; parameters: { anthropicModelModelId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface AnthropicMessagesRequest { messages: Array; maxTokens: number; stopSequences?: Array; system?: Array; temperature?: number; thinking?: AnthropicThinkingConfig; toolChoice?: AnthropicToolChoice; tools?: Array; topK?: number; topP?: number; outputConfig?: AnthropicOutputConfig; } /** * Log Safety: UNSAFE */ declare interface AnthropicMessagesResponse { content: Array; id: string; model: string; role: AnthropicMessageRole; stopReason?: string; stopSequence?: string; usage: AnthropicTokenUsage; } /** * Log Safety: SAFE */ declare interface AnthropicModel { modelId: LanguageModelApiName; } /** * Log Safety: SAFE */ declare interface AnthropicNoneToolChoice { } /** * Log Safety: UNSAFE */ declare interface AnthropicOutputConfig { format?: AnthropicOutputFormat; effort?: AnthropicEffort; } /** * Log Safety: UNSAFE */ declare type AnthropicOutputFormat = { type: "jsonSchema"; } & AnthropicJsonSchemaOutputFormat; /** * Log Safety: UNSAFE */ declare interface AnthropicRedactedThinking { data: string; } /** * Log Safety: UNSAFE */ declare type AnthropicSystemMessage = { type: "text"; } & AnthropicText; /** * Log Safety: UNSAFE */ declare interface AnthropicText { text: string; citations?: Array; cacheControl?: AnthropicCacheControl; } /** * Log Safety: UNSAFE */ declare interface AnthropicTextDocumentSource { data: string; } /** * Log Safety: UNSAFE */ declare interface AnthropicThinking { signature: string; thinking: string; } /** * Log Safety: SAFE */ declare type AnthropicThinkingConfig = ({ type: "disabled"; } & AnthropicDisabledThinking) | ({ type: "enabled"; } & AnthropicEnabledThinking); /** * Log Safety: SAFE */ declare interface AnthropicTokenUsage { cacheCreationInputTokens?: number; cacheReadInputTokens?: number; inputTokens: number; outputTokens: number; } /** * Log Safety: UNSAFE */ declare type AnthropicTool = { type: "custom"; } & AnthropicCustomTool; /** * Log Safety: UNSAFE */ declare type AnthropicToolChoice = ({ type: "auto"; } & AnthropicAutoToolChoice) | ({ type: "none"; } & AnthropicNoneToolChoice) | ({ type: "any"; } & AnthropicAnyToolChoice) | ({ type: "tool"; } & AnthropicToolToolChoice); /** * Log Safety: UNSAFE */ declare interface AnthropicToolResult { toolUseId: string; content?: Array; isError?: boolean; cacheControl?: AnthropicCacheControl; } /** * Log Safety: UNSAFE */ declare type AnthropicToolResultContent = { type: "text"; } & AnthropicText; /** * Log Safety: UNSAFE */ declare interface AnthropicToolToolChoice { name: string; disableParallelToolUse?: AnthropicDisableParallelToolUse; } /** * Log Safety: UNSAFE */ declare interface AnthropicToolUse { id: string; input: any; name: string; cacheControl?: AnthropicCacheControl; } /** * Log Safety: UNSAFE */ declare interface AnthropicUrlDocumentSource { url: string; } /** * Log Safety: SAFE */ declare interface AnyColumnType { } /** * Matches intervals satisfying any of the rules in the query * * Log Safety: UNSAFE */ declare interface AnyOfRule { rules: Array; } /** * Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching. * * Log Safety: UNSAFE */ declare interface AnyTermQuery { field: FieldNameV1; value: string; fuzzy?: Fuzzy; } /** * Log Safety: SAFE */ declare interface AnyType { } /** * Log Safety: UNSAFE */ declare interface ApiDefinition { version: IrVersion; rid: ApiDefinitionRid; name: ApiDefinitionName; deprecated: ApiDefinitionDeprecated; ir: Array; } /** * Log Safety: SAFE */ declare type ApiDefinitionDeprecated = boolean; /** * Log Safety: UNSAFE */ declare type ApiDefinitionName = LooselyBrandedString_20<"ApiDefinitionName">; /** * The given ApiDefinition could not be found. * * Log Safety: SAFE */ declare interface ApiDefinitionNotFound { errorCode: "NOT_FOUND"; errorName: "ApiDefinitionNotFound"; errorDescription: "The given ApiDefinition could not be found."; errorInstanceId: string; parameters: { apiDefinitionVersion: unknown; }; } /** * Log Safety: SAFE */ declare type ApiDefinitionRid = LooselyBrandedString_20<"ApiDefinitionRid">; export declare namespace ApiDefinitions { export { } } /** * This feature is only supported in preview mode. Please use preview=true in the query parameters to call this endpoint. * * Log Safety: SAFE */ declare interface ApiFeaturePreviewUsageOnly { errorCode: "INVALID_ARGUMENT"; errorName: "ApiFeaturePreviewUsageOnly"; errorDescription: "This feature is only supported in preview mode. Please use preview=true in the query parameters to call this endpoint."; errorInstanceId: string; parameters: {}; } /** * The API key used to authenticate to the external system. This can be configured as a header or query parameter. * * Log Safety: DO_NOT_LOG */ declare interface ApiKeyAuthentication { location: RestRequestApiKeyLocation; apiKey: EncryptedProperty; } /** * Wrapper for API name-based model locator. * * Log Safety: SAFE */ declare interface ApiNameLocatorWrapper { apiName: string; } /** * You are not allowed to use Palantir APIs. * * Log Safety: SAFE */ declare interface ApiUsageDenied { errorCode: "PERMISSION_DENIED"; errorName: "ApiUsageDenied"; errorDescription: "You are not allowed to use Palantir APIs."; errorInstanceId: string; parameters: { missingScope: unknown; }; } /** * Log Safety: SAFE */ declare type ApiVersion = "v1" | "v2"; /** * Applies an action using the given parameters. * * Changes to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible. * Edits to objects or links in Object Storage V2 will be visible immediately after the action completes. * * Note that a 200 HTTP status code only indicates that the request was received and processed by the server. * See the validation result in the response body to determine if the action was applied successfully. * * Note that [parameter default values](https://www.palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by * this endpoint. * * @public * * Required Scopes: [api:ontologies-read, api:ontologies-write] * URL: /v2/ontologies/{ontology}/actions/{action}/apply */ declare function apply($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, action: _Ontologies_2.ActionTypeApiName, $body: _Ontologies_2.ApplyActionRequestV2, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; transactionId?: _Ontologies_2.OntologyTransactionId | undefined; scenarioRid?: _Ontologies_2.OntologyScenarioRid | undefined; branch?: _Core.FoundryBranch | undefined; }, $headerParams?: { traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies_2.SyncApplyActionResponseV2>; /** * Log Safety: SAFE */ declare interface ApplyActionFailed { errorCode: "INVALID_ARGUMENT"; errorName: "ApplyActionFailed"; errorDescription: ""; errorInstanceId: string; parameters: {}; } /** * If not specified, defaults to VALIDATE_AND_EXECUTE. * * Log Safety: SAFE */ declare type ApplyActionMode = "VALIDATE_ONLY" | "VALIDATE_AND_EXECUTE"; /** * Log Safety: SAFE */ declare interface ApplyActionOverrides { uniqueIdentifierLinkIdValues: Record; actionExecutionTime?: ActionExecutionTime; } /** * Log Safety: UNSAFE */ declare interface ApplyActionRequest { parameters: Record; } /** * Log Safety: SAFE */ declare interface ApplyActionRequestOptions { mode?: ApplyActionMode; returnEdits?: ReturnEditsMode; } /** * Log Safety: UNSAFE */ declare interface ApplyActionRequestV2 { options?: ApplyActionRequestOptions; parameters: Record; } /** * Log Safety: SAFE */ declare interface ApplyActionResponse { } /** * Log Safety: UNSAFE */ declare interface ApplyActionWithOverridesRequest { request: ApplyActionRequestV2; overrides: ApplyActionOverrides; } /* Excluded from this release type: applyAsync */ /** * Applies multiple actions (of the same Action Type) using the given parameters. * * Changes to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible. * Edits to objects or links in Object Storage V2 will be visible immediately after the action completes. * * Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not * call Functions may receive a higher limit. * * Note that [notifications](https://www.palantir.com/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. * * @public * * Required Scopes: [api:ontologies-read, api:ontologies-write] * URL: /v2/ontologies/{ontology}/actions/{action}/applyBatch */ declare function applyBatch($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, action: _Ontologies_2.ActionTypeApiName, $body: _Ontologies_2.BatchApplyActionRequestV2, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.BatchApplyActionResponseV2>; /* Excluded from this release type: applyBatchWithOverrides */ /** * Performs both apply reducers and extract main value to return the reduced main value. * * Log Safety: SAFE */ declare interface ApplyReducersAndExtractMainValueLoadLevel { } /** * Returns a single value of an array as configured in the ontology. * * Log Safety: SAFE */ declare interface ApplyReducersLoadLevel { } /** * An Action rule that merges the edits accumulated on a referenced Scenario into the ontology data context where the Action is applied. If the Action is applied against another Scenario, the edits are merged into that target Scenario. The scenario is supplied through the parameter identified by scenarioParameter, whose value type is scenarioReference. The affected object types and link types are explicitly enumerated in the scope. * * Log Safety: UNSAFE */ declare interface ApplyScenarioLogicRule { scenarioParameter: ParameterId_2; objectTypeApiNames: Array; linkTypes: Array; } /** * An Action rule that applies the edits accumulated on a referenced Scenario onto the ontology data context where the Action is applied. If the Action is applied in the context of main ontology data, the edits are applied there. If the Action is applied in the context of another Scenario, the edits are applied in that other Scenario. The scenario is supplied through the parameter identified by scenarioParameter of type scenarioReference. The affected object types and link types are explicitly enumerated in the scope. * * Log Safety: UNSAFE */ declare interface ApplyScenarioRule { scenarioParameter: ParameterId_2; objectTypeApiNames: Array; linkTypes: Array; } /* Excluded from this release type: applyWithOverrides */ /** * Metadata linking a checkpoint record to an Approvals workflow. * * Log Safety: SAFE */ declare interface ApprovalsMetadata { approvalsTaskId: ApprovalsTaskId; approvalsSubtaskIds: Array; } /** * Identifier of an Approvals subtask tied to the checkpoint. * * Log Safety: SAFE */ declare type ApprovalsSubtaskId = LooselyBrandedString_11<"ApprovalsSubtaskId">; /** * Identifier of an Approvals task tied to the checkpoint. * * Log Safety: SAFE */ declare type ApprovalsTaskId = LooselyBrandedString_11<"ApprovalsTaskId">; /** * Computes an approximate number of distinct values for the provided field. * * Log Safety: UNSAFE */ declare interface ApproximateDistinctAggregation { field: FieldNameV1; name?: AggregationMetricName; } /** * Computes an approximate number of distinct values for the provided field. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface ApproximateDistinctAggregationV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; name?: AggregationMetricName; direction?: OrderByDirection_2; } /** * Computes the approximate percentile value for the provided field. Requires Object Storage V2. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface ApproximatePercentileAggregationV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; name?: AggregationMetricName; approximatePercentile: number; direction?: OrderByDirection_2; } /** * Checks the approximate percentage of unique values in a specific column. * * Log Safety: UNSAFE */ declare interface ApproximateUniquePercentageCheckConfig { subject: DatasetSubject; percentageCheckConfig: PercentageCheckConfig; } /** * The output format for encoding archives. * * Log Safety: UNSAFE */ declare type ArchiveEncodeFormat = { type: "tar"; } & TarFormat; /** * The format of an archive file. * * Log Safety: SAFE */ declare type ArchiveFileFormat = "ZIP"; /** * Log Safety: UNSAFE */ declare interface Arg { name: string; value: string; } /** * Log Safety: UNSAFE */ declare interface ArrayConstraint { minimumSize?: number; maximumSize?: number; uniqueValues: boolean; valueConstraint?: ValueTypeConstraint; } /** * Log Safety: UNSAFE */ declare interface ArrayConstraint_2 { minimumSize?: number; maximumSize?: number; uniqueValues: boolean; valueConstraint?: ValueTypeConstraint_2; } /** * Evaluated constraints for entries of array parameters for which per-entry evaluation is supported. * * Log Safety: UNSAFE */ declare type ArrayEntryEvaluatedConstraint = { type: "struct"; } & StructEvaluatedConstraint; /** * Evaluated constraints of array parameters that support per-entry constraint evaluations. * * Log Safety: UNSAFE */ declare interface ArrayEvaluatedConstraint { entries: Array; } /** * Log Safety: UNSAFE */ declare interface ArrayFieldType { itemsSchema: FieldSchema; } /** * The parameter expects an array of values and the size of the array must fall within the defined range. * * Log Safety: UNSAFE */ declare interface ArraySizeConstraint { lt?: any; lte?: any; gt?: any; gte?: any; } /** * Artifact-backed documents require a namespace upon creation. * * Log Safety: UNSAFE */ declare interface ArtifactDocumentCreationMissingNamespace { errorCode: "INVALID_ARGUMENT"; errorName: "ArtifactDocumentCreationMissingNamespace"; errorDescription: "Artifact-backed documents require a namespace upon creation."; errorInstanceId: string; parameters: { documentTypeName: unknown; providedParent: unknown; }; } /** * The globally unique identifier of an artifact. * * Log Safety: SAFE */ declare type ArtifactGid = LooselyBrandedString<"ArtifactGid">; /** * Log Safety: SAFE */ declare type ArtifactRepositoryRid = LooselyBrandedString_5<"ArtifactRepositoryRid">; export declare namespace ArtifactTables { export { } } /** * Log Safety: DO_NOT_LOG */ declare interface AsPlaintextValue { value: PlaintextValue; } /** * Log Safety: UNSAFE */ declare interface AsSecretName { value: SecretName; } /** * Log Safety: SAFE */ declare type AsyncActionOperation = undefined; /** * Log Safety: SAFE */ declare type AsyncActionStatus = "RUNNING_SUBMISSION_CHECKS" | "EXECUTING_WRITE_BACK_WEBHOOK" | "COMPUTING_ONTOLOGY_EDITS" | "COMPUTING_FUNCTION" | "WRITING_ONTOLOGY_EDITS" | "EXECUTING_SIDE_EFFECT_WEBHOOK" | "SENDING_NOTIFICATIONS"; /** * Log Safety: SAFE */ declare interface AsyncApplyActionOperationResponseV2 { } /** * Log Safety: SAFE */ declare type AsyncApplyActionOperationV2 = undefined; /** * Log Safety: UNSAFE */ declare interface AsyncApplyActionRequest { parameters: Record; } /** * Log Safety: UNSAFE */ declare interface AsyncApplyActionRequestV2 { parameters: Record; } /** * Log Safety: SAFE */ declare interface AsyncApplyActionResponse { } /** * Log Safety: SAFE */ declare interface AsyncApplyActionResponseV2 { operationId: string; } /** * The async query failed because the Ontology snapshot used for consistent reads became stale. Retrying the request typically resolves this. * * Log Safety: UNSAFE */ declare interface AsyncConsistentSnapshotError { errorCode: "CONFLICT"; errorName: "AsyncConsistentSnapshotError"; errorDescription: "The async query failed because the Ontology snapshot used for consistent reads became stale. Retrying the request typically resolves this."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * The function runtime does not support async execution with a transaction. * * Log Safety: UNSAFE */ declare interface AsyncFunctionNotSupportedWithTransaction { errorCode: "INVALID_ARGUMENT"; errorName: "AsyncFunctionNotSupportedWithTransaction"; errorDescription: "The function runtime does not support async execution with a transaction."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; }; } /** * The value of the async query's output is invalid. This may be because the return value did not match the specified output type or constraints. * * Log Safety: UNSAFE */ declare interface AsyncInvalidQueryOutputValue { errorCode: "INVALID_ARGUMENT"; errorName: "AsyncInvalidQueryOutputValue"; errorDescription: "The value of the async query's output is invalid. This may be because the return value did not match the specified output type or constraints."; errorInstanceId: string; parameters: { outputDataType: unknown; outputValue: unknown; functionRid: unknown; functionVersion: unknown; }; } /** * Log Safety: UNSAFE */ declare type AsyncOperation = ({ type: "applyActionAsyncV2"; } & _Ontologies.AsyncApplyActionOperationV2) | ({ type: "applyActionAsync"; } & _Ontologies.AsyncActionOperation); export declare namespace AsyncOperations { export { } } /** * The authored Query failed during async execution because of a user induced error. The message argument is meant to be displayed to the user. * * Log Safety: UNSAFE */ declare interface AsyncQueryEncounteredUserFacingError { errorCode: "CONFLICT"; errorName: "AsyncQueryEncounteredUserFacingError"; errorDescription: "The authored Query failed during async execution because of a user induced error. The message argument is meant to be displayed to the user."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; }; } /** * Memory limits were exceeded during async Query execution. * * Log Safety: UNSAFE */ declare interface AsyncQueryMemoryExceededLimit { errorCode: "TIMEOUT"; errorName: "AsyncQueryMemoryExceededLimit"; errorDescription: "Memory limits were exceeded during async Query execution."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * The authored Query failed to execute because of a runtime error during async execution. * * Log Safety: UNSAFE */ declare interface AsyncQueryRuntimeError { errorCode: "INVALID_ARGUMENT"; errorName: "AsyncQueryRuntimeError"; errorDescription: "The authored Query failed to execute because of a runtime error during async execution."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; stacktrace: unknown; parameters: unknown; }; } /** * Time limits were exceeded during async Query execution. * * Log Safety: UNSAFE */ declare interface AsyncQueryTimeExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "AsyncQueryTimeExceededLimit"; errorDescription: "Time limits were exceeded during async Query execution."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * The representation of an attachment. * * Log Safety: UNSAFE */ declare interface Attachment { rid: AttachmentRid; filename: _Core.Filename; sizeBytes: _Core.SizeBytes; mediaType: _Core.MediaType; } /** * The parameter value (an attachment rid) must reference an attachment within the configured size limit. * * Log Safety: SAFE */ declare interface AttachmentAllowedValues { maxSizeBytes?: _Core.SizeBytes; } /** * The attachment metadata response * * Log Safety: UNSAFE */ declare type AttachmentMetadataResponse = ({ type: "single"; } & AttachmentV2) | ({ type: "multiple"; } & ListAttachmentsResponseV2); /** * The requested attachment is not found, or the client token does not have access to it. Attachments that are not attached to any objects are deleted after two weeks. Attachments that have not been attached to an object can only be viewed by the user who uploaded them. Attachments that have been attached to an object can be viewed by users who can view the object. * * Log Safety: SAFE */ declare interface AttachmentNotFound { errorCode: "NOT_FOUND"; errorName: "AttachmentNotFound"; errorDescription: "The requested attachment is not found, or the client token does not have access to it. Attachments that are not attached to any objects are deleted after two weeks. Attachments that have not been attached to an object can only be viewed by the user who uploaded them. Attachments that have been attached to an object can be viewed by users who can view the object."; errorInstanceId: string; parameters: { attachmentRid: unknown; }; } export declare namespace AttachmentPropertiesV2 { export { getAttachment, getAttachmentByRid, readAttachment, readAttachmentByRid } } /** * The representation of an attachment as a data type. * * Log Safety: SAFE */ declare interface AttachmentProperty { rid: AttachmentRid; } /** * Log Safety: UNSAFE */ declare type AttachmentPropertyV2 = LooselyBrandedString_5<"AttachmentPropertyV2">; /** * The unique resource identifier of an attachment. * * Log Safety: SAFE */ declare type AttachmentRid = LooselyBrandedString_5<"AttachmentRid">; /** * The provided attachment RID already exists and cannot be overwritten. * * Log Safety: SAFE */ declare interface AttachmentRidAlreadyExists { errorCode: "NOT_FOUND"; errorName: "AttachmentRidAlreadyExists"; errorDescription: "The provided attachment RID already exists and cannot be overwritten."; errorInstanceId: string; parameters: { attachmentRid: unknown; }; } export declare namespace Attachments { export { upload_2 as upload, read, get_27 as get } } /** * The file is too large to be uploaded as an attachment. The maximum attachment size is 200MB. * * Log Safety: UNSAFE */ declare interface AttachmentSizeExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "AttachmentSizeExceededLimit"; errorDescription: "The file is too large to be uploaded as an attachment. The maximum attachment size is 200MB."; errorInstanceId: string; parameters: { fileSizeBytes: unknown; fileLimitBytes: unknown; }; } /** * Log Safety: SAFE */ declare interface AttachmentType { } /** * The representation of an attachment. * * Log Safety: UNSAFE */ declare interface AttachmentV2 { rid: AttachmentRid; filename: _Core.Filename; sizeBytes: _Core.SizeBytes; mediaType: _Core.MediaType; } /** * Log Safety: UNSAFE */ declare type AttributeName = LooselyBrandedString_3<"AttributeName">; /** * One or more attributes are not editable. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are not editable. * * Log Safety: UNSAFE */ declare interface AttributesNotEditable { errorCode: "INVALID_ARGUMENT"; errorName: "AttributesNotEditable"; errorDescription: "One or more attributes are not editable. Attributes prefixed with \"multipass:\" are reserved for internal use by Foundry and are not editable."; errorInstanceId: string; parameters: { attributeNames: unknown; }; } /** * Log Safety: UNSAFE */ declare type AttributeValue = LooselyBrandedString_3<"AttributeValue">; /** * Log Safety: UNSAFE */ declare type AttributeValues = Array; /** * Attribution for a request * * Log Safety: UNSAFE */ declare type Attribution = LooselyBrandedString<"Attribution">; /** * The audio channel layout configuration. * * Log Safety: UNSAFE */ declare type AudioChannelLayout = { type: "numberOfChannels"; } & NumberOfChannels; /** * Selects a specific channel from multi-channel audio. * * Log Safety: UNSAFE */ declare interface AudioChannelOperation { encodeFormat: AudioEncodeFormat; channel: number; } /** * Chunks audio into smaller segments of the specified duration. * * Log Safety: UNSAFE */ declare interface AudioChunkOperation { chunkDurationMilliseconds: number; encodeFormat: AudioEncodeFormat; chunkIndex: number; } /** * The format of an audio media item. * * Log Safety: SAFE */ declare type AudioDecodeFormat = "FLAC" | "MP2" | "MP3" | "MP4" | "NIST_SPHERE" | "OGG" | "WAV" | "WEBM"; /** * The output format for encoding audio. * * Log Safety: UNSAFE */ declare type AudioEncodeFormat = ({ type: "mp3"; } & Mp3Format) | ({ type: "wav"; } & WavEncodeFormat) | ({ type: "ts"; } & TsAudioContainerFormat); /** * Metadata for audio media items. * * Log Safety: SAFE */ declare interface AudioMediaItemMetadata { format: AudioDecodeFormat; specification: AudioSpecification; sizeBytes: number; } /** * The operation to perform on audio. * * Log Safety: UNSAFE */ declare type AudioOperation = ({ type: "channel"; } & AudioChannelOperation) | ({ type: "chunk"; } & AudioChunkOperation) | ({ type: "convert"; } & ConvertAudioOperation); /** * Technical specifications for audio media items. * * Log Safety: SAFE */ declare interface AudioSpecification { bitRate: number; durationSeconds: number; numberOfChannels?: number; } /** * The operation to perform for audio to text conversion. * * Log Safety: UNSAFE */ declare type AudioToTextOperation = ({ type: "transcribe"; } & TranscribeOperation) | ({ type: "waveform"; } & WaveformOperation); /** * Converts audio to text. * * Log Safety: UNSAFE */ declare interface AudioToTextTransformation { operation: AudioToTextOperation; } /** * Transforms audio media items. * * Log Safety: UNSAFE */ declare interface AudioTransformation { operation: AudioOperation; } export declare namespace Audit { export { FileId, ListLogFilesResponse, LogFile, Organization_3 as Organization, GetLogFileContentPermissionDenied, ListLogFilesPermissionDenied, MissingStartDate, LogFiles } } declare namespace _Audit { export { LooselyBrandedString_10 as LooselyBrandedString, FileId, ListLogFilesResponse, LogFile, Organization_3 as Organization } } /** * Log Safety: UNSAFE */ declare type AuthenticationProtocol = ({ type: "saml"; } & SamlAuthenticationProtocol) | ({ type: "oidc"; } & OidcAuthenticationProtocol); /** * Log Safety: UNSAFE */ declare interface AuthenticationProvider { rid: AuthenticationProviderRid; name: AuthenticationProviderName; realm: _Core.Realm; enabled: AuthenticationProviderEnabled; supportedHosts: Array; supportedUsernamePatterns: Array; protocol: AuthenticationProtocol; } /** * Whether users can log in using this provider. * * Log Safety: SAFE */ declare type AuthenticationProviderEnabled = boolean; /** * Log Safety: UNSAFE */ declare type AuthenticationProviderName = LooselyBrandedString_3<"AuthenticationProviderName">; /** * The given AuthenticationProvider could not be found. * * Log Safety: SAFE */ declare interface AuthenticationProviderNotFound { errorCode: "NOT_FOUND"; errorName: "AuthenticationProviderNotFound"; errorDescription: "The given AuthenticationProvider could not be found."; errorInstanceId: string; parameters: { enrollmentRid: unknown; authenticationProviderRid: unknown; }; } /** * Log Safety: SAFE */ declare type AuthenticationProviderRid = LooselyBrandedString_3<"AuthenticationProviderRid">; export declare namespace AuthenticationProviders { export { } } /** * Available embedding models that can be used with the service. * * Log Safety: SAFE */ declare type AvailableEmbeddingModelIds = "GOOGLE_SIGLIP_2"; /** * Computes the average value for the provided field. * * Log Safety: UNSAFE */ declare interface AvgAggregation { field: FieldNameV1; name?: AggregationMetricName; } /** * Computes the average value for the provided field. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface AvgAggregationV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; name?: AggregationMetricName; direction?: OrderByDirection_2; } /** * Access keys are long-term credentials for an IAM user or the AWS account root user. Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). You must use both the access key ID and secret access key together to authenticate your requests. * * Log Safety: DO_NOT_LOG */ declare interface AwsAccessKey { accessKeyId: string; secretAccessKey: EncryptedProperty; } /** * OpenID Connect (OIDC) is an open authentication protocol that allows you to authenticate to external system resources without the use of static credentials. * * Log Safety: UNSAFE */ declare interface AwsOidcAuthentication { audience: string; issuerUrl: string; subject: ConnectionRid; } /** * Information about a band in an image. * * Log Safety: UNSAFE */ declare interface BandInfo { dataType?: DataType; colorInterpretation?: ColorInterpretation; paletteInterpretation?: PaletteInterpretation; unitInterpretation?: UnitInterpretation; } /** * Log Safety: DO_NOT_LOG */ declare interface BasicCredentials { username: string; password: EncryptedProperty; } /** * Log Safety: UNSAFE */ declare type BatchActionObjectEdit = ({ type: "modifyObject"; } & ModifyObject) | ({ type: "addObject"; } & AddObject) | ({ type: "addLink"; } & AddLink); /** * Log Safety: UNSAFE */ declare interface BatchActionObjectEdits { edits: Array; addedObjectCount: number; modifiedObjectsCount: number; deletedObjectsCount: number; addedLinksCount: number; deletedLinksCount: number; } /** * Log Safety: UNSAFE */ declare type BatchActionResults = ({ type: "edits"; } & BatchActionObjectEdits) | ({ type: "largeScaleEdits"; } & ObjectTypeEdits); /** * Log Safety: UNSAFE */ declare interface BatchApplyActionRequest { requests: Array; } /** * Log Safety: UNSAFE */ declare interface BatchApplyActionRequestItem { parameters: Record; } /** * Log Safety: UNSAFE */ declare interface BatchApplyActionRequestItemWithOverrides { parameters: Record; overrides?: ApplyActionOverrides; } /** * Log Safety: SAFE */ declare interface BatchApplyActionRequestOptions { returnEdits?: BatchReturnEditsMode; } /** * Log Safety: UNSAFE */ declare interface BatchApplyActionRequestV2 { options?: BatchApplyActionRequestOptions; requests: Array; } /** * Log Safety: SAFE */ declare interface BatchApplyActionResponse { } /** * Log Safety: UNSAFE */ declare interface BatchApplyActionResponseV2 { edits?: BatchActionResults; } /** * Log Safety: UNSAFE */ declare interface BatchApplyActionWithOverridesRequest { options?: BatchApplyActionRequestOptions; requests: Array; } /** * Log Safety: UNSAFE */ declare interface BatchedFunctionLogicRule { objectSetRidInputName: FunctionParameterName; functionRule: FunctionLogicRule; } /** * The submitted batch request was too large. * * Log Safety: SAFE */ declare interface BatchRequestSizeExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "BatchRequestSizeExceededLimit"; errorDescription: "The submitted batch request was too large."; errorInstanceId: string; parameters: { maximumBatchSize: unknown; providedBatchSize: unknown; }; } /** * If not specified, defaults to NONE. * * Log Safety: SAFE */ declare type BatchReturnEditsMode = "ALL" | "NONE"; /** * All writes must be part of a transaction. Transactions are branch-scoped and created by calling create transaction. Writes are not visible until commit transaction is called. * * Log Safety: SAFE */ declare interface BatchTransactionsTransactionPolicy { } /** * A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections. The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. * * Log Safety: UNSAFE */ declare type BBox = Array; /** * The bearer token used to authenticate to the external system. * * Log Safety: DO_NOT_LOG */ declare interface BearerToken { bearerToken: EncryptedProperty; } /** * Pointer to the table in BigQuery. Uses the BigQuery table identifier of project, dataset and table. * * Log Safety: UNSAFE */ declare interface BigQueryVirtualTableConfig { project: string; dataset: string; table: string; } /** * Log Safety: SAFE */ declare interface BinaryType_2 { } /* Excluded from this release type: blockingContinue */ /** * Could not blockingContinue the Session. * * Log Safety: SAFE */ declare interface BlockingContinueSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "BlockingContinueSessionPermissionDenied"; errorDescription: "Could not blockingContinue the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface BlockingContinueSessionRequest { userInput: UserTextInput; parameterInputs: Record; contextsOverride?: Array; sessionTraceId?: SessionTraceId; } /** * Log Safety: UNSAFE */ declare interface BlueprintIcon { color: string; name: string; } /** * A boolean column value. * * Log Safety: UNSAFE */ declare interface BooleanColumnValue { value: boolean; } /** * A boolean parameter value. * * Log Safety: UNSAFE */ declare interface BooleanParameter { value: boolean; } /** * Log Safety: SAFE */ declare interface BooleanType { } /** * Log Safety: SAFE */ declare interface BooleanType_2 { } /** * Log Safety: UNSAFE */ declare interface BooleanValue { value: boolean; } /** * A rectangular bounding box for annotations. * * Log Safety: SAFE */ declare interface BoundingBox { left: number; top: number; width: number; height: number; } /** * A rectangular bounding box geometry for annotations. * * Log Safety: SAFE */ declare interface BoundingBoxGeometry { boundingBox: BoundingBox; } /** * @deprecated Use `BoundingBoxValue` in the `foundry.ontologies` package * * The top left and bottom right coordinate points that make up the bounding box. * * Log Safety: UNSAFE */ declare interface BoundingBoxValue { topLeft: WithinBoundingBoxPoint; bottomRight: WithinBoundingBoxPoint; } /** * The top left and bottom right coordinate points that make up the bounding box. * * Log Safety: UNSAFE */ declare interface BoundingBoxValue_2 { topLeft: WithinBoundingBoxPoint_2; bottomRight: WithinBoundingBoxPoint_2; } /** * Log Safety: UNSAFE */ declare interface Branch { name: _Core.BranchName; transactionRid?: TransactionRid; } /** * The branch cannot be created because a branch with that name already exists. * * Log Safety: UNSAFE */ declare interface BranchAlreadyExists { errorCode: "CONFLICT"; errorName: "BranchAlreadyExists"; errorDescription: "The branch cannot be created because a branch with that name already exists."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; }; } export declare namespace Branches { export { create_9 as create, deleteBranch, list_18 as list, get_20 as get } } /** * Metadata about a Foundry branch. * * Log Safety: SAFE */ declare interface BranchMetadata { rid: FoundryBranch; } /** * The name of a Branch. * * Log Safety: UNSAFE */ declare type BranchName = LooselyBrandedString<"BranchName">; /** * The name of a Branch. * * Log Safety: UNSAFE */ declare type BranchName_2 = LooselyBrandedString_6<"BranchName">; /** * The name of a Branch. * * Log Safety: UNSAFE */ declare type BranchName_3 = LooselyBrandedString_8<"BranchName">; /** * A name for a media set branch. Valid branch names must be (a) non-empty, (b) less than 256 characters, and (c) not a valid ResourceIdentifier. * * Log Safety: UNSAFE */ declare type BranchName_4 = LooselyBrandedString_14<"BranchName">; /** * The requested branch could not be found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface BranchNotFound { errorCode: "NOT_FOUND"; errorName: "BranchNotFound"; errorDescription: "The requested branch could not be found, or the client token does not have access to it."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; }; } /** * The branch parameter is not supported when executing queries with marketplace bindings. * * Log Safety: SAFE */ declare interface BranchNotSupportedWithMarketplaceQuery { errorCode: "INVALID_ARGUMENT"; errorName: "BranchNotSupportedWithMarketplaceQuery"; errorDescription: "The branch parameter is not supported when executing queries with marketplace bindings."; errorInstanceId: string; parameters: {}; } /** * A resource identifier that identifies a branch of a media set. * * Log Safety: SAFE */ declare type BranchRid = LooselyBrandedString_14<"BranchRid">; /** * Log Safety: UNSAFE */ declare interface Build { rid: _Core.BuildRid; branchName: _Core.BranchName; createdTime: _Core.CreatedTime; createdBy: _Core.CreatedBy; fallbackBranches: FallbackBranches; jobRids: Array<_Core.JobRid>; retryCount: RetryCount; retryBackoffDuration: RetryBackoffDuration; abortOnFailure: AbortOnFailure; status: BuildStatus; finishedTime?: string; scheduleRid?: _Core.ScheduleRid; } /* Excluded from this release type: build */ /** * The Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set RID or Restricted View RID. * * Log Safety: SAFE */ declare type BuildableRid = LooselyBrandedString_16<"BuildableRid">; /** * Checks the total time a build takes to complete. * * Log Safety: UNSAFE */ declare interface BuildDurationCheckConfig { subject: DatasetSubject; timeCheckConfig: TimeCheckConfig; } /** * The given build inputs could be found. * * Log Safety: SAFE */ declare interface BuildInputsNotFound { errorCode: "NOT_FOUND"; errorName: "BuildInputsNotFound"; errorDescription: "The given build inputs could be found."; errorInstanceId: string; parameters: { resourceRids: unknown; }; } /** * The provided token does not have permission to use the given resources as inputs to the build. * * Log Safety: SAFE */ declare interface BuildInputsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "BuildInputsPermissionDenied"; errorDescription: "The provided token does not have permission to use the given resources as inputs to the build."; errorInstanceId: string; parameters: { resourceRids: unknown; }; } /** * The given Build could not be found. * * Log Safety: SAFE */ declare interface BuildNotFound { errorCode: "NOT_FOUND"; errorName: "BuildNotFound"; errorDescription: "The given Build could not be found."; errorInstanceId: string; parameters: { buildRid: unknown; }; } /** * The build is not currently running. * * Log Safety: SAFE */ declare interface BuildNotRunning { errorCode: "INVALID_ARGUMENT"; errorName: "BuildNotRunning"; errorDescription: "The build is not currently running."; errorInstanceId: string; parameters: { buildRid: unknown; }; } /** * The RID of a Build. * * Log Safety: SAFE */ declare type BuildRid = LooselyBrandedString<"BuildRid">; export declare namespace Builds { export { get_48 as get, getBatch_8 as getBatch, create_19 as create, cancel_3 as cancel, jobs_2 as jobs } } /** * The status of the build. * * Log Safety: SAFE */ declare type BuildStatus = "RUNNING" | "SUCCEEDED" | "FAILED" | "CANCELED"; /** * Checks the status of the most recent build of the dataset. * * Log Safety: UNSAFE */ declare interface BuildStatusCheckConfig { subject: DatasetSubject; statusCheckConfig: StatusCheckConfig; } /** * The targets of the build. * * Log Safety: SAFE */ declare type BuildTarget = ({ type: "upstream"; } & UpstreamTarget) | ({ type: "manual"; } & ManualTarget) | ({ type: "connecting"; } & ConnectingTarget); /** * The action targets are missing job specs. * * Log Safety: SAFE */ declare interface BuildTargetsMissingJobSpecs { errorCode: "INVALID_ARGUMENT"; errorName: "BuildTargetsMissingJobSpecs"; errorDescription: "The action targets are missing job specs."; errorInstanceId: string; parameters: { resourceRids: unknown; }; } /** * The given build targets could not be found. * * Log Safety: SAFE */ declare interface BuildTargetsNotFound { errorCode: "NOT_FOUND"; errorName: "BuildTargetsNotFound"; errorDescription: "The given build targets could not be found."; errorInstanceId: string; parameters: { resourceRids: unknown; }; } /** * The provided token does not have permission to build the given resources. * * Log Safety: SAFE */ declare interface BuildTargetsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "BuildTargetsPermissionDenied"; errorDescription: "The provided token does not have permission to build the given resources."; errorInstanceId: string; parameters: { resourceRids: unknown; }; } /** * Unable to resolve the given target to a set of targets to build. * * Log Safety: SAFE */ declare interface BuildTargetsResolutionError { errorCode: "INVALID_ARGUMENT"; errorName: "BuildTargetsResolutionError"; errorDescription: "Unable to resolve the given target to a set of targets to build."; errorInstanceId: string; parameters: {}; } /** * The build targets are up to date and no Build was created. To rebuild the targets regardless, use the force build option when creating the Build. * * Log Safety: SAFE */ declare interface BuildTargetsUpToDate { errorCode: "INVALID_ARGUMENT"; errorName: "BuildTargetsUpToDate"; errorDescription: "The build targets are up to date and no Build was created. To rebuild the targets regardless, use the force build option when creating the Build."; errorInstanceId: string; parameters: {}; } /** * Could not build the Transaction. * * Log Safety: SAFE */ declare interface BuildTransactionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "BuildTransactionPermissionDenied"; errorDescription: "Could not build the Transaction."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; }; } /** * Log Safety: SAFE */ declare interface ByteType { } /** * The format of a CAD media item. * * Log Safety: SAFE */ declare type CadDecodeFormat = "STEP"; /** * Metadata for CAD media items. * * Log Safety: UNSAFE */ declare interface CadMediaItemMetadata { format: CadDecodeFormat; sizeBytes: number; units?: CadUnits; } /** * Units declared in a CAD file. * * Log Safety: UNSAFE */ declare interface CadUnits { lengthUnit?: string; } /* Excluded from this release type: calculate */ /* Excluded from this release type: cancel */ /* Excluded from this release type: cancel_2 */ /** * Request a cancellation for all unfinished jobs in a build. The build's status will not update immediately. This endpoint is asynchronous and a success response indicates that the cancellation request has been acknowledged and the build is expected to be canceled soon. If the build has already finished or finishes shortly after the request and before the cancellation, the build will not change. * * @public * * Required Scopes: [api:orchestration-write] * URL: /v2/orchestration/builds/{buildRid}/cancel */ declare function cancel_3($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [buildRid: _Core.BuildRid]): Promise; /** * Cancels a query. If the query is no longer running this is effectively a no-op. * * @public * * Required Scopes: [api:sql-queries-execute] * URL: /v2/sqlQueries/{sqlQueryId}/cancel */ declare function cancel_4($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [sqlQueryId: _SqlQueries.SqlQueryId]): Promise; /** * Could not cancel the Build. * * Log Safety: SAFE */ declare interface CancelBuildPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CancelBuildPermissionDenied"; errorDescription: "Could not cancel the Build."; errorInstanceId: string; parameters: { buildRid: unknown; }; } /** * Log Safety: SAFE */ declare interface CanceledQueryStatus { } /** * The function runtime does not support cancelling executions. * * Log Safety: UNSAFE */ declare interface CancelExecutionNotSupported { errorCode: "FAILED_PRECONDITION"; errorName: "CancelExecutionNotSupported"; errorDescription: "The function runtime does not support cancelling executions."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * Could not cancel the Execution. * * Log Safety: SAFE */ declare interface CancelExecutionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CancelExecutionPermissionDenied"; errorDescription: "Could not cancel the Execution."; errorInstanceId: string; parameters: { executionId: unknown; }; } /** * Log Safety: SAFE */ declare interface CancelExecutionResponse { id: ExecutionId; } /** * Unable to cancel the requested session exchange as no in-progress exchange was found for the provided message identifier. This is expected if no exchange was initiated with the provided message identifier through a streamingContinue request, or if the exchange for this identifier has already completed and cannot be canceled, or if the exchange has already been canceled. This error can also occur if the cancellation was requested immediately after requesting the exchange through a streamingContinue request, and the exchange has not started yet. Clients should handle these errors gracefully, and can reload the session content to get the latest conversation state. * * Log Safety: SAFE */ declare interface CancelSessionFailedMessageNotInProgress { errorCode: "INVALID_ARGUMENT"; errorName: "CancelSessionFailedMessageNotInProgress"; errorDescription: "Unable to cancel the requested session exchange as no in-progress exchange was found for the provided message identifier. This is expected if no exchange was initiated with the provided message identifier through a streamingContinue request, or if the exchange for this identifier has already completed and cannot be canceled, or if the exchange has already been canceled. This error can also occur if the cancellation was requested immediately after requesting the exchange through a streamingContinue request, and the exchange has not started yet. Clients should handle these errors gracefully, and can reload the session content to get the latest conversation state."; errorInstanceId: string; parameters: { messageId: unknown; agentRid: unknown; sessionRid: unknown; }; } /** * Could not cancel the Session. * * Log Safety: SAFE */ declare interface CancelSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CancelSessionPermissionDenied"; errorDescription: "Could not cancel the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CancelSessionRequest { messageId: MessageId; response?: AgentMarkdownResponse; } /** * Log Safety: UNSAFE */ declare interface CancelSessionResponse { result?: SessionExchangeResult; } /** * Could not cancel the SqlQuery. * * Log Safety: SAFE */ declare interface CancelSqlQueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CancelSqlQueryPermissionDenied"; errorDescription: "Could not cancel the SqlQuery."; errorInstanceId: string; parameters: {}; } /** * Cannot create a streaming dataset in a user folder. * * Log Safety: SAFE */ declare interface CannotCreateStreamingDatasetInUserFolder { errorCode: "INVALID_ARGUMENT"; errorName: "CannotCreateStreamingDatasetInUserFolder"; errorDescription: "Cannot create a streaming dataset in a user folder."; errorInstanceId: string; parameters: { parentFolderRid: unknown; }; } /** * Autosaved documents cannot be deleted. * * Log Safety: SAFE */ declare interface CannotDeleteAutosavedDocument { errorCode: "INVALID_ARGUMENT"; errorName: "CannotDeleteAutosavedDocument"; errorDescription: "Autosaved documents cannot be deleted."; errorInstanceId: string; parameters: { documentId: unknown; }; } /** * The given website version is deployed. You must un-deploy it before deleting it. * * Log Safety: UNSAFE */ declare interface CannotDeleteDeployedVersion { errorCode: "INVALID_ARGUMENT"; errorName: "CannotDeleteDeployedVersion"; errorDescription: "The given website version is deployed. You must un-deploy it before deleting it."; errorInstanceId: string; parameters: { version: unknown; }; } /** * Hidden documents cannot be deleted. * * Log Safety: SAFE */ declare interface CannotDeleteHiddenDocument { errorCode: "INVALID_ARGUMENT"; errorName: "CannotDeleteHiddenDocument"; errorDescription: "Hidden documents cannot be deleted."; errorInstanceId: string; parameters: { documentId: unknown; }; } /** * Provider information for Principals in this Realm cannot be replaced. * * Log Safety: SAFE */ declare interface CannotReplaceProviderInfoForPrincipalInProtectedRealm { errorCode: "INVALID_ARGUMENT"; errorName: "CannotReplaceProviderInfoForPrincipalInProtectedRealm"; errorDescription: "Provider information for Principals in this Realm cannot be replaced."; errorInstanceId: string; parameters: { principalId: unknown; realm: unknown; }; } /** * Cannot write to a stream that is in the trash. * * Log Safety: SAFE */ declare interface CannotWriteToTrashedStream { errorCode: "INVALID_ARGUMENT"; errorName: "CannotWriteToTrashedStream"; errorDescription: "Cannot write to a stream that is in the trash."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CbacBanner { classificationString: CbacBannerClassificationString; markings: Array<_Core.MarkingId>; textColor: _Core.Color; backgroundColors: Array<_Core.Color>; } /** * Log Safety: UNSAFE */ declare type CbacBannerClassificationString = LooselyBrandedString_3<"CbacBannerClassificationString">; /** * The given CbacBanner could not be found. * * Log Safety: SAFE */ declare interface CbacBannerNotFound { errorCode: "NOT_FOUND"; errorName: "CbacBannerNotFound"; errorDescription: "The given CbacBanner could not be found."; errorInstanceId: string; parameters: {}; } export declare namespace CbacBanners { export { } } /** * Log Safety: UNSAFE */ declare interface CbacMarkingRestrictions { disallowedMarkings: Array<_Core.MarkingId>; impliedMarkings: Array<_Core.MarkingId>; requiredMarkings: Array>; userSatisfiesMarkings: CbacMarkingRestrictionsUserSatisfiesMarkings; isValid: CbacMarkingRestrictionsIsValid; } /** * True if the provided markings constitute a valid classification, containing no disallowed markings and satisfying all required marking constraints. * * Log Safety: SAFE */ declare type CbacMarkingRestrictionsIsValid = boolean; /** * The given CbacMarkingRestrictions could not be found. * * Log Safety: SAFE */ declare interface CbacMarkingRestrictionsNotFound { errorCode: "NOT_FOUND"; errorName: "CbacMarkingRestrictionsNotFound"; errorDescription: "The given CbacMarkingRestrictions could not be found."; errorInstanceId: string; parameters: {}; } export declare namespace CbacMarkingRestrictionsObjects { export { } } /** * True if the current user satisfies the provided markings. The user must be a member of all conjunctive markings. The provided disjunctive markings are grouped by category, and the user must be a member of at least one marking in each group. * * Log Safety: SAFE */ declare type CbacMarkingRestrictionsUserSatisfiesMarkings = boolean; /** * CBAC is not available. * * Log Safety: SAFE */ declare interface CbacUnavailable { errorCode: "INVALID_ARGUMENT"; errorName: "CbacUnavailable"; errorDescription: "CBAC is not available."; errorInstanceId: string; parameters: {}; } /** * @deprecated Use `CenterPoint` in the `foundry.ontologies` package * * The coordinate point to use as the center of the distance query. * * Log Safety: UNSAFE */ declare interface CenterPoint { center: CenterPointTypes; distance: Distance; } /** * The coordinate point to use as the center of the distance query. * * Log Safety: UNSAFE */ declare interface CenterPoint_2 { center: CenterPointTypes_2; distance: _Core.Distance; } /** * @deprecated Use `CenterPointTypes` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare type CenterPointTypes = { type: "Point"; } & _Geo.GeoPoint; /** * Log Safety: UNSAFE */ declare type CenterPointTypes_2 = { type: "Point"; } & _Geo.GeoPoint; /** * Log Safety: UNSAFE */ declare interface CertificateInfo { pemCertificate: string; commonName?: string; expiryDate: string; usageType: CertificateUsageType; } /** * Log Safety: SAFE */ declare type CertificateUsageType = "ENCRYPTION" | "SIGNING" | "UNSPECIFIED"; /** * Configuration for utilizing the stream as a change data capture (CDC) dataset. To configure CDC on a stream, at least one key needs to be provided. For more information on CDC in Foundry, see the Change Data Capture user documentation. * * Log Safety: UNSAFE */ declare type ChangeDataCaptureConfiguration = { type: "fullRow"; } & FullRowChangeDataCaptureConfiguration; /** * The provided changelog exceeds the maximum allowed length. * * Log Safety: SAFE */ declare interface ChangelogTooLongError { maxLength: number; actualLength: number; } /** * Standard chat-based LLM specification with system and user prompts. * * Log Safety: UNSAFE */ declare interface ChatLlmSpec { modelLocator: LanguageModelLocator; systemPrompt: string; userPrompt: string; maxTokens?: number; } /** * Wrapper for chat-based LLM specification. * * Log Safety: UNSAFE */ declare interface ChatLlmSpecWrapper { chat: ChatLlmSpec; } /** * Log Safety: UNSAFE */ declare interface Check { rid: _Core.CheckRid; groups: Array; config: CheckConfig; intent?: CheckIntent; createdBy?: _Core.CreatedBy; updatedTime?: _Core.UpdatedTime; } /** * A check of the given type for the given subject(s) already exists. The conflicting check will be returned if the provided token has permission to view it. * * Log Safety: UNSAFE */ declare interface CheckAlreadyExists { errorCode: "CONFLICT"; errorName: "CheckAlreadyExists"; errorDescription: "A check of the given type for the given subject(s) already exists. The conflicting check will be returned if the provided token has permission to view it."; errorInstanceId: string; parameters: { conflictingCheck: unknown; }; } /** * Configuration of a check. * * Log Safety: UNSAFE */ declare type CheckConfig = ({ type: "numericColumnRange"; } & NumericColumnRangeCheckConfig) | ({ type: "jobStatus"; } & JobStatusCheckConfig) | ({ type: "numericColumnMean"; } & NumericColumnMeanCheckConfig) | ({ type: "dateColumnRange"; } & DateColumnRangeCheckConfig) | ({ type: "jobDuration"; } & JobDurationCheckConfig) | ({ type: "approximateUniquePercentage"; } & ApproximateUniquePercentageCheckConfig) | ({ type: "buildStatus"; } & BuildStatusCheckConfig) | ({ type: "columnType"; } & ColumnTypeCheckConfig) | ({ type: "allowedColumnValues"; } & AllowedColumnValuesCheckConfig) | ({ type: "timeSinceLastUpdated"; } & TimeSinceLastUpdatedCheckConfig) | ({ type: "scheduleStatus"; } & ScheduleStatusCheckConfig) | ({ type: "nullPercentage"; } & NullPercentageCheckConfig) | ({ type: "scheduleDuration"; } & ScheduleDurationCheckConfig) | ({ type: "totalColumnCount"; } & TotalColumnCountCheckConfig) | ({ type: "numericColumnMedian"; } & NumericColumnMedianCheckConfig) | ({ type: "buildDuration"; } & BuildDurationCheckConfig) | ({ type: "schemaComparison"; } & SchemaComparisonCheckConfig) | ({ type: "primaryKey"; } & PrimaryKeyCheckConfig); /** * The unique resource identifier (RID) of a CheckGroup. * * Log Safety: SAFE */ declare type CheckGroupRid = LooselyBrandedString_8<"CheckGroupRid">; /** * A note about why the Check was set up. * * Log Safety: UNSAFE */ declare type CheckIntent = LooselyBrandedString_8<"CheckIntent">; /** * The given Check could not be found. * * Log Safety: SAFE */ declare interface CheckNotFound { errorCode: "NOT_FOUND"; errorName: "CheckNotFound"; errorDescription: "The given Check could not be found."; errorInstanceId: string; parameters: { checkRid: unknown; }; } /** * An ontology action type that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedActionType { actionTypeRid: string; ontology: CheckpointedOntology; } /** * Action type identifier for a checkpointed action type. * * Log Safety: SAFE */ declare interface CheckpointedActionTypeRid { rid: string; } /** * A group that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedGroup { groupId: string; } /** * Group identifier for a checkpointed group. * * Log Safety: SAFE */ declare interface CheckpointedGroupId { id: string; } /** * An intervention that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedIntervention { interventionRid: string; } /** * Intervention identifier for a checkpointed intervention. * * Log Safety: SAFE */ declare interface CheckpointedInterventionRid { rid: string; } /** * An issue that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedIssue { issueRid: string; } /** * Issue identifier for a checkpointed issue. * * Log Safety: SAFE */ declare interface CheckpointedIssueRid { rid: string; } /** * Snapshot of the entity that was captured in a checkpoint. * * Log Safety: UNSAFE */ declare type CheckpointedItem = ({ type: "checkpointedIssue"; } & CheckpointedIssue) | ({ type: "checkpointedJob"; } & CheckpointedJob) | ({ type: "checkpointedSchedule"; } & CheckpointedSchedule) | ({ type: "checkpointedResource"; } & CheckpointedResource) | ({ type: "checkpointedJobSpecification"; } & CheckpointedJobSpecification) | ({ type: "checkpointedLanguageModel"; } & CheckpointedLanguageModel) | ({ type: "checkpointedGroup"; } & CheckpointedGroup) | ({ type: "checkpointedUserIntakeSubmission"; } & CheckpointedUserIntakeSubmission) | ({ type: "checkpointedObjectSet"; } & CheckpointedObjectSet) | ({ type: "checkpointedMarking"; } & CheckpointedMarking) | ({ type: "checkpointedMarketplaceProduct"; } & CheckpointedMarketplaceProduct) | ({ type: "checkpointedPeeringJob"; } & CheckpointedPeeringJob) | ({ type: "checkpointedRole"; } & CheckpointedRole) | ({ type: "checkpointedIntervention"; } & CheckpointedIntervention) | ({ type: "checkpointedLanguageModelSession"; } & CheckpointedLanguageModelSession) | ({ type: "checkpointedToken"; } & CheckpointedToken) | ({ type: "checkpointedUserIntakeFormInput"; } & CheckpointedUserIntakeFormInput) | ({ type: "checkpointedPrincipal"; } & CheckpointedPrincipal) | ({ type: "checkpointedActionType"; } & CheckpointedActionType); /** * Identifier for a checkpointed item. This union type explicitly identifies the type of item being referenced, eliminating ambiguity between RIDs and string IDs. * * Log Safety: UNSAFE */ declare type CheckpointedItemId = ({ type: "checkpointedJobRid"; } & CheckpointedJobRid) | ({ type: "checkpointedMarkingId"; } & CheckpointedMarkingId) | ({ type: "checkpointedTokenId"; } & CheckpointedTokenId) | ({ type: "checkpointedGroupId"; } & CheckpointedGroupId) | ({ type: "checkpointedObjectSetVersionedRid"; } & CheckpointedObjectSetVersionedRid) | ({ type: "checkpointedObjectSetTypesProxyRids"; } & CheckpointedObjectSetTypesProxyRids) | ({ type: "checkpointedResourceRid"; } & CheckpointedResourceRid) | ({ type: "checkpointedPeeringJobId"; } & CheckpointedPeeringJobId) | ({ type: "checkpointedIssueRid"; } & CheckpointedIssueRid) | ({ type: "checkpointedInterventionRid"; } & CheckpointedInterventionRid) | ({ type: "checkpointedJobSpecRid"; } & CheckpointedJobSpecRid) | ({ type: "checkpointedActionTypeRid"; } & CheckpointedActionTypeRid) | ({ type: "checkpointedScheduleRid"; } & CheckpointedScheduleRid) | ({ type: "checkpointedRoleId"; } & CheckpointedRoleId) | ({ type: "checkpointedUserIntakeFormInputId"; } & CheckpointedUserIntakeFormInputId) | ({ type: "checkpointedMarketplaceProductId"; } & CheckpointedMarketplaceProductId) | ({ type: "checkpointedLanguageModelRid"; } & CheckpointedLanguageModelRid) | ({ type: "checkpointedPrincipalId"; } & CheckpointedPrincipalId) | ({ type: "checkpointedLanguageModelSessionRid"; } & CheckpointedLanguageModelSessionRid) | ({ type: "checkpointedUserIntakeSubmissionRid"; } & CheckpointedUserIntakeSubmissionRid); /** * The type of item that was captured as part of the checkpoint. * * Log Safety: SAFE */ declare type CheckpointedItemType = "RESOURCE" | "MARKING" | "TOKEN" | "PRINCIPAL" | "JOB" | "GROUP" | "ROLE" | "MARKETPLACE_PRODUCT" | "INTERVENTION" | "SCHEDULE" | "JOB_SPECIFICATION" | "LANGUAGE_MODEL" | "LANGUAGE_MODEL_SESSION" | "USER_INTAKE_SUBMISSION" | "USER_INTAKE_FORM_INPUT" | "ACTION_TYPE" | "OBJECT_TYPE" | "OBJECT_SET" | "ONTOLOGY" | "ISSUE" | "PEERING_JOB"; /** * A build job that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedJob { jobRid: string; } /** * Job identifier for a checkpointed job. * * Log Safety: SAFE */ declare interface CheckpointedJobRid { rid: string; } /** * A job specification that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedJobSpecification { jobSpecRid: string; } /** * Job specification identifier for a checkpointed job spec. * * Log Safety: SAFE */ declare interface CheckpointedJobSpecRid { rid: string; } /** * A language model that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedLanguageModel { modelRid: string; } /** * Language model identifier for a checkpointed language model. * * Log Safety: SAFE */ declare interface CheckpointedLanguageModelRid { rid: string; } /** * A language model session that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedLanguageModelSession { sessionRid: string; } /** * Language model session identifier for a checkpointed session. * * Log Safety: SAFE */ declare interface CheckpointedLanguageModelSessionRid { rid: string; } /** * A Marketplace product that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedMarketplaceProduct { productId: string; } /** * Marketplace product identifier for a checkpointed product. * * Log Safety: SAFE */ declare interface CheckpointedMarketplaceProductId { id: string; } /** * A marking that was captured as part of a checkpoint. * * Log Safety: UNSAFE */ declare interface CheckpointedMarking { markingId: string; } /** * Marking identifier for a checkpointed marking. * * Log Safety: UNSAFE */ declare interface CheckpointedMarkingId { id: string; } /** * Represents the object set that was checkpointed. * * Log Safety: SAFE */ declare interface CheckpointedObjectSet { versioned?: CheckpointedVersionedObjectSet; typesProxy?: CheckpointedObjectSetTypesProxy; } /** * A types proxy object set that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedObjectSetTypesProxy { objectTypes: Array; } /** * Object type RIDs for a types proxy object set. * * Log Safety: SAFE */ declare interface CheckpointedObjectSetTypesProxyRids { rids: Array; } /** * Versioned object set RID for a checkpointed object set. * * Log Safety: SAFE */ declare interface CheckpointedObjectSetVersionedRid { rid: string; } /** * An ontology snapshot that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedOntology { ontologyRid: string; ontologyVersion: string; namespaceRid?: NamespaceRid; } /** * An ontology with its associated object types that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedOntologyWithObjectTypes { ontology: CheckpointedOntology; objectTypeRids: Array; } /** * A peering job that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedPeeringJob { jobId: string; relationshipRid: string; } /** * Peering job identifier for a checkpointed peering job. * * Log Safety: SAFE */ declare interface CheckpointedPeeringJobId { id: string; relationshipRid: string; } /** * A user or group principal that was captured as part of a checkpoint. * * Log Safety: UNSAFE */ declare interface CheckpointedPrincipal { id: string; username: RedactableString; organizationRid?: OrganizationRid_2; role: CheckpointedPrincipalRole; } /** * Principal identifier for a checkpointed principal. * * Log Safety: SAFE */ declare interface CheckpointedPrincipalId { id: string; } /** * Role the principal had relative to the checkpointed entity. * * Log Safety: SAFE */ declare type CheckpointedPrincipalRole = "SOURCE_SHARE_RECIPIENT" | "TARGET_GROUP" | "GROUP_MEMBER" | "MARKING_MEMBER" | "ROLE_GRANT_RECIPIENT" | "MFA_METHOD_RESET_TARGET" | "ISSUE_ASSIGNEE"; /** * A Foundry resource that was captured as part of a checkpoint. * * Log Safety: UNSAFE */ declare interface CheckpointedResource { rid: string; resourceType: CheckpointedResourceType; name?: RedactableString; projectRid?: ProjectRid_2; namespaceRid?: NamespaceRid; compassPath: RedactableString; orgMarkings: Array; } /** * Resource identifier for a checkpointed resource. * * Log Safety: UNSAFE */ declare interface CheckpointedResourceRid { rid: string; } /** * Type of resource that was captured. * * Log Safety: SAFE */ declare type CheckpointedResourceType = "CONTOUR_ANALYSIS" | "CONTOUR_SOURCE_DATASET" | "DATA_CONNECTION_SYNC" | "DATA_CONNECTION_SOURCE" | "DATA_CONNECTION_SYNC_TARGET_DATASET" | "HUBBLE_OBJECT_TYPE" | "EXPORTED_RESOURCE" | "IMPORTED_RESOURCE" | "REPORT" | "CIPHER_CHANNEL" | "CIPHER_LICENSE" | "PARENT_RESOURCE" | "ATTACHMENT" | "SLATE_APPLICATION" | "NOTEPAD" | "DATASET" | "MEDIA_SET" | "CODE_REPOSITORY" | "CODE_WORKBOOK" | "CODE_WORKSPACE" | "TELEMETRY_CONTAINER" | "REFERENCED_RESOURCE" | "ROLE_GRANT_RESOURCE" | "PROJECT" | "STORE" | "THIRD_PARTY_APPLICATION" | "BUILDER_PIPELINE" | "MODEL" | "MODEL_VERSION" | "AGENT" | "WORKSHOP_MODULE" | "WALKTHROUGH" | "FLOW_CAPTURE" | "PEERING_CONNECTION"; /** * A role that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedRole { roleId: string; } /** * Role identifier for a checkpointed role. * * Log Safety: SAFE */ declare interface CheckpointedRoleId { id: string; } /** * A schedule that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedSchedule { scheduleRid: string; } /** * Schedule identifier for a checkpointed schedule. * * Log Safety: SAFE */ declare interface CheckpointedScheduleRid { rid: string; } /** * An authentication token that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedToken { tokenId: string; tokenType: CheckpointedTokenType; } /** * Token identifier for a checkpointed token. * * Log Safety: SAFE */ declare interface CheckpointedTokenId { id: string; } /** * The type of token that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare type CheckpointedTokenType = "USER_TOKEN"; /** * A user intake form input that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedUserIntakeFormInput { inputId: string; } /** * User intake form input identifier for a checkpointed form input. * * Log Safety: SAFE */ declare interface CheckpointedUserIntakeFormInputId { id: string; } /** * A user intake form submission that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedUserIntakeSubmission { submissionRid: string; } /** * User intake submission identifier for a checkpointed submission. * * Log Safety: SAFE */ declare interface CheckpointedUserIntakeSubmissionRid { rid: string; } /** * A versioned object set that was captured as part of a checkpoint. * * Log Safety: SAFE */ declare interface CheckpointedVersionedObjectSet { versionedObjectSetRid: string; objectSetVersion: string; objectTypes: Array; } /** * The checkpoint record could not be found. * * Log Safety: SAFE */ declare interface CheckpointRecordNotFound { errorCode: "NOT_FOUND"; errorName: "CheckpointRecordNotFound"; errorDescription: "The checkpoint record could not be found."; errorInstanceId: string; parameters: { recordRid: unknown; }; } /** * The caller does not have permission to access the checkpoint record. * * Log Safety: SAFE */ declare interface CheckpointRecordPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CheckpointRecordPermissionDenied"; errorDescription: "The caller does not have permission to access the checkpoint record."; errorInstanceId: string; parameters: { recordRid: unknown; }; } export declare namespace Checkpoints { export { _Record, AcknowledgementJustification, ActingUser, ApprovalsMetadata, ApprovalsSubtaskId, ApprovalsTaskId, CheckpointedActionType, CheckpointedActionTypeRid, CheckpointedGroup, CheckpointedGroupId, CheckpointedIntervention, CheckpointedInterventionRid, CheckpointedIssue, CheckpointedIssueRid, CheckpointedItem, CheckpointedItemId, CheckpointedItemType, CheckpointedJob, CheckpointedJobRid, CheckpointedJobSpecification, CheckpointedJobSpecRid, CheckpointedLanguageModel, CheckpointedLanguageModelRid, CheckpointedLanguageModelSession, CheckpointedLanguageModelSessionRid, CheckpointedMarketplaceProduct, CheckpointedMarketplaceProductId, CheckpointedMarking, CheckpointedMarkingId, CheckpointedObjectSet, CheckpointedObjectSetTypesProxy, CheckpointedObjectSetTypesProxyRids, CheckpointedObjectSetVersionedRid, CheckpointedOntology, CheckpointedOntologyWithObjectTypes, CheckpointedPeeringJob, CheckpointedPeeringJobId, CheckpointedPrincipal, CheckpointedPrincipalId, CheckpointedPrincipalRole, CheckpointedResource, CheckpointedResourceRid, CheckpointedResourceType, CheckpointedRole, CheckpointedRoleId, CheckpointedSchedule, CheckpointedScheduleRid, CheckpointedToken, CheckpointedTokenId, CheckpointedTokenType, CheckpointedUserIntakeFormInput, CheckpointedUserIntakeFormInputId, CheckpointedUserIntakeSubmission, CheckpointedUserIntakeSubmissionRid, CheckpointedVersionedObjectSet, CheckpointType, ConfigRid, DropdownJustification, DropdownSelection, GetRecordsBatchRequestElement, GetRecordsBatchResponse, InteractionRid, Justification, JustificationMatchType, NamespaceRid, OrganizationRid_2 as OrganizationRid, ProjectRid_2 as ProjectRid, ReauthenticationJustification, RecordCreatedAt, RecordRid, RedactableString, RedactionType, ResponseJustification, Scope, SearchCheckpointRecordsAndFilter, SearchCheckpointRecordsCheckpointedItemIdFilter, SearchCheckpointRecordsEqualsFilter, SearchCheckpointRecordsEqualsFilterField, SearchCheckpointRecordsFilter, SearchCheckpointRecordsGteFilter, SearchCheckpointRecordsGteFilterField, SearchCheckpointRecordsLtFilter, SearchCheckpointRecordsLtFilterField, SearchCheckpointRecordsNotFilter, SearchCheckpointRecordsOrFilter, SearchCheckpointRecordsRequest, SearchCheckpointRecordsResponse, SearchCheckpointRecordsTextSearchFilter, SearchCheckpointRecordsTextSearchFilterField, SearchRecordsRequest, SortDirection, CheckpointRecordNotFound, CheckpointRecordPermissionDenied, RecordNotFound, SearchRecordsPermissionDenied, Records } } declare namespace _Checkpoints { export { LooselyBrandedString_11 as LooselyBrandedString, AcknowledgementJustification, ActingUser, ApprovalsMetadata, ApprovalsSubtaskId, ApprovalsTaskId, CheckpointedActionType, CheckpointedActionTypeRid, CheckpointedGroup, CheckpointedGroupId, CheckpointedIntervention, CheckpointedInterventionRid, CheckpointedIssue, CheckpointedIssueRid, CheckpointedItem, CheckpointedItemId, CheckpointedItemType, CheckpointedJob, CheckpointedJobRid, CheckpointedJobSpecification, CheckpointedJobSpecRid, CheckpointedLanguageModel, CheckpointedLanguageModelRid, CheckpointedLanguageModelSession, CheckpointedLanguageModelSessionRid, CheckpointedMarketplaceProduct, CheckpointedMarketplaceProductId, CheckpointedMarking, CheckpointedMarkingId, CheckpointedObjectSet, CheckpointedObjectSetTypesProxy, CheckpointedObjectSetTypesProxyRids, CheckpointedObjectSetVersionedRid, CheckpointedOntology, CheckpointedOntologyWithObjectTypes, CheckpointedPeeringJob, CheckpointedPeeringJobId, CheckpointedPrincipal, CheckpointedPrincipalId, CheckpointedPrincipalRole, CheckpointedResource, CheckpointedResourceRid, CheckpointedResourceType, CheckpointedRole, CheckpointedRoleId, CheckpointedSchedule, CheckpointedScheduleRid, CheckpointedToken, CheckpointedTokenId, CheckpointedTokenType, CheckpointedUserIntakeFormInput, CheckpointedUserIntakeFormInputId, CheckpointedUserIntakeSubmission, CheckpointedUserIntakeSubmissionRid, CheckpointedVersionedObjectSet, CheckpointType, ConfigRid, DropdownJustification, DropdownSelection, GetRecordsBatchRequestElement, GetRecordsBatchResponse, InteractionRid, Justification, JustificationMatchType, NamespaceRid, OrganizationRid_2 as OrganizationRid, ProjectRid_2 as ProjectRid, ReauthenticationJustification, _Record, RecordCreatedAt, RecordRid, RedactableString, RedactionType, ResponseJustification, Scope, SearchCheckpointRecordsAndFilter, SearchCheckpointRecordsCheckpointedItemIdFilter, SearchCheckpointRecordsEqualsFilter, SearchCheckpointRecordsEqualsFilterField, SearchCheckpointRecordsFilter, SearchCheckpointRecordsGteFilter, SearchCheckpointRecordsGteFilterField, SearchCheckpointRecordsLtFilter, SearchCheckpointRecordsLtFilterField, SearchCheckpointRecordsNotFilter, SearchCheckpointRecordsOrFilter, SearchCheckpointRecordsRequest, SearchCheckpointRecordsResponse, SearchCheckpointRecordsTextSearchFilter, SearchCheckpointRecordsTextSearchFilterField, SearchRecordsRequest, SortDirection } } /** * Checkpoint type identifier. See the Checkpoints documentation for more details. * * Log Safety: SAFE */ declare type CheckpointType = "CONTOUR_CREATE" | "CONTOUR_EXPORT" | "HUBBLE_EXPORT" | "COMPASS_IMPORT" | "COMPASS_EXPORT" | "COMPASS_ADD_REFERENCE" | "COMPASS_AUTHORIZE_MARKING_ON_PROJECT" | "COMPASS_ADD_ROLE_GRANT" | "COMPASS_REMOVE_REFERENCE" | "COMPASS_REMOVE_AUTHORIZED_MARKING_FROM_PROJECT" | "COMPASS_REMOVE_ROLE_GRANT" | "DATA_CONNECTION_SYNC_CREATE" | "DATA_CONNECTION_SYNC_BULK_CREATE" | "DATA_CONNECTION_SYNC_EDIT" | "DATA_CONNECTION_SOURCE_SHARE" | "LOGIN" | "REPORT_EXPORT" | "CIPHER_ENCRYPT" | "CIPHER_DECRYPT" | "ATTACHMENT_IMPORT" | "ATTACHMENT_EXPORT" | "SLATE_EXPORT" | "NOTEPAD_EXPORT" | "QUIVER_EXPORT" | "DATA_LIFETIME_APPLY_RETENTION_POLICY" | "FRONTEND_EXPORT" | "BUILD_LOG_EXPORT" | "CODE_REPOSITORY_LOG_EXPORT" | "CODE_REPOSITORY_MODIFY_APPROVAL_POLICY" | "CODE_REPOSITORY_MERGE_PULL_REQUEST" | "CODE_REPOSITORY_BUILD" | "CODE_WORKBOOK_BUILD" | "SCHEDULE_CREATE" | "SCHEDULE_MODIFY" | "SCHEDULE_RUN" | "SCHEDULE_DELETE" | "RUN_BUILD" | "MULTIPASS_TOKEN_CREATE" | "MULTIPASS_ADD_GROUP_MEMBER" | "MULTIPASS_ADD_MARKING_MEMBER" | "MULTIPASS_REMOVE_GROUP_MEMBER" | "MULTIPASS_REMOVE_MARKING_MEMBER" | "MULTIPASS_UPDATE_GROUP_MEMBERSHIP_EXPIRATION_CONFIG" | "MULTIPASS_UPDATE_GROUP_MEMBER_EXPIRY" | "SCOPED_SESSION_SELECT" | "CODE_WORKSPACE_LOG_EXPORT" | "CODE_WORKSPACE_MOVE_DATA_FROM_FOUNDRY" | "CODE_WORKSPACE_MOVE_DATA_TO_FOUNDRY" | "MANAGE_CODE_WORKSPACE_DASHBOARD_DOWNLOADS" | "NOTEPAD_MEDIA_IMPORT" | "CONTOUR_DASHBOARD_EXPORT" | "PACKAGE_PRODUCT" | "NOTEPAD_WIDGET_SNAPSHOT" | "MEDIA_SET_IMPORT" | "MEDIA_SET_EXPORT" | "UPGRADE_ASSISTANT_SUMMARY_EXPORT" | "TABLES_REGISTRATION_AUTOMATIC" | "TABLES_REGISTRATION_MANUAL" | "DEV_CONSOLE_OPENAPI_SPECIFICATION_EXPORT" | "DEV_CONSOLE_USAGE_EXPORT" | "DEPLOY_PIPELINE" | "PIPELINE_BUILDER_MERGE_PROPOSAL" | "PIPELINE_BUILDER_MODIFY_APPROVAL_POLICY" | "PIPELINE_BUILDER_ARCHIVE_BRANCHES" | "PIPELINE_BUILDER_MODIFY_FALLBACK_BRANCHES" | "MODEL_EXPORT" | "THREADS_SESSION_EXPORT" | "AGENT_SESSION_EXPORT" | "USER_INTAKE_SUBMISSION_EXPORT" | "FUNCTION_BACKED_EXPORT" | "SUBMIT_ACTION" | "START_WALKTHROUGH" | "OBJECT_SET_EXPORT" | "RESET_MFA_METHOD" | "ISSUE_CREATE" | "RECORD_FLOW_CAPTURE" | "UPLOAD_DATA_TO_FLOW_CAPTURE" | "EXPORT_FLOW_CAPTURE_ZIP" | "INSIGHT_LOAD" | "AIP_ANALYST_APP_LOAD" | "PEER_MANAGER_CDS_PAYLOAD_EXPORT" | "PEER_MANAGER_OBJECT_TYPE_SCHEMAS_EXPORT" | "AIP_ANALYST_EXPORT" | "OBJECT_EXPLORER_SEARCH"; /** * Log Safety: UNSAFE */ declare interface CheckReport { rid: _Core.CheckReportRid; check: Check; result: CheckResult; createdTime: _Core.CreatedTime; } /** * The maximum number of check reports to return in a single request. Validation rules: must be greater than or equal to 1 must be less than or equal to 100 * * Log Safety: SAFE */ declare type CheckReportLimit = number; /** * CheckReportLimit must be less than or equal to 100 * * Log Safety: SAFE */ declare interface CheckReportLimitAboveMaximum { errorCode: "INVALID_ARGUMENT"; errorName: "CheckReportLimitAboveMaximum"; errorDescription: "CheckReportLimit must be less than or equal to 100"; errorInstanceId: string; parameters: { value: unknown; maxInclusive: unknown; }; } /** * CheckReportLimit must be greater than or equal to 1 * * Log Safety: SAFE */ declare interface CheckReportLimitBelowMinimum { errorCode: "INVALID_ARGUMENT"; errorName: "CheckReportLimitBelowMinimum"; errorDescription: "CheckReportLimit must be greater than or equal to 1"; errorInstanceId: string; parameters: { value: unknown; minInclusive: unknown; }; } /** * The given CheckReport could not be found. * * Log Safety: SAFE */ declare interface CheckReportNotFound { errorCode: "NOT_FOUND"; errorName: "CheckReportNotFound"; errorDescription: "The given CheckReport could not be found."; errorInstanceId: string; parameters: { checkReportRid: unknown; checkRid: unknown; }; } /** * The unique resource identifier (RID) of a Data Health Check Report. * * Log Safety: SAFE */ declare type CheckReportRid = LooselyBrandedString<"CheckReportRid">; export declare namespace CheckReports { export { } } /** * The result of running a check. * * Log Safety: UNSAFE */ declare interface CheckResult { status: CheckResultStatus; message?: string; } /** * The status of a check report execution. * * Log Safety: SAFE */ declare type CheckResultStatus = "PASSED" | "FAILED" | "WARNING" | "ERROR" | "NOT_APPLICABLE" | "NOT_COMPUTABLE"; /** * The unique resource identifier (RID) of a Data Health Check. * * Log Safety: SAFE */ declare type CheckRid = LooselyBrandedString<"CheckRid">; export declare namespace Checks { export { } } /** * The type of the requested check is not yet supported in the Platform API. * * Log Safety: UNSAFE */ declare interface CheckTypeNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "CheckTypeNotSupported"; errorDescription: "The type of the requested check is not yet supported in the Platform API."; errorInstanceId: string; parameters: { checkType: unknown; }; } /** * List all child resources of the Folder. * * This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is * provided, this page size will also be used as the default. * * @public * * Required Scopes: [] * URL: /v2/filesystem/folders/{folderRid}/children */ declare function children($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ folderRid: _Filesystem_2.FolderRid, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Filesystem_2.ListChildrenOfFolderResponse>; /** * The Cipher Channel was not found. It either does not exist, or you do not have permission to see it. * * Log Safety: SAFE */ declare interface CipherChannelNotFound { errorCode: "NOT_FOUND"; errorName: "CipherChannelNotFound"; errorDescription: "The Cipher Channel was not found. It either does not exist, or you do not have permission to see it."; errorInstanceId: string; parameters: { cipherChannel: unknown; }; } /** * A Cipher Channel could not be resolved for encryption under the requested cipherChannelStrategy. Depending on the strategy, this means the object has no existing encrypted value and/or the property has no default Cipher Channel configured. * * Log Safety: UNSAFE */ declare interface CipherChannelNotResolvable { errorCode: "INVALID_ARGUMENT"; errorName: "CipherChannelNotResolvable"; errorDescription: "A Cipher Channel could not be resolved for encryption under the requested cipherChannelStrategy. Depending on the strategy, this means the object has no existing encrypted value and/or the property has no default Cipher Channel configured."; errorInstanceId: string; parameters: { objectType: unknown; property: unknown; strategy: unknown; }; } /** * Controls which Cipher Channel is used when encrypting a value. If not specified, defaults to PREFER_EXISTING. PREFER_EXISTING: use the Cipher Channel parsed from the existing ciphertext value; fall back to the default channel configured in ontology metadata. PREFER_DEFAULT: use the default channel configured in ontology metadata; fall back to the channel parsed from the existing ciphertext value. EXISTING_ONLY: use the channel parsed from the existing ciphertext value only; error if the value is not already encrypted. DEFAULT_ONLY: use the default channel configured in ontology metadata only; error if none is configured. * * Log Safety: SAFE */ declare type CipherChannelStrategy = "PREFER_EXISTING" | "PREFER_DEFAULT" | "EXISTING_ONLY" | "DEFAULT_ONLY"; /** * A value encrypted with Cipher, stored in its envelope form which encodes the Cipher Channel used to encrypt it (for example CIPHER::{cipherChannelRid}::::CIPHER). * * Log Safety: UNSAFE */ declare type CipherText = LooselyBrandedString_5<"CipherText">; export declare namespace CipherTextProperties { export { decrypt } } /** * Log Safety: UNSAFE */ declare type CipherTextProperty = LooselyBrandedString_5<"CipherTextProperty">; /** * Log Safety: SAFE */ declare interface CipherTextType { defaultCipherChannel?: string; } /** * The requested operation would result in a circular dependency in the folder hierarchy. For example, moving a folder into one of its descendants. * * Log Safety: SAFE */ declare interface CircularDependency { errorCode: "INVALID_ARGUMENT"; errorName: "CircularDependency"; errorDescription: "The requested operation would result in a circular dependency in the folder hierarchy. For example, moving a folder into one of its descendants."; errorInstanceId: string; parameters: {}; } /** * The display type of the classification banner. BANNER_LINE is the long classification string used in the header of a document; PORTION_MARKING is a short classification string used for individual paragraphs * * Log Safety: SAFE */ declare type ClassificationBannerDisplayType = "BANNER_LINE" | "PORTION_MARKING"; /* Excluded from this release type: clear */ /** * Log Safety: SAFE */ declare type ClientId = string; /** * PACK clients may support a range of document type schema versions. This allows for schema upgrades while maintaining cross-client collaboration compatibility. * * Log Safety: SAFE */ declare interface ClientSupportedVersionRange { minVersion: SchemaVersion; maxVersion: SchemaVersion; } /** * Cloud identities allow you to authenticate to cloud provider resources without the use of static credentials. * * Log Safety: SAFE */ declare interface CloudIdentity { cloudIdentityRid: CloudIdentityRid; } /** * The Resource Identifier (RID) of a Cloud Identity. * * Log Safety: SAFE */ declare type CloudIdentityRid = LooselyBrandedString_12<"CloudIdentityRid">; /** * The hex value of a color. * * Log Safety: UNSAFE */ declare type Color = LooselyBrandedString<"Color">; /** * An RGBA color value. * * Log Safety: SAFE */ declare interface Color_2 { r: number; g: number; b: number; a?: number; } /** * The color interpretation of a band. * * Log Safety: SAFE */ declare type ColorInterpretation = "UNDEFINED" | "GRAY" | "PALETTE_INDEX" | "RED" | "GREEN" | "BLUE" | "ALPHA" | "HUE" | "SATURATION" | "LIGHTNESS" | "CYAN" | "MAGENTA" | "YELLOW" | "BLACK" | "Y_CB_CR_SPACE_Y" | "Y_CB_CR_SPACE_CB" | "Y_CB_CR_SPACE_CR"; /** * Configuration for column count validation with severity settings. * * Log Safety: SAFE */ declare interface ColumnCountConfig { expectedValue: string; severity: SeverityLevel; } /** * Information about a column including its name and type. * * Log Safety: UNSAFE */ declare interface ColumnInfo { name: ColumnName_3; columnType?: _Core.SchemaFieldType; } /** * The name of a column in a dataset. * * Log Safety: UNSAFE */ declare type ColumnName = LooselyBrandedString<"ColumnName">; /** * The name of a column in a tabular datasource. * * Log Safety: UNSAFE */ declare type ColumnName_2 = LooselyBrandedString_5<"ColumnName">; /** * Log Safety: UNSAFE */ declare type ColumnName_3 = LooselyBrandedString_8<"ColumnName">; /** * The name of a column in a dataset. * * Log Safety: UNSAFE */ declare type ColumnName_4 = LooselyBrandedString_15<"ColumnName">; /** * A property bound to a single column in the backing datasource. * * Log Safety: UNSAFE */ declare interface ColumnPropertyMapping { column: ColumnName_2; } /** * The type of a column in a SQL query result or parameter. * * Log Safety: UNSAFE */ declare type ColumnType = ({ type: "date"; } & _Core.DateType) | ({ type: "struct"; } & StructColumnType) | ({ type: "string"; } & _Core.StringType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "float"; } & _Core.FloatType) | ({ type: "list"; } & ListColumnType) | ({ type: "any"; } & AnyColumnType) | ({ type: "long"; } & _Core.LongType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "binary"; } & _Core.BinaryType) | ({ type: "short"; } & _Core.ShortType) | ({ type: "decimal"; } & DecimalColumnType) | ({ type: "map"; } & MapColumnType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * Checks the existence and optionally the type of a specific column. * * Log Safety: UNSAFE */ declare interface ColumnTypeCheckConfig { subject: DatasetSubject; columnTypeConfig: ColumnTypeConfig; } /** * Configuration for column type validation with severity settings. * * Log Safety: UNSAFE */ declare interface ColumnTypeConfig { columnName: ColumnName_3; expectedType?: _Core.SchemaFieldType; severity: SeverityLevel; } /** * The dataset contains column types that are not supported. * * Log Safety: SAFE */ declare interface ColumnTypesNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "ColumnTypesNotSupported"; errorDescription: "The dataset contains column types that are not supported."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * The query result contains column types that are not supported by the requested serialization format. * * Log Safety: SAFE */ declare interface ColumnTypesNotSupported_2 { errorCode: "INVALID_ARGUMENT"; errorName: "ColumnTypesNotSupported"; errorDescription: "The query result contains column types that are not supported by the requested serialization format."; errorInstanceId: string; parameters: {}; } /** * An identifier for a column type specification. * * Log Safety: UNSAFE */ declare type ColumnTypeSpecId = LooselyBrandedString_15<"ColumnTypeSpecId">; /** * A column value that can be of different types. * * Log Safety: UNSAFE */ declare type ColumnValue = ({ type: "date"; } & DateColumnValue) | ({ type: "boolean"; } & BooleanColumnValue) | ({ type: "string"; } & StringColumnValue) | ({ type: "numeric"; } & NumericColumnValue); /** * Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is * updated to point to the Transaction. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/{datasetRid}/transactions/{transactionRid}/commit */ declare function commit($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, transactionRid: _Datasets_2.TransactionRid ]): Promise<_Datasets_2.Transaction>; /* Excluded from this release type: commit_2 */ /* Excluded from this release type: commitOffsets */ /** * Could not commitOffsets the Subscriber. * * Log Safety: UNSAFE */ declare interface CommitSubscriberOffsetsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CommitSubscriberOffsetsPermissionDenied"; errorDescription: "Could not commitOffsets the Subscriber."; errorInstanceId: string; parameters: { datasetRid: unknown; subscriberSubscriberId: unknown; streamBranchName: unknown; }; } /** * Log Safety: SAFE */ declare interface CommitSubscriberOffsetsRequest { viewRid?: ViewRid; offsets: PartitionOffsets; } /** * The provided token does not have permission to commit the given transaction on the given dataset. * * Log Safety: SAFE */ declare interface CommitTransactionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CommitTransactionPermissionDenied"; errorDescription: "The provided token does not have permission to commit the given transaction on the given dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; }; } /** * Common DICOM data elements. * * Log Safety: UNSAFE */ declare interface CommonDicomDataElements { numberFrames?: number; modality?: Modality; patientId?: string; studyId?: string; studyUid?: string; seriesUid?: string; studyTime?: string; seriesTime?: string; } /** * Compass-backed documents require a parent folder upon creation. * * Log Safety: UNSAFE */ declare interface CompassDocumentCreationMissingParentFolder { errorCode: "INVALID_ARGUMENT"; errorName: "CompassDocumentCreationMissingParentFolder"; errorDescription: "Compass-backed documents require a parent folder upon creation."; errorInstanceId: string; parameters: { documentTypeName: unknown; providedParent: unknown; }; } /** * Compass backed documents do not support discretionary security on creation. The creating user will be an owner of the document by default. * * Log Safety: UNSAFE */ declare interface CompassDocumentCreationWithDiscretionarySecurityNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "CompassDocumentCreationWithDiscretionarySecurityNotSupported"; errorDescription: "Compass backed documents do not support discretionary security on creation. The creating user will be an owner of the document by default."; errorInstanceId: string; parameters: { documentTypeName: unknown; }; } /** * Primary keys consisting of multiple properties are not supported by this API. If you need support for this, please reach out to Palantir Support. * * Log Safety: UNSAFE */ declare interface CompositePrimaryKeyNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "CompositePrimaryKeyNotSupported"; errorDescription: "Primary keys consisting of multiple properties are not supported by this API. If you need support for this, please reach out to Palantir Support."; errorInstanceId: string; parameters: { objectType: unknown; primaryKey: unknown; }; } /** * Compression helps reduce the size of the data being sent, resulting in lower network usage and storage, at the cost of some additional CPU usage for compression and decompression. This stream type is only recommended if your stream contains a high volume of repetitive strings and is experiencing poor network bandwidth symptoms like non-zero lag, lower than expected throughput, or dropped records. * * Log Safety: SAFE */ declare type Compressed = boolean; /** * A measurement of compute usage expressed in compute-seconds. For more information, please refer to the Usage types documentation. * * Log Safety: SAFE */ declare type ComputeSeconds = number; /** * Thrown when conda solve fails for the provided input packages. * * Log Safety: UNSAFE */ declare interface CondaSolveFailureForProvidedPackages { errorCode: "INVALID_ARGUMENT"; errorName: "CondaSolveFailureForProvidedPackages"; errorDescription: "Thrown when conda solve fails for the provided input packages."; errorInstanceId: string; parameters: { errorType: unknown; errorMessage: unknown; }; } /** * Identifier of the checkpoint configuration that produced a record. * * Log Safety: SAFE */ declare type ConfigRid = LooselyBrandedString_11<"ConfigRid">; /** * Client provided more than one of branch name, branch rid, or view rid as arguments. Only one may be specified. * * Log Safety: SAFE */ declare interface ConflictingMediaSetIdentifiers { errorCode: "INVALID_ARGUMENT"; errorName: "ConflictingMediaSetIdentifiers"; errorDescription: "Client provided more than one of branch name, branch rid, or view rid as arguments. Only one may be specified."; errorInstanceId: string; parameters: {}; } /** * The conjunctive set of markings required to access the property value. All markings from a conjunctive set must be met for access. * * Log Safety: UNSAFE */ declare type ConjunctiveMarkingSummary = Array; /** * All datasets between the input datasets (exclusive) and the target datasets (inclusive) except for the datasets to ignore. * * Log Safety: SAFE */ declare interface ConnectingTarget { inputRids: Array; targetRids: Array; ignoredRids: Array; } /** * Log Safety: DO_NOT_LOG */ declare interface Connection { rid: ConnectionRid; parentFolderRid: _Filesystem.FolderRid; displayName: ConnectionDisplayName; exportSettings: ConnectionExportSettings; worker: ConnectionWorker; configuration: ConnectionConfiguration; } /** * Log Safety: DO_NOT_LOG */ declare type ConnectionConfiguration = ({ type: "s3"; } & S3ConnectionConfiguration) | ({ type: "rest"; } & RestConnectionConfiguration) | ({ type: "snowflake"; } & SnowflakeConnectionConfiguration) | ({ type: "databricks"; } & DatabricksConnectionConfiguration) | ({ type: "smb"; } & SmbConnectionConfiguration) | ({ type: "jdbc"; } & JdbcConnectionConfiguration); /** * Details of the connection (such as which types of import it supports) could not be determined. * * Log Safety: UNSAFE */ declare interface ConnectionDetailsNotDetermined { errorCode: "INTERNAL"; errorName: "ConnectionDetailsNotDetermined"; errorDescription: "Details of the connection (such as which types of import it supports) could not be determined."; errorInstanceId: string; parameters: { connectionRid: unknown; connectionType: unknown; }; } /** * The display name of the Connection. The display name must not be blank. * * Log Safety: UNSAFE */ declare type ConnectionDisplayName = LooselyBrandedString_12<"ConnectionDisplayName">; /** * The export settings of a Connection. * * Log Safety: SAFE */ declare interface ConnectionExportSettings { exportsEnabled: boolean; exportEnabledWithoutMarkingsValidation: boolean; } /** * The given Connection could not be found. * * Log Safety: SAFE */ declare interface ConnectionNotFound { errorCode: "NOT_FOUND"; errorName: "ConnectionNotFound"; errorDescription: "The given Connection could not be found."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /** * The Resource Identifier (RID) of a Connection (also known as a source). * * Log Safety: SAFE */ declare type ConnectionRid = LooselyBrandedString_12<"ConnectionRid">; export declare namespace Connections { export { create_14 as create, get_44 as get, updateExportSettings, updateSecrets, getConfiguration, getConfigurationBatch, uploadCustomJdbcDrivers } } /** * The specified connection is not yet supported in the Platform API. * * Log Safety: UNSAFE */ declare interface ConnectionTypeNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "ConnectionTypeNotSupported"; errorDescription: "The specified connection is not yet supported in the Platform API."; errorInstanceId: string; parameters: { connectionType: unknown; }; } /** * The worker of a Connection, which defines where compute for capabilities are run. * * Log Safety: SAFE */ declare type ConnectionWorker = ({ type: "unknownWorker"; } & UnknownWorker) | ({ type: "foundryWorker"; } & FoundryWorker); export declare namespace Connectivity { export { AgentRid_2 as AgentRid, ApiKeyAuthentication, AsPlaintextValue, AsSecretName, AwsAccessKey, AwsOidcAuthentication, BasicCredentials, BearerToken, BigQueryVirtualTableConfig, CloudIdentity, CloudIdentityRid, Connection, ConnectionConfiguration, ConnectionDisplayName, ConnectionExportSettings, ConnectionRid, ConnectionWorker, CreateConnectionRequest, CreateConnectionRequestAsPlaintextValue, CreateConnectionRequestAsSecretName, CreateConnectionRequestAwsAccessKey, CreateConnectionRequestAwsOidcAuthentication, CreateConnectionRequestBasicCredentials, CreateConnectionRequestCloudIdentity, CreateConnectionRequestConnectionConfiguration, CreateConnectionRequestConnectionWorker, CreateConnectionRequestDatabricksAuthenticationMode, CreateConnectionRequestDatabricksConnectionConfiguration, CreateConnectionRequestDuration, CreateConnectionRequestEncryptedProperty, CreateConnectionRequestFoundryWorker, CreateConnectionRequestJdbcConnectionConfiguration, CreateConnectionRequestOauthMachineToMachineAuth, CreateConnectionRequestPersonalAccessToken, CreateConnectionRequestRestConnectionAdditionalSecrets, CreateConnectionRequestRestConnectionConfiguration, CreateConnectionRequestS3AuthenticationMode, CreateConnectionRequestS3ConnectionConfiguration, CreateConnectionRequestS3KmsConfiguration, CreateConnectionRequestS3ProxyConfiguration, CreateConnectionRequestSecretsNames, CreateConnectionRequestSecretsWithPlaintextValues, CreateConnectionRequestSmbAuth, CreateConnectionRequestSmbConnectionConfiguration, CreateConnectionRequestSmbProxyConfiguration, CreateConnectionRequestSmbUsernamePasswordAuth, CreateConnectionRequestSnowflakeAuthenticationMode, CreateConnectionRequestSnowflakeConnectionConfiguration, CreateConnectionRequestSnowflakeExternalOauth, CreateConnectionRequestSnowflakeKeyPairAuthentication, CreateConnectionRequestStsRoleConfiguration, CreateConnectionRequestUnknownWorker, CreateConnectionRequestWorkflowIdentityFederation, CreateFileImportRequest, CreateTableImportRequest, CreateTableImportRequestDatabricksTableImportConfig, CreateTableImportRequestDateColumnInitialIncrementalState, CreateTableImportRequestDecimalColumnInitialIncrementalState, CreateTableImportRequestIntegerColumnInitialIncrementalState, CreateTableImportRequestJdbcTableImportConfig, CreateTableImportRequestLongColumnInitialIncrementalState, CreateTableImportRequestMicrosoftAccessTableImportConfig, CreateTableImportRequestMicrosoftSqlServerTableImportConfig, CreateTableImportRequestOracleTableImportConfig, CreateTableImportRequestPostgreSqlTableImportConfig, CreateTableImportRequestSnowflakeTableImportConfig, CreateTableImportRequestStringColumnInitialIncrementalState, CreateTableImportRequestTableImportConfig, CreateTableImportRequestTableImportInitialIncrementalState, CreateTableImportRequestTimestampColumnInitialIncrementalState, CreateVirtualTableRequest, DatabricksAuthenticationMode, DatabricksConnectionConfiguration, DatabricksTableImportConfig, DateColumnInitialIncrementalState, DecimalColumnInitialIncrementalState, DeltaVirtualTableConfig, Domain, EncryptedProperty, FileAnyPathMatchesFilter, FileAtLeastCountFilter, FileChangedSinceLastUploadFilter, FileFormat, FileImport, FileImportCustomFilter, FileImportDisplayName, FileImportFilter, FileImportMode, FileImportRid, FileLastModifiedAfterFilter, FilePathMatchesFilter, FilePathNotMatchesFilter, FileProperty, FilesCountLimitFilter, FileSizeFilter, FilesVirtualTableConfig, FolderRid_4 as FolderRid, FoundryWorker, GetConfigurationConnectionsBatchRequestElement, GetConfigurationConnectionsBatchResponse, GlueVirtualTableConfig, HeaderApiKey, IcebergVirtualTableConfig, IntegerColumnInitialIncrementalState, InvalidConnectionReason, InvalidTableReason, JdbcConnectionConfiguration, JdbcDriverArtifactName, JdbcProperties, JdbcTableImportConfig, ListFileImportsResponse, ListTableImportsResponse, LongColumnInitialIncrementalState, MarkingId_4 as MarkingId, MicrosoftAccessTableImportConfig, MicrosoftSqlServerTableImportConfig, OauthMachineToMachineAuth, OracleTableImportConfig, PersonalAccessToken, PlaintextValue, PostgreSqlTableImportConfig, Protocol, QueryParameterApiKey, Region, ReplaceFileImportRequest, ReplaceTableImportRequest, ReplaceTableImportRequestDatabricksTableImportConfig, ReplaceTableImportRequestDateColumnInitialIncrementalState, ReplaceTableImportRequestDecimalColumnInitialIncrementalState, ReplaceTableImportRequestIntegerColumnInitialIncrementalState, ReplaceTableImportRequestJdbcTableImportConfig, ReplaceTableImportRequestLongColumnInitialIncrementalState, ReplaceTableImportRequestMicrosoftAccessTableImportConfig, ReplaceTableImportRequestMicrosoftSqlServerTableImportConfig, ReplaceTableImportRequestOracleTableImportConfig, ReplaceTableImportRequestPostgreSqlTableImportConfig, ReplaceTableImportRequestSnowflakeTableImportConfig, ReplaceTableImportRequestStringColumnInitialIncrementalState, ReplaceTableImportRequestTableImportConfig, ReplaceTableImportRequestTableImportInitialIncrementalState, ReplaceTableImportRequestTimestampColumnInitialIncrementalState, RestAuthenticationMode, RestConnectionAdditionalSecrets, RestConnectionConfiguration, RestConnectionOAuth2, RestRequestApiKeyLocation, S3AuthenticationMode, S3ConnectionConfiguration, S3KmsConfiguration, S3ProxyConfiguration, SecretName, SecretsNames, SecretsWithPlaintextValues, SmbAuth, SmbConnectionConfiguration, SmbProxyConfiguration, SmbProxyType, SmbUsernamePasswordAuth, SnowflakeAuthenticationMode, SnowflakeConnectionConfiguration, SnowflakeExternalOauth, SnowflakeKeyPairAuthentication, SnowflakeTableImportConfig, SnowflakeVirtualTableConfig, StringColumnInitialIncrementalState, StsRoleConfiguration, TableImport, TableImportAllowSchemaChanges, TableImportConfig, TableImportDisplayName, TableImportInitialIncrementalState, TableImportMode, TableImportQuery, TableImportRid, TableName, TableRid_3 as TableRid, TimestampColumnInitialIncrementalState, UnityVirtualTableConfig, UnknownWorker, UpdateExportSettingsForConnectionRequest, UpdateSecretsForConnectionRequest, UriScheme, VirtualTable, VirtualTableConfig, WorkflowIdentityFederation, AdditionalSecretsMustBeSpecifiedAsPlaintextValueMap, ConnectionDetailsNotDetermined, ConnectionNotFound, ConnectionTypeNotSupported, CreateConnectionPermissionDenied, CreateFileImportPermissionDenied, CreateTableImportPermissionDenied, CreateVirtualTablePermissionDenied, DeleteFileImportPermissionDenied, DeleteTableImportPermissionDenied, DomainMustUseHttpsWithAuthentication, DriverContentMustBeUploadedAsJar, DriverJarAlreadyExists, EncryptedPropertyMustBeSpecifiedAsPlaintextValue, ExecuteFileImportPermissionDenied, ExecuteTableImportPermissionDenied, FileAtLeastCountFilterInvalidMinCount, FileImportCustomFilterCannotBeUsedToCreateOrUpdateFileImports, FileImportNotFound, FileImportNotSupportedForConnection, FilesCountLimitFilterInvalidLimit, FileSizeFilterGreaterThanCannotBeNegative, FileSizeFilterInvalidGreaterThanAndLessThanRange, FileSizeFilterLessThanMustBeOneByteOrLarger, FileSizeFilterMissingGreaterThanAndLessThan, GetConfigurationPermissionDenied, HostNameCannotHaveProtocolOrPort, InvalidShareName, InvalidVirtualTableConnection, ParentFolderNotFoundForConnection, PortNotInRange, PropertyCannotBeBlank, PropertyCannotBeEmpty, ReplaceFileImportPermissionDenied, ReplaceTableImportPermissionDenied, SecretNamesDoNotExist, TableImportNotFound, TableImportNotSupportedForConnection, TableImportTypeNotSupported, UnknownWorkerCannotBeUsedForCreatingOrUpdatingConnections, UpdateExportSettingsForConnectionPermissionDenied, UpdateSecretsForConnectionPermissionDenied, UploadCustomJdbcDriverNotSupportForConnection, UploadCustomJdbcDriversConnectionPermissionDenied, VirtualTableAlreadyExists, VirtualTableRegisterFromSourcePermissionDenied, Connections, FileImports, TableImports, VirtualTables } } declare namespace _Connectivity { export { LooselyBrandedString_12 as LooselyBrandedString, AgentRid_2 as AgentRid, ApiKeyAuthentication, AsPlaintextValue, AsSecretName, AwsAccessKey, AwsOidcAuthentication, BasicCredentials, BearerToken, BigQueryVirtualTableConfig, CloudIdentity, CloudIdentityRid, Connection, ConnectionConfiguration, ConnectionDisplayName, ConnectionExportSettings, ConnectionRid, ConnectionWorker, CreateConnectionRequest, CreateConnectionRequestAsPlaintextValue, CreateConnectionRequestAsSecretName, CreateConnectionRequestAwsAccessKey, CreateConnectionRequestAwsOidcAuthentication, CreateConnectionRequestBasicCredentials, CreateConnectionRequestCloudIdentity, CreateConnectionRequestConnectionConfiguration, CreateConnectionRequestConnectionWorker, CreateConnectionRequestDatabricksAuthenticationMode, CreateConnectionRequestDatabricksConnectionConfiguration, CreateConnectionRequestDuration, CreateConnectionRequestEncryptedProperty, CreateConnectionRequestFoundryWorker, CreateConnectionRequestJdbcConnectionConfiguration, CreateConnectionRequestOauthMachineToMachineAuth, CreateConnectionRequestPersonalAccessToken, CreateConnectionRequestRestConnectionAdditionalSecrets, CreateConnectionRequestRestConnectionConfiguration, CreateConnectionRequestS3AuthenticationMode, CreateConnectionRequestS3ConnectionConfiguration, CreateConnectionRequestS3KmsConfiguration, CreateConnectionRequestS3ProxyConfiguration, CreateConnectionRequestSecretsNames, CreateConnectionRequestSecretsWithPlaintextValues, CreateConnectionRequestSmbAuth, CreateConnectionRequestSmbConnectionConfiguration, CreateConnectionRequestSmbProxyConfiguration, CreateConnectionRequestSmbUsernamePasswordAuth, CreateConnectionRequestSnowflakeAuthenticationMode, CreateConnectionRequestSnowflakeConnectionConfiguration, CreateConnectionRequestSnowflakeExternalOauth, CreateConnectionRequestSnowflakeKeyPairAuthentication, CreateConnectionRequestStsRoleConfiguration, CreateConnectionRequestUnknownWorker, CreateConnectionRequestWorkflowIdentityFederation, CreateFileImportRequest, CreateTableImportRequest, CreateTableImportRequestDatabricksTableImportConfig, CreateTableImportRequestDateColumnInitialIncrementalState, CreateTableImportRequestDecimalColumnInitialIncrementalState, CreateTableImportRequestIntegerColumnInitialIncrementalState, CreateTableImportRequestJdbcTableImportConfig, CreateTableImportRequestLongColumnInitialIncrementalState, CreateTableImportRequestMicrosoftAccessTableImportConfig, CreateTableImportRequestMicrosoftSqlServerTableImportConfig, CreateTableImportRequestOracleTableImportConfig, CreateTableImportRequestPostgreSqlTableImportConfig, CreateTableImportRequestSnowflakeTableImportConfig, CreateTableImportRequestStringColumnInitialIncrementalState, CreateTableImportRequestTableImportConfig, CreateTableImportRequestTableImportInitialIncrementalState, CreateTableImportRequestTimestampColumnInitialIncrementalState, CreateVirtualTableRequest, DatabricksAuthenticationMode, DatabricksConnectionConfiguration, DatabricksTableImportConfig, DateColumnInitialIncrementalState, DecimalColumnInitialIncrementalState, DeltaVirtualTableConfig, Domain, EncryptedProperty, FileAnyPathMatchesFilter, FileAtLeastCountFilter, FileChangedSinceLastUploadFilter, FileFormat, FileImport, FileImportCustomFilter, FileImportDisplayName, FileImportFilter, FileImportMode, FileImportRid, FileLastModifiedAfterFilter, FilePathMatchesFilter, FilePathNotMatchesFilter, FileProperty, FilesCountLimitFilter, FileSizeFilter, FilesVirtualTableConfig, FolderRid_4 as FolderRid, FoundryWorker, GetConfigurationConnectionsBatchRequestElement, GetConfigurationConnectionsBatchResponse, GlueVirtualTableConfig, HeaderApiKey, IcebergVirtualTableConfig, IntegerColumnInitialIncrementalState, InvalidConnectionReason, InvalidTableReason, JdbcConnectionConfiguration, JdbcDriverArtifactName, JdbcProperties, JdbcTableImportConfig, ListFileImportsResponse, ListTableImportsResponse, LongColumnInitialIncrementalState, MarkingId_4 as MarkingId, MicrosoftAccessTableImportConfig, MicrosoftSqlServerTableImportConfig, OauthMachineToMachineAuth, OracleTableImportConfig, PersonalAccessToken, PlaintextValue, PostgreSqlTableImportConfig, Protocol, QueryParameterApiKey, Region, ReplaceFileImportRequest, ReplaceTableImportRequest, ReplaceTableImportRequestDatabricksTableImportConfig, ReplaceTableImportRequestDateColumnInitialIncrementalState, ReplaceTableImportRequestDecimalColumnInitialIncrementalState, ReplaceTableImportRequestIntegerColumnInitialIncrementalState, ReplaceTableImportRequestJdbcTableImportConfig, ReplaceTableImportRequestLongColumnInitialIncrementalState, ReplaceTableImportRequestMicrosoftAccessTableImportConfig, ReplaceTableImportRequestMicrosoftSqlServerTableImportConfig, ReplaceTableImportRequestOracleTableImportConfig, ReplaceTableImportRequestPostgreSqlTableImportConfig, ReplaceTableImportRequestSnowflakeTableImportConfig, ReplaceTableImportRequestStringColumnInitialIncrementalState, ReplaceTableImportRequestTableImportConfig, ReplaceTableImportRequestTableImportInitialIncrementalState, ReplaceTableImportRequestTimestampColumnInitialIncrementalState, RestAuthenticationMode, RestConnectionAdditionalSecrets, RestConnectionConfiguration, RestConnectionOAuth2, RestRequestApiKeyLocation, S3AuthenticationMode, S3ConnectionConfiguration, S3KmsConfiguration, S3ProxyConfiguration, SecretName, SecretsNames, SecretsWithPlaintextValues, SmbAuth, SmbConnectionConfiguration, SmbProxyConfiguration, SmbProxyType, SmbUsernamePasswordAuth, SnowflakeAuthenticationMode, SnowflakeConnectionConfiguration, SnowflakeExternalOauth, SnowflakeKeyPairAuthentication, SnowflakeTableImportConfig, SnowflakeVirtualTableConfig, StringColumnInitialIncrementalState, StsRoleConfiguration, TableImport, TableImportAllowSchemaChanges, TableImportConfig, TableImportDisplayName, TableImportInitialIncrementalState, TableImportMode, TableImportQuery, TableImportRid, TableName, TableRid_3 as TableRid, TimestampColumnInitialIncrementalState, UnityVirtualTableConfig, UnknownWorker, UpdateExportSettingsForConnectionRequest, UpdateSecretsForConnectionRequest, UriScheme, VirtualTable, VirtualTableConfig, WorkflowIdentityFederation } } /** * An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became stale. Retrying the request typically resolves this. * * Log Safety: SAFE */ declare interface ConsistentSnapshotError { errorCode: "CONFLICT"; errorName: "ConsistentSnapshotError"; errorDescription: "An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became stale. Retrying the request typically resolves this."; errorInstanceId: string; parameters: {}; } /** * The query failed because the Ontology snapshot used for consistent reads became stale. Retrying the request typically resolves this. * * Log Safety: UNSAFE */ declare interface ConsistentSnapshotError_2 { errorCode: "CONFLICT"; errorName: "ConsistentSnapshotError"; errorDescription: "The query failed because the Ontology snapshot used for consistent reads became stale. Retrying the request typically resolves this."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * The conjunctive set of markings for the container of this property value, such as the project of a dataset. These markings may differ from the marking on the actual property value, but still must be satisfied for accessing the property All markings from a conjunctive set must be met for access. * * Log Safety: UNSAFE */ declare type ContainerConjunctiveMarkingSummary = Array; /** * The disjunctive set of markings for the container of this property value, such as the project of a dataset. These markings may differ from the marking on the actual property value, but still must be satisfied for accessing the property All markings from a conjunctive set must be met for access. Disjunctive markings are represented as a conjunctive list of disjunctive sets. The top-level set is a conjunction of sets, where each inner set should be treated as a unit where any marking within the set can satisfy the set. All sets within the top level set should be satisfied. * * Log Safety: UNSAFE */ declare type ContainerDisjunctiveMarkingSummary = Array>; /** * @deprecated Use `ContainsAllTermsInOrderPrefixLastTerm` in the `foundry.ontologies` package * * Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match. * * Log Safety: UNSAFE */ declare interface ContainsAllTermsInOrderPrefixLastTerm { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: string; } /** * Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. The last term can be a partial prefix match. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier can be supplied, but not both. * * Log Safety: UNSAFE */ declare interface ContainsAllTermsInOrderPrefixLastTerm_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: string; } /** * @deprecated Use `ContainsAllTermsInOrderQuery` in the `foundry.ontologies` package * * Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. * * Log Safety: UNSAFE */ declare interface ContainsAllTermsInOrderQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: string; } /** * Returns objects where the specified field contains all of the terms in the order provided, but they do have to be adjacent to each other. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface ContainsAllTermsInOrderQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: string; } /** * @deprecated Use `ContainsAllTermsQuery` in the `foundry.ontologies` package * * Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching. * * Log Safety: UNSAFE */ declare interface ContainsAllTermsQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: string; fuzzy?: FuzzyV2; } /** * Returns objects where the specified field contains all of the whitespace separated words in any order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface ContainsAllTermsQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: string; fuzzy?: FuzzyV2_2; } /** * @deprecated Use `ContainsAnyTermQuery` in the `foundry.ontologies` package * * Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching. * * Log Safety: UNSAFE */ declare interface ContainsAnyTermQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: string; fuzzy?: FuzzyV2; } /** * Returns objects where the specified field contains any of the whitespace separated words in any order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface ContainsAnyTermQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: string; fuzzy?: FuzzyV2_2; } /** * Returns objects where the specified array contains a value. * * Log Safety: UNSAFE */ declare interface ContainsQuery { field: FieldNameV1; value: PropertyValue_2; } /** * @deprecated Use `ContainsQueryV2` in the `foundry.ontologies` package * * Returns objects where the specified array contains a value. * * Log Safety: UNSAFE */ declare interface ContainsQueryV2 { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: PropertyValue; } /** * Returns objects where the specified array contains a value. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface ContainsQueryV2_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: PropertyValue_2; } /** * Log Safety: UNSAFE */ declare interface Content { exchanges: Array; } /** * Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest * view of the default branch - `master` for most enrollments. * * #### Advanced Usage * * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. * To **get a file's content from a specific Branch** specify the Branch's name as `branchName`. This will * retrieve the content for the most recent version of the file since the latest snapshot transaction, or the * earliest ancestor transaction of the branch if there are no snapshot transactions. * To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier * as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest * snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. * To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. * This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the * `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior * is undefined when the start and end transactions do not belong to the same root-to-leaf path. * To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the * `startTransactionRid` and `endTransactionRid`. * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/{datasetRid}/files/{filePath}/content */ declare function content($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, filePath: _Core.FilePath, $queryParams?: { branchName?: _Core.BranchName | undefined; startTransactionRid?: _Datasets_2.TransactionRid | undefined; endTransactionRid?: _Datasets_2.TransactionRid | undefined; } ]): Promise; /** * @public * * Required Scopes: [api:audit-read] * URL: /v2/audit/organizations/{organizationRid}/logFiles/{logFileId}/content */ declare function content_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [organizationRid: _Core.OrganizationRid, logFileId: _Audit.FileId]): Promise; /* Excluded from this release type: content_3 */ /** * Could not content the File. * * Log Safety: SAFE */ declare interface ContentFilePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ContentFilePermissionDenied"; errorDescription: "Could not content the File."; errorInstanceId: string; parameters: { fileRid: unknown; }; } /** * Log Safety: SAFE */ declare type ContentLength = string; /** * The given Content could not be found. * * Log Safety: SAFE */ declare interface ContentNotFound { errorCode: "NOT_FOUND"; errorName: "ContentNotFound"; errorDescription: "The given Content could not be found."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } export declare namespace Contents { export { } } /** * Log Safety: SAFE */ declare type ContentType = LooselyBrandedString<"ContentType">; /** * Failed to generate a response for a session because the context size of the LLM has been exceeded. Clients should either retry with a shorter message or create a new session and try re-sending the message. * * Log Safety: UNSAFE */ declare interface ContextSizeExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "ContextSizeExceededLimit"; errorDescription: "Failed to generate a response for a session because the context size of the LLM has been exceeded. Clients should either retry with a shorter message or create a new session and try re-sending the message."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * Binarize contrast operation. * * Log Safety: SAFE */ declare interface ContrastBinarize { threshold?: number; } /** * Equalizes the histogram of an image to improve contrast. * * Log Safety: SAFE */ declare interface ContrastEqualize { } /** * Applies contrast adjustments to an image. * * Log Safety: UNSAFE */ declare interface ContrastImageOperation { contrastType: ContrastType; } /** * Applies Rayleigh distribution-based contrast adjustment. * * Log Safety: SAFE */ declare interface ContrastRayleigh { sigma: number; } /** * The type of contrast adjustment to apply. * * Log Safety: UNSAFE */ declare type ContrastType = ({ type: "equalize"; } & ContrastEqualize) | ({ type: "rayleigh"; } & ContrastRayleigh) | ({ type: "binarize"; } & ContrastBinarize); /** * Converts audio to the specified format. * * Log Safety: UNSAFE */ declare interface ConvertAudioOperation { encodeFormat: AudioEncodeFormat; } /** * Converts a document to PDF format. * * Log Safety: SAFE */ declare interface ConvertDocumentOperation { } /** * Converts a specified sheet to JSON format. * * Log Safety: UNSAFE */ declare interface ConvertSheetToJsonOperation { sheetName: string; } /** * Log Safety: UNSAFE */ declare type Coordinate = number; /** * The coordinate reference system for geo-referenced imagery. * * Log Safety: UNSAFE */ declare interface CoordinateReferenceSystem { wkt?: string; } export declare namespace Core { export { AndQueryV2, AnyType, ArchiveFileFormat, ArrayFieldType, ArtifactGid, AttachmentType, Attribution, BinaryType_2 as BinaryType, BooleanType, BoundingBoxValue, BranchMetadata, BranchName, BuildRid, ByteType, CenterPoint, CenterPointTypes, ChangeDataCaptureConfiguration, CheckReportRid, CheckRid, CipherTextType, Color, ColumnName, ComputeSeconds, ContainsAllTermsInOrderPrefixLastTerm, ContainsAllTermsInOrderQuery, ContainsAllTermsQuery, ContainsAnyTermQuery, ContainsQueryV2, ContentLength, ContentType, CreatedBy, CreatedTime, CustomMetadata, DatasetFieldSchema, DatasetRid, DatasetSchema, DateType, DecimalType, DisplayName, Distance, DistanceUnit, DoesNotIntersectBoundingBoxQuery, DoesNotIntersectPolygonQuery, DoubleType, Duration, DurationSeconds, EmbeddingModel, EnrollmentRid, EqualsQueryV2, Field, FieldDataType, FieldName, FieldSchema, Filename, FilePath, FilesystemResource, FilterBinaryType, FilterBooleanType, FilterDateTimeType, FilterDateType, FilterDoubleType, FilterEnumType, FilterFloatType, FilterIntegerType, FilterLongType, FilterRidType, FilterStringType, FilterType, FilterUuidType, FloatType, FolderRid, FoundryBranch, FoundryLiveDeployment, FoundryObjectPropertyTypeRid, FoundryObjectTypeRid, FullRowChangeDataCaptureConfiguration, FuzzyV2, GeohashType, GeoPoint_2 as GeoPoint, GeoPointType, GeoShapeType, GeotimeSeriesReferenceType, GroupId, GroupName, GroupRid, GteQueryV2, GtQueryV2, IncludeComputeUsage, InQuery, IntegerType, IntersectsBoundingBoxQuery, IntersectsPolygonQuery, IsNullQueryV2, JobRid, LinkTypeApiName, LmsEmbeddingModel, LmsEmbeddingModelValue, Locale, LocalFilePath, LongType, LteQueryV2, LtQueryV2, MapFieldType, MarkingId, MarkingType, MarkingTypeValue, MediaItemPath, MediaItemReadToken, MediaItemRid, MediaReference, MediaReferenceType, MediaSetRid, MediaSetViewItem, MediaSetViewItemWrapper, MediaSetViewRid, MediaType, NetworkEgressPolicyRid, NotQueryV2, NullType, NumericOrNonNumericType, ObjectRid, ObjectSet, ObjectSetAsBaseObjectTypesType, ObjectSetAsTypeType, ObjectSetBaseType, ObjectSetFilterType, ObjectSetInterfaceBaseType, ObjectSetIntersectionType, ObjectSetMethodInputType, ObjectSetNearestNeighborsType, ObjectSetReferenceType, ObjectSetRid, ObjectSetSearchAroundType, ObjectSetStaticType, ObjectSetSubtractType, ObjectSetUnionType, ObjectSetWithPropertiesType, ObjectTypeId, ObjectTypeRid, OntologyIdentifier, Operation, OperationScope, OrderByDirection, OrganizationRid, OrQueryV2, PageSize, PageToken, PolygonValue, PreviewMode, PrincipalId, PrincipalType, PropertyApiName, PropertyApiNameSelector, PropertyIdentifier, PropertyTypeRid, PropertyValue, Realm, Reference, ReleaseStatus, Role, RoleAssignmentUpdate, RoleContext, RoleId, RoleSetId, ScenarioReferenceType, ScheduleRid, SchemaFieldType, SearchJsonQueryV2, ServiceName, ShortType, SizeBytes, StartsWithQuery, StreamSchema, StringType, StructFieldApiName, StructFieldName, StructFieldSelector, StructFieldType, TableRid, TimeSeriesItemType, TimeseriesType, TimestampType, TimeUnit, TotalCount, TraceParent, TraceState, UnsupportedType, UnsupportedTypeParamKey, UnsupportedTypeParamValue, UpdatedBy, UpdatedTime, UserId, UserStatus, VectorSimilarityFunction, VectorSimilarityFunctionValue, VectorType, VersionId, VoidType, WithinBoundingBoxPoint, WithinBoundingBoxQuery, WithinDistanceOfQuery, WithinPolygonQuery, ZoneId, ApiFeaturePreviewUsageOnly, ApiUsageDenied, BatchRequestSizeExceededLimit, FolderNotFound, FoundryBranchNotFound, InvalidAndFilter, InvalidAttributionHeader, InvalidChangeDataCaptureConfiguration, InvalidFieldSchema, InvalidFilePath, InvalidFilterValue, InvalidOrFilter, InvalidPageSize, InvalidPageToken, InvalidParameterCombination, InvalidSchema, InvalidTimeZone, MissingBatchRequest, MissingPostBody, NotAuthorizedToDeclassifyMarkings, ResourceNameAlreadyExists, SchemaIsNotStreamSchema, UnknownDistanceUnit } } declare namespace _Core { export { AndQueryV2, AnyType, ArchiveFileFormat, ArrayFieldType, ArtifactGid, AttachmentType, Attribution, BinaryType_2 as BinaryType, BooleanType, BoundingBoxValue, BranchMetadata, BranchName, BuildRid, ByteType, CenterPoint, CenterPointTypes, ChangeDataCaptureConfiguration, CheckReportRid, CheckRid, CipherTextType, Color, ColumnName, ComputeSeconds, ContainsAllTermsInOrderPrefixLastTerm, ContainsAllTermsInOrderQuery, ContainsAllTermsQuery, ContainsAnyTermQuery, ContainsQueryV2, ContentLength, ContentType, CreatedBy, CreatedTime, CustomMetadata, DatasetFieldSchema, DatasetRid, DatasetSchema, DateType, DecimalType, DisplayName, Distance, DistanceUnit, DoesNotIntersectBoundingBoxQuery, DoesNotIntersectPolygonQuery, DoubleType, Duration, DurationSeconds, EmbeddingModel, EnrollmentRid, EqualsQueryV2, Field, FieldDataType, FieldName, FieldSchema, Filename, FilePath, FilesystemResource, FilterBinaryType, FilterBooleanType, FilterDateTimeType, FilterDateType, FilterDoubleType, FilterEnumType, FilterFloatType, FilterIntegerType, FilterLongType, FilterRidType, FilterStringType, FilterType, FilterUuidType, FloatType, FolderRid, FoundryBranch, FoundryLiveDeployment, FoundryObjectPropertyTypeRid, FoundryObjectTypeRid, FullRowChangeDataCaptureConfiguration, FuzzyV2, GeohashType, GeoPoint_2 as GeoPoint, GeoPointType, GeoShapeType, GeotimeSeriesReferenceType, GroupId, GroupName, GroupRid, GteQueryV2, GtQueryV2, IncludeComputeUsage, InQuery, IntegerType, IntersectsBoundingBoxQuery, IntersectsPolygonQuery, IsNullQueryV2, JobRid, LinkTypeApiName, LmsEmbeddingModel, LmsEmbeddingModelValue, Locale, LocalFilePath, LongType, LteQueryV2, LtQueryV2, MapFieldType, MarkingId, MarkingType, MarkingTypeValue, MediaItemPath, MediaItemReadToken, MediaItemRid, MediaReference, MediaReferenceType, MediaSetRid, MediaSetViewItem, MediaSetViewItemWrapper, MediaSetViewRid, MediaType, NetworkEgressPolicyRid, NotQueryV2, NullType, NumericOrNonNumericType, ObjectRid, ObjectSet, ObjectSetAsBaseObjectTypesType, ObjectSetAsTypeType, ObjectSetBaseType, ObjectSetFilterType, ObjectSetInterfaceBaseType, ObjectSetIntersectionType, ObjectSetMethodInputType, ObjectSetNearestNeighborsType, ObjectSetReferenceType, ObjectSetRid, ObjectSetSearchAroundType, ObjectSetStaticType, ObjectSetSubtractType, ObjectSetUnionType, ObjectSetWithPropertiesType, ObjectTypeId, ObjectTypeRid, OntologyIdentifier, Operation, OperationScope, OrderByDirection, OrganizationRid, OrQueryV2, PageSize, PageToken, PolygonValue, PreviewMode, PrincipalId, PrincipalType, PropertyApiName, PropertyApiNameSelector, PropertyIdentifier, PropertyTypeRid, PropertyValue, Realm, Reference, ReleaseStatus, Role, RoleAssignmentUpdate, RoleContext, RoleId, RoleSetId, ScenarioReferenceType, ScheduleRid, SchemaFieldType, SearchJsonQueryV2, ServiceName, ShortType, SizeBytes, StartsWithQuery, StreamSchema, StringType, StructFieldApiName, StructFieldName, StructFieldSelector, StructFieldType, TableRid, TimeSeriesItemType, TimeseriesType, TimestampType, TimeUnit, TotalCount, TraceParent, TraceState, UnsupportedType, UnsupportedTypeParamKey, UnsupportedTypeParamValue, UpdatedBy, UpdatedTime, UserId, UserStatus, VectorSimilarityFunction, VectorSimilarityFunctionValue, VectorType, VersionId, VoidType, WithinBoundingBoxPoint, WithinBoundingBoxQuery, WithinDistanceOfQuery, WithinPolygonQuery, ZoneId, ApiFeaturePreviewUsageOnly, ApiUsageDenied, BatchRequestSizeExceededLimit, FolderNotFound, FoundryBranchNotFound, InvalidAndFilter, InvalidAttributionHeader, InvalidChangeDataCaptureConfiguration, InvalidFieldSchema, InvalidFilePath, InvalidFilterValue, InvalidOrFilter, InvalidPageSize, InvalidPageToken, InvalidParameterCombination, InvalidSchema, InvalidTimeZone, MissingBatchRequest, MissingPostBody, NotAuthorizedToDeclassifyMarkings, ResourceNameAlreadyExists, SchemaIsNotStreamSchema, UnknownDistanceUnit } } /* Excluded from this release type: count */ /** * Computes the total count of objects. * * Log Safety: UNSAFE */ declare interface CountAggregation { name?: AggregationMetricName; } /** * Computes the total count of objects. * * Log Safety: UNSAFE */ declare interface CountAggregationV2 { name?: AggregationMetricName; direction?: OrderByDirection_2; } /** * Log Safety: UNSAFE */ declare interface CountObjectsResponseV2 { count?: number; } /** * Creates a new Group. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/groups */ declare function create($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Admin.CreateGroupRequest]): Promise<_Admin.Group>; /** * Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets */ declare function create_10($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Datasets_2.CreateDatasetRequest]): Promise<_Datasets_2.Dataset>; /** * Creates a Transaction on a Branch of a Dataset. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/{datasetRid}/transactions */ declare function create_11($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, $body: _Datasets_2.CreateTransactionRequest, $queryParams?: { branchName?: _Core.BranchName | undefined; } ]): Promise<_Datasets_2.Transaction>; /** * Create a new View. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/views */ declare function create_12($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Datasets_2.CreateViewRequest]): Promise<_Datasets_2.View>; /* Excluded from this release type: create_13 */ /** * Creates a new Connection with a [direct connection](https://www.palantir.com/docs/foundry/data-connection/core-concepts/#direct-connection) runtime. * * Any secrets specified in the request body are transmitted over the network encrypted using TLS. Once the * secrets reach Foundry's servers, they will be temporarily decrypted and remain in plaintext in memory to * be processed as needed. They will stay in plaintext in memory until the garbage collection process cleans * up the memory. The secrets are always stored encrypted on our servers. * By using this endpoint, you acknowledge and accept any potential risks associated with the temporary * in-memory handling of secrets. If you do not want your secrets to be temporarily decrypted, you should * use the Foundry UI instead. * * @public * * Required Scopes: [api:connectivity-connection-write] * URL: /v2/connectivity/connections */ declare function create_14($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Connectivity.CreateConnectionRequest]): Promise<_Connectivity.Connection>; /** * Creates a new FileImport. * * @public * * Required Scopes: [api:connectivity-file-import-write] * URL: /v2/connectivity/connections/{connectionRid}/fileImports */ declare function create_15($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, $body: _Connectivity.CreateFileImportRequest ]): Promise<_Connectivity.FileImport>; /** * Creates a new TableImport. * * @public * * Required Scopes: [api:connectivity-table-import-write] * URL: /v2/connectivity/connections/{connectionRid}/tableImports */ declare function create_16($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, $body: _Connectivity.CreateTableImportRequest ]): Promise<_Connectivity.TableImport>; /** * Creates a new [Virtual Table](https://www.palantir.com/docs/foundry/data-integration/virtual-tables/) from an upstream table. The VirtualTable will be created * in the specified parent folder and can be queried through Foundry's data access APIs. * * @public * * Required Scopes: [api:connectivity-virtual-table-write] * URL: /v2/connectivity/connections/{connectionRid}/virtualTables */ declare function create_17($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, $body: _Connectivity.CreateVirtualTableRequest ]): Promise<_Connectivity.VirtualTable>; /* Excluded from this release type: create_18 */ /** * @public * * Required Scopes: [api:orchestration-write] * URL: /v2/orchestration/builds/create */ declare function create_19($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Orchestration_2.CreateBuildRequest]): Promise<_Orchestration_2.Build>; /** * Creates a new Marking. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/markings */ declare function create_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Admin.CreateMarkingRequest]): Promise<_Admin.Marking>; /* Excluded from this release type: create_20 */ /* Excluded from this release type: create_21 */ /* Excluded from this release type: create_22 */ /* Excluded from this release type: create_23 */ /* Excluded from this release type: create_24 */ /* Excluded from this release type: create_25 */ /* Excluded from this release type: create_26 */ /* Excluded from this release type: create_27 */ /* Excluded from this release type: create_28 */ /* Excluded from this release type: create_29 */ /* Excluded from this release type: create_3 */ /* Excluded from this release type: create_30 */ /* Excluded from this release type: create_31 */ /* Excluded from this release type: create_32 */ /* Excluded from this release type: create_4 */ /** * Creates a new Folder. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/folders */ declare function create_5($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Filesystem_2.CreateFolderRequest]): Promise<_Filesystem_2.Folder>; /** * Creates a new Project. * * Note that third-party applications using this endpoint via OAuth2 cannot be associated with an * Ontology SDK as this will reduce the scope of operations to only those within specified projects. * When creating the application, select "No, I won't use an Ontology SDK" on the Resources page. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/projects/create */ declare function create_6($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Filesystem_2.CreateProjectRequest]): Promise<_Filesystem_2.Project>; /* Excluded from this release type: create_7 */ /* Excluded from this release type: create_8 */ /** * Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/{datasetRid}/branches */ declare function create_9($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [datasetRid: _Core.DatasetRid, $body: _Datasets_2.CreateBranchRequest]): Promise<_Datasets_2.Branch>; /** * The provided token does not have permission to create a branch of this dataset. * * Log Safety: UNSAFE */ declare interface CreateBranchPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateBranchPermissionDenied"; errorDescription: "The provided token does not have permission to create a branch of this dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateBranchRequest { transactionRid?: TransactionRid; name: _Core.BranchName; } /** * Could not create the Build. * * Log Safety: SAFE */ declare interface CreateBuildPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateBuildPermissionDenied"; errorDescription: "Could not create the Build."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateBuildRequest { target: BuildTarget; branchName?: _Core.BranchName; fallbackBranches: FallbackBranches; forceBuild?: ForceBuild; retryCount?: RetryCount; retryBackoffDuration?: RetryBackoffDuration; abortOnFailure?: AbortOnFailure; notificationsEnabled?: NotificationsEnabled; } /** * Could not create the Check. * * Log Safety: SAFE */ declare interface CreateCheckPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateCheckPermissionDenied"; errorDescription: "Could not create the Check."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateCheckRequest { config: CheckConfig; intent?: CheckIntent; } /* Excluded from this release type: createChild */ /** * Request to create a Document as a hidden child of a hidden child of a folder or document. The Document inherits its security from the parent resource and stays in sync as the parent's security changes. * * Log Safety: UNSAFE */ declare interface CreateChildDocumentRequestBody { name: string; description?: string; parentResourceRid: _Filesystem.ResourceRid; documentTypeName: DocumentTypeName; } /** * The provided configuration is invalid. * * Log Safety: UNSAFE */ declare interface CreateConfigValidationError { errorCode: "INVALID_ARGUMENT"; errorName: "CreateConfigValidationError"; errorDescription: "The provided configuration is invalid."; errorInstanceId: string; parameters: { studioRid: unknown; validationFailures: unknown; }; } /** * A specific reason why configuration validation failed. * * Log Safety: UNSAFE */ declare type CreateConfigValidationFailureReason = ({ type: "jsonSchemaValidationFailure"; } & JsonSchemaValidationError) | ({ type: "outputResourceInDifferentProject"; } & OutputResourceInDifferentProjectError) | ({ type: "other"; } & OtherValidationError) | ({ type: "missingWorkerConfigOutput"; } & MissingWorkerConfigOutputError) | ({ type: "missingRequiredDatasetColumn"; } & MissingRequiredDatasetColumnError) | ({ type: "multiplePropertiesNotAllowedForTrainer"; } & MultiplePropertiesNotAllowedForTrainerError) | ({ type: "fieldValidationFailure"; } & FieldValidationError) | ({ type: "unsupportedDatasetFieldType"; } & UnsupportedDatasetFieldTypeError) | ({ type: "changelogTooLong"; } & ChangelogTooLongError) | ({ type: "unknownColumnSpecIdInConfigColumnMapping"; } & UnknownColumnSpecIdInConfigColumnMappingError) | ({ type: "multipleColumnsNotAllowedForTrainer"; } & MultipleColumnsNotAllowedForTrainerError) | ({ type: "missingWorkerConfigInputDatasetColumnMapping"; } & MissingWorkerConfigInputDatasetColumnMappingError) | ({ type: "datasetSchemaNotFound"; } & DatasetSchemaNotFoundError) | ({ type: "invalidWorkerConfigInputType"; } & InvalidWorkerConfigInputTypeError) | ({ type: "missingWorkerConfigInput"; } & MissingWorkerConfigInputError) | ({ type: "missingWorkerConfigInputObjectSetPropertyMapping"; } & MissingWorkerConfigInputObjectSetPropertyMappingError) | ({ type: "outputResourceNotFound"; } & OutputResourceNotFoundError) | ({ type: "invalidResourceConfiguration"; } & InvalidResourceConfigurationError); /** * Could not create the Connection. * * Log Safety: SAFE */ declare interface CreateConnectionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateConnectionPermissionDenied"; errorDescription: "Could not create the Connection."; errorInstanceId: string; parameters: {}; } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequest { parentFolderRid: _Filesystem.FolderRid; configuration: CreateConnectionRequestConnectionConfiguration; displayName: ConnectionDisplayName; worker: CreateConnectionRequestConnectionWorker; } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestAsPlaintextValue { value: PlaintextValue; } /** * Log Safety: UNSAFE */ declare interface CreateConnectionRequestAsSecretName { value: SecretName; } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestAwsAccessKey { accessKeyId: string; secretAccessKey: CreateConnectionRequestEncryptedProperty; } /** * Log Safety: UNSAFE */ declare interface CreateConnectionRequestAwsOidcAuthentication { audience: string; } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestBasicCredentials { password: CreateConnectionRequestEncryptedProperty; username: string; } /** * Log Safety: SAFE */ declare interface CreateConnectionRequestCloudIdentity { cloudIdentityRid: CloudIdentityRid; } /** * Log Safety: DO_NOT_LOG */ declare type CreateConnectionRequestConnectionConfiguration = ({ type: "s3"; } & CreateConnectionRequestS3ConnectionConfiguration) | ({ type: "rest"; } & CreateConnectionRequestRestConnectionConfiguration) | ({ type: "snowflake"; } & CreateConnectionRequestSnowflakeConnectionConfiguration) | ({ type: "databricks"; } & CreateConnectionRequestDatabricksConnectionConfiguration) | ({ type: "smb"; } & CreateConnectionRequestSmbConnectionConfiguration) | ({ type: "jdbc"; } & CreateConnectionRequestJdbcConnectionConfiguration); /** * The worker of a Connection, which defines where compute for capabilities are run. * * Log Safety: SAFE */ declare type CreateConnectionRequestConnectionWorker = ({ type: "unknownWorker"; } & CreateConnectionRequestUnknownWorker) | ({ type: "foundryWorker"; } & CreateConnectionRequestFoundryWorker); /** * The method of authentication for connecting to an external Databricks system. * * Log Safety: DO_NOT_LOG */ declare type CreateConnectionRequestDatabricksAuthenticationMode = ({ type: "workflowIdentityFederation"; } & CreateConnectionRequestWorkflowIdentityFederation) | ({ type: "oauthM2M"; } & CreateConnectionRequestOauthMachineToMachineAuth) | ({ type: "personalAccessToken"; } & CreateConnectionRequestPersonalAccessToken) | ({ type: "basic"; } & CreateConnectionRequestBasicCredentials); /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestDatabricksConnectionConfiguration { hostName: string; httpPath: string; jdbcProperties: JdbcProperties; authentication: CreateConnectionRequestDatabricksAuthenticationMode; } /** * Log Safety: SAFE */ declare interface CreateConnectionRequestDuration { unit: _Core.TimeUnit; value: number; } /** * When reading an encrypted property, the secret name representing the encrypted value will be returned. When writing to an encrypted property: If a plaintext value is passed as an input, the plaintext value will be encrypted and saved to the property. If a secret name is passed as an input, the secret name must match the existing secret name of the property and the property will retain its previously encrypted value. * * Log Safety: DO_NOT_LOG */ declare type CreateConnectionRequestEncryptedProperty = ({ type: "asSecretName"; } & CreateConnectionRequestAsSecretName) | ({ type: "asPlaintextValue"; } & CreateConnectionRequestAsPlaintextValue); /** * Log Safety: SAFE */ declare interface CreateConnectionRequestFoundryWorker { networkEgressPolicyRids: Array<_Core.NetworkEgressPolicyRid>; } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestJdbcConnectionConfiguration { credentials?: BasicCredentials; driverClass: string; jdbcProperties: JdbcProperties; url: string; } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestOauthMachineToMachineAuth { clientID: string; clientSecret: CreateConnectionRequestEncryptedProperty; } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestPersonalAccessToken { personalAccessToken: CreateConnectionRequestEncryptedProperty; } /** * When creating or updating additional secrets, use SecretsWithPlaintextValues. When fetching the RestConnectionConfiguration, SecretsNames will be provided. * * Log Safety: DO_NOT_LOG */ declare type CreateConnectionRequestRestConnectionAdditionalSecrets = ({ type: "asSecretsWithPlaintextValues"; } & CreateConnectionRequestSecretsWithPlaintextValues) | ({ type: "asSecretsNames"; } & CreateConnectionRequestSecretsNames); /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestRestConnectionConfiguration { additionalSecrets?: RestConnectionAdditionalSecrets; oauth2ClientRid?: string; domains: Array; } /** * Log Safety: DO_NOT_LOG */ declare type CreateConnectionRequestS3AuthenticationMode = ({ type: "awsAccessKey"; } & CreateConnectionRequestAwsAccessKey) | ({ type: "cloudIdentity"; } & CreateConnectionRequestCloudIdentity) | ({ type: "oidc"; } & CreateConnectionRequestAwsOidcAuthentication); /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestS3ConnectionConfiguration { connectionTimeoutMillis?: string; maxErrorRetry?: number; bucketUrl: string; clientKmsConfiguration?: S3KmsConfiguration; matchSubfolderExactly?: boolean; stsRoleConfiguration?: StsRoleConfiguration; s3Endpoint?: string; socketTimeoutMillis?: string; enableRequesterPays?: boolean; s3EndpointSigningRegion?: Region; region?: Region; authenticationMode?: S3AuthenticationMode; proxyConfiguration?: S3ProxyConfiguration; maxConnections?: number; } /** * Log Safety: UNSAFE */ declare interface CreateConnectionRequestS3KmsConfiguration { kmsRegion?: Region; kmsKey: string; } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestS3ProxyConfiguration { nonProxyHosts?: Array; protocol?: Protocol; port: number; credentials?: BasicCredentials; host: string; } /** * Log Safety: SAFE */ declare interface CreateConnectionRequestSecretsNames { } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestSecretsWithPlaintextValues { secrets: Record; } /** * Log Safety: DO_NOT_LOG */ declare type CreateConnectionRequestSmbAuth = { type: "usernamePassword"; } & CreateConnectionRequestSmbUsernamePasswordAuth; /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestSmbConnectionConfiguration { proxy?: SmbProxyConfiguration; hostname: string; port?: number; auth: CreateConnectionRequestSmbAuth; share: string; baseDirectory?: string; requireMessageSigning?: boolean; } /** * Log Safety: UNSAFE */ declare interface CreateConnectionRequestSmbProxyConfiguration { hostname: string; protocol: SmbProxyType; port: number; } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestSmbUsernamePasswordAuth { password: CreateConnectionRequestEncryptedProperty; domain?: string; username: string; } /** * Log Safety: DO_NOT_LOG */ declare type CreateConnectionRequestSnowflakeAuthenticationMode = ({ type: "externalOauth"; } & CreateConnectionRequestSnowflakeExternalOauth) | ({ type: "keyPair"; } & CreateConnectionRequestSnowflakeKeyPairAuthentication) | ({ type: "basic"; } & CreateConnectionRequestBasicCredentials); /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestSnowflakeConnectionConfiguration { schema?: string; database?: string; role?: string; accountIdentifier: string; jdbcProperties: JdbcProperties; warehouse?: string; authenticationMode: CreateConnectionRequestSnowflakeAuthenticationMode; } /** * Log Safety: SAFE */ declare interface CreateConnectionRequestSnowflakeExternalOauth { } /** * Log Safety: DO_NOT_LOG */ declare interface CreateConnectionRequestSnowflakeKeyPairAuthentication { privateKey: CreateConnectionRequestEncryptedProperty; user: string; } /** * Log Safety: UNSAFE */ declare interface CreateConnectionRequestStsRoleConfiguration { stsEndpoint?: string; roleArn: string; roleSessionName: string; externalId?: string; roleSessionDuration?: _Core.Duration; } /** * Log Safety: SAFE */ declare interface CreateConnectionRequestUnknownWorker { } /** * Log Safety: UNSAFE */ declare interface CreateConnectionRequestWorkflowIdentityFederation { audience: string; servicePrincipalApplicationId?: string; } /** * The provided token does not have permission to create a dataset in this folder. * * Log Safety: UNSAFE */ declare interface CreateDatasetPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateDatasetPermissionDenied"; errorDescription: "The provided token does not have permission to create a dataset in this folder."; errorInstanceId: string; parameters: { parentFolderRid: unknown; name: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateDatasetRequest { parentFolderRid: _Filesystem.FolderRid; name: DatasetName; } /** * The Foundry user who created this resource * * Log Safety: SAFE */ declare type CreatedBy = PrincipalId; /** * Could not createChild the Document. * * Log Safety: SAFE */ declare interface CreateDocumentAsChildPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateDocumentAsChildPermissionDenied"; errorDescription: "Could not createChild the Document."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateDocumentAsChildRequest { requestBody: CreateChildDocumentRequestBody; } /** * Request to create a Document whose security is a one-time copy of a source Document's directly-applied markings. The new Document's security is independent of the source's afterward. * * Log Safety: UNSAFE */ declare interface CreateDocumentMatchingSecurityRequestBody { name: string; description?: string; sourceDocumentRid: DocumentRid_2; documentTypeName: DocumentTypeName; destinationFolderRid?: _Filesystem.FolderRid; } /** * The user does not have permission to create documents of this Document Type. * * Log Safety: UNSAFE */ declare interface CreateDocumentOfTypePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateDocumentOfTypePermissionDenied"; errorDescription: "The user does not have permission to create documents of this Document Type."; errorInstanceId: string; parameters: { documentTypeName: unknown; }; } /** * The user does not have permission to create a Document in the specified folder. * * Log Safety: SAFE */ declare interface CreateDocumentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateDocumentPermissionDenied"; errorDescription: "The user does not have permission to create a Document in the specified folder."; errorInstanceId: string; parameters: { parentFolderRid: unknown; }; } /** * Could not create the Document. * * Log Safety: SAFE */ declare interface CreateDocumentPermissionDenied_2 { errorCode: "PERMISSION_DENIED"; errorName: "CreateDocumentPermissionDenied"; errorDescription: "Could not create the Document."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateDocumentRequest { parentFolderRid?: _Filesystem.FolderRid; security: DocumentSecurity; ontologyRid: DocumentOntologyRid; name: DocumentName; description?: string; documentTypeName: DocumentTypeName; } /** * Could not create the DocumentType. * * Log Safety: SAFE */ declare interface CreateDocumentTypePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateDocumentTypePermissionDenied"; errorDescription: "Could not create the DocumentType."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateDocumentTypeRequest { parentFolderRid: _Filesystem.FolderRid; schema: DocumentTypeSchema; name: DocumentTypeName; fileSystemType?: FileSystemType; } /** * Could not createV2 the Document. * * Log Safety: SAFE */ declare interface CreateDocumentV2PermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateDocumentV2PermissionDenied"; errorDescription: "Could not createV2 the Document."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateDocumentV2Request { requestBody: CreateDocumentV2RequestBody; } /** * Request to create a PACK Document. * * Log Safety: UNSAFE */ declare interface CreateDocumentV2RequestBody { name: string; description?: string; documentTypeName: DocumentTypeName; security: DocumentSecurity; parent: DocumentParent; } /** * Could not createMatchingSecurity the Document. * * Log Safety: SAFE */ declare interface CreateDocumentWithMatchingSecurityPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateDocumentWithMatchingSecurityPermissionDenied"; errorDescription: "Could not createMatchingSecurity the Document."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateDocumentWithMatchingSecurityRequest { requestBody: CreateDocumentMatchingSecurityRequestBody; } /** * The time at which the resource was created. * * Log Safety: SAFE */ declare type CreatedTime = string; /** * Log Safety: UNSAFE */ declare interface CreateEdit { properties: Record; } /** * Could not create the ExportJob. * * Log Safety: SAFE */ declare interface CreateExportJobPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateExportJobPermissionDenied"; errorDescription: "Could not create the ExportJob."; errorInstanceId: string; parameters: {}; } /** * Log Safety: SAFE */ declare interface CreateExportJobRequest { exportJobSource: ExportJobSource; exportJobTarget: ExportJobTarget; } /** * Could not create the FileImport. * * Log Safety: SAFE */ declare interface CreateFileImportPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateFileImportPermissionDenied"; errorDescription: "Could not create the FileImport."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateFileImportRequest { datasetRid: _Core.DatasetRid; importMode: FileImportMode; displayName: FileImportDisplayName; branchName?: _Core.BranchName; subfolder?: string; fileImportFilters: Array; } /* Excluded from this release type: createFirstParty */ /** * Could not createFirstParty the DocumentType. * * Log Safety: SAFE */ declare interface CreateFirstPartyDocumentTypePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateFirstPartyDocumentTypePermissionDenied"; errorDescription: "Could not createFirstParty the DocumentType."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateFirstPartyDocumentTypeRequest { requestBody: CreateFirstPartyDocumentTypeRequestBody; } /** * Request to create a first-party document type. * * Log Safety: UNSAFE */ declare interface CreateFirstPartyDocumentTypeRequestBody { name: DocumentTypeName; ontologyRid: string; schema: DocumentTypeSchema; fileSystemType?: FileSystemType; owningApplicationId?: string; version?: SchemaVersion; } /** * Response for creating a first-party document type. * * Log Safety: UNSAFE */ declare interface CreateFirstPartyDocumentTypeResponse { rid: DocumentTypeRid; name: DocumentTypeName; fileSystemType?: FileSystemType; version?: SchemaVersion; owningApplicationId?: string; } /** * The given resource is not a folder. * * Log Safety: SAFE */ declare interface CreateFolderOutsideProjectNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "CreateFolderOutsideProjectNotSupported"; errorDescription: "The given resource is not a folder."; errorInstanceId: string; parameters: { parentFolderRid: unknown; }; } /** * Could not create the Folder. * * Log Safety: SAFE */ declare interface CreateFolderPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateFolderPermissionDenied"; errorDescription: "Could not create the Folder."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateFolderRequest { parentFolderRid: FolderRid_2; displayName: ResourceDisplayName; } /** * Creates a project from a project template. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/projects/createFromTemplate */ declare function createFromTemplate($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Filesystem_2.CreateProjectFromTemplateRequest]): Promise<_Filesystem_2.Project>; /** * Could not create the Group. * * Log Safety: SAFE */ declare interface CreateGroupPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateGroupPermissionDenied"; errorDescription: "Could not create the Group."; errorInstanceId: string; parameters: {}; } /** * The user is not authorized to create the group in the organization required to create the project from template. * * Log Safety: SAFE */ declare interface CreateGroupPermissionDenied_2 { errorCode: "PERMISSION_DENIED"; errorName: "CreateGroupPermissionDenied"; errorDescription: "The user is not authorized to create the group in the organization required to create the project from template."; errorInstanceId: string; parameters: { organizationsWithoutPermission: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateGroupRequest { name: GroupName_2; organizations: Array<_Core.OrganizationRid>; description?: string; attributes: Record; } /** * Log Safety: UNSAFE */ declare interface CreateInterfaceLinkLogicRule { interfaceTypeApiName: InterfaceTypeApiName; interfaceLinkTypeApiName: InterfaceLinkTypeApiName; sourceObject: ParameterId_2; targetObject: ParameterId_2; } /** * Log Safety: UNSAFE */ declare interface CreateInterfaceLogicRule { interfaceTypeApiName: InterfaceTypeApiName; objectType: ParameterId_2; sharedPropertyArguments: Record; structPropertyArguments: Record>; } /** * Log Safety: UNSAFE */ declare interface CreateInterfaceObjectRule { interfaceTypeApiName: InterfaceTypeApiName; } /** * Log Safety: UNSAFE */ declare interface CreateLinkLogicRule { linkTypeApiName: LinkTypeApiName_2; sourceObject: ParameterId_2; targetObject: ParameterId_2; } /** * Log Safety: UNSAFE */ declare interface CreateLinkRule { linkTypeApiNameAtoB: LinkTypeApiName_2; linkTypeApiNameBtoA: LinkTypeApiName_2; aSideObjectTypeApiName: ObjectTypeApiName; bSideObjectTypeApiName: ObjectTypeApiName; } /** * Could not create the LiveDeployment. * * Log Safety: SAFE */ declare interface CreateLiveDeploymentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateLiveDeploymentPermissionDenied"; errorDescription: "Could not create the LiveDeployment."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateLiveDeploymentRequest { deploymentType: CreateLiveDeploymentTarget; runtimeConfiguration: LiveDeploymentRuntimeConfiguration; } /** * The target model source for the live deployment. Determines which model and version selection strategy to use when creating the deployment. * * Log Safety: UNSAFE */ declare type CreateLiveDeploymentTarget = { type: "direct"; } & DirectCreateLiveDeploymentTarget; /** * At least one ADMINISTER role assignment must be provided when creating a marking category. * * Log Safety: SAFE */ declare interface CreateMarkingCategoryMissingInitialAdminRole { errorCode: "INVALID_ARGUMENT"; errorName: "CreateMarkingCategoryMissingInitialAdminRole"; errorDescription: "At least one ADMINISTER role assignment must be provided when creating a marking category."; errorInstanceId: string; parameters: {}; } /** * At least one organization must be provided when creating a marking category. * * Log Safety: SAFE */ declare interface CreateMarkingCategoryMissingOrganization { errorCode: "INVALID_ARGUMENT"; errorName: "CreateMarkingCategoryMissingOrganization"; errorDescription: "At least one organization must be provided when creating a marking category."; errorInstanceId: string; parameters: {}; } /** * Could not create the MarkingCategory. * * Log Safety: SAFE */ declare interface CreateMarkingCategoryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateMarkingCategoryPermissionDenied"; errorDescription: "Could not create the MarkingCategory."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateMarkingCategoryRequest { initialPermissions: MarkingCategoryPermissions; name: MarkingCategoryName; description: MarkingCategoryDescription; } /** * At least one ADMINISTER role assignment must be provided when creating a marking. * * Log Safety: SAFE */ declare interface CreateMarkingMissingInitialAdminRole { errorCode: "INVALID_ARGUMENT"; errorName: "CreateMarkingMissingInitialAdminRole"; errorDescription: "At least one ADMINISTER role assignment must be provided when creating a marking."; errorInstanceId: string; parameters: {}; } /** * Could not create the Marking. * * Log Safety: SAFE */ declare interface CreateMarkingPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateMarkingPermissionDenied"; errorDescription: "Could not create the Marking."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateMarkingRequest { initialRoleAssignments: Array; initialMembers: Array<_Core.PrincipalId>; name: MarkingName; description?: string; categoryId: MarkingCategoryId; } /* Excluded from this release type: createMatchingSecurity */ /** * Could not create the ModelFunction. * * Log Safety: SAFE */ declare interface CreateModelFunctionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateModelFunctionPermissionDenied"; errorDescription: "Could not create the ModelFunction."; errorInstanceId: string; parameters: { modelRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateModelFunctionRequest { apiName: ModelFunctionApiName; ontologyBinding?: _Ontologies.OntologyRid; isRowWise: ModelFunctionIsRowWise; displayName: ModelFunctionDisplayName; } /** * Could not create the Model. * * Log Safety: SAFE */ declare interface CreateModelPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateModelPermissionDenied"; errorDescription: "Could not create the Model."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateModelRequest { name: ModelName; parentFolderRid: _Filesystem.FolderRid; } /** * Could not create the ModelStudioConfigVersion. * * Log Safety: SAFE */ declare interface CreateModelStudioConfigVersionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateModelStudioConfigVersionPermissionDenied"; errorDescription: "Could not create the ModelStudioConfigVersion."; errorInstanceId: string; parameters: { modelStudioRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateModelStudioConfigVersionRequest { name: ModelStudioConfigVersionName; resources: ResourceConfiguration; changelog?: string; workerConfig: ModelStudioWorkerConfig; trainerId: TrainerId; } /** * Permission denied to create a Model Studio. * * Log Safety: SAFE */ declare interface CreateModelStudioPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateModelStudioPermissionDenied"; errorDescription: "Permission denied to create a Model Studio."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateModelStudioRequest { name: string; parentFolderRid: _Filesystem.FolderRid; } /** * Could not create the ModelVersion. * * Log Safety: SAFE */ declare interface CreateModelVersionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateModelVersionPermissionDenied"; errorDescription: "Could not create the ModelVersion."; errorInstanceId: string; parameters: { modelRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateModelVersionRequest { modelFiles: ModelFiles; backingRepositories: Array; condaRequirements: Array; modelApi: ModelApi; } /** * Log Safety: UNSAFE */ declare interface CreateObjectLogicRule { objectTypeApiName: ObjectTypeApiName; propertyArguments: Record; structPropertyArguments: Record>; } /** * Log Safety: UNSAFE */ declare interface CreateObjectRule { objectTypeApiName: ObjectTypeApiName; } /** * The request payload for creating an ontology scenario. * * Log Safety: UNSAFE */ declare interface CreateOntologyScenarioRequest { base?: OntologyBase; } /** * The response payload for creating an ontology scenario. * * Log Safety: SAFE */ declare interface CreateOntologyScenarioResponse { scenarioRid: OntologyScenarioRid; } /** * At least one organization:administrator role grant must be provided when creating a organization. * * Log Safety: SAFE */ declare interface CreateOrganizationMissingInitialAdminRole { errorCode: "INVALID_ARGUMENT"; errorName: "CreateOrganizationMissingInitialAdminRole"; errorDescription: "At least one organization:administrator role grant must be provided when creating a organization."; errorInstanceId: string; parameters: {}; } /** * Could not create the Organization. * * Log Safety: SAFE */ declare interface CreateOrganizationPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateOrganizationPermissionDenied"; errorDescription: "Could not create the Organization."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateOrganizationRequest { administrators: Array<_Core.PrincipalId>; enrollmentRid: _Core.EnrollmentRid; name: OrganizationName; host?: HostName; description?: string; } /** * Log Safety: UNSAFE */ declare interface CreateOrModifyObjectLogicRule { objectTypeApiName: ObjectTypeApiName; propertyArguments: Record; structPropertyArguments: Record>; } /** * Log Safety: UNSAFE */ declare interface CreateOrModifyObjectLogicRuleV2 { objectToModify: ParameterId_2; propertyArguments: Record; structPropertyArguments: Record>; } /** * Converts an image to a PDF document. * * Log Safety: SAFE */ declare interface CreatePdfOperation { } /** * Could not createFromTemplate the Project. * * Log Safety: SAFE */ declare interface CreateProjectFromTemplatePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateProjectFromTemplatePermissionDenied"; errorDescription: "Could not createFromTemplate the Project."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateProjectFromTemplateRequest { templateRid: ProjectTemplateRid; variableValues: Record; defaultRoles?: Array<_Core.RoleId>; organizationRids?: Array<_Core.OrganizationRid>; projectDescription?: string; } /** * The create project request would create a project with no principal being granted an owner-like role. As a result, there would be no user with administrative privileges over the project. A role is defined to be owner-like if it has the compass:edit-project operation. In the common case of the default role-set, this is just the compass:manage role. * * Log Safety: SAFE */ declare interface CreateProjectNoOwnerLikeRoleGrant { errorCode: "INVALID_ARGUMENT"; errorName: "CreateProjectNoOwnerLikeRoleGrant"; errorDescription: "The create project request would create a project with no principal being granted an owner-like role. As a result, there would be no user with administrative privileges over the project. A role is defined to be owner-like if it has the compass:edit-project operation. In the common case of the default role-set, this is just the compass:manage role."; errorInstanceId: string; parameters: { grantedRoleIds: unknown; roleSetOwnerLikeRoleIds: unknown; }; } /** * Could not create the Project. * * Log Safety: SAFE */ declare interface CreateProjectPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateProjectPermissionDenied"; errorDescription: "Could not create the Project."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateProjectRequest { displayName: ResourceDisplayName; description?: string; spaceRid: SpaceRid; roleGrants: Record<_Core.RoleId, Array>; defaultRoles: Array<_Core.RoleId>; organizationRids: Array<_Core.OrganizationRid>; resourceLevelRoleGrantsAllowed?: boolean; } /* Excluded from this release type: createScenario */ /** * Could not create the Schedule. * * Log Safety: SAFE */ declare interface CreateSchedulePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateSchedulePermissionDenied"; errorDescription: "Could not create the Schedule."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateScheduleRequest { displayName?: string; description?: string; action: CreateScheduleRequestAction; trigger?: Trigger; scopeMode?: CreateScheduleRequestScopeMode; } /** * Log Safety: UNSAFE */ declare interface CreateScheduleRequestAction { abortOnFailure?: AbortOnFailure; forceBuild?: ForceBuild; retryBackoffDuration?: RetryBackoffDuration; retryCount?: RetryCount; fallbackBranches?: FallbackBranches; branchName?: _Core.BranchName; notificationsEnabled?: NotificationsEnabled; target: CreateScheduleRequestBuildTarget; } /** * Log Safety: UNSAFE */ declare interface CreateScheduleRequestAndTrigger { triggers: Array; } /** * The targets of the build. * * Log Safety: SAFE */ declare type CreateScheduleRequestBuildTarget = ({ type: "upstream"; } & CreateScheduleRequestUpstreamTarget) | ({ type: "manual"; } & CreateScheduleRequestManualTarget) | ({ type: "connecting"; } & CreateScheduleRequestConnectingTarget); /** * Log Safety: SAFE */ declare interface CreateScheduleRequestConnectingTarget { ignoredRids?: Array; targetRids: Array; inputRids: Array; } /** * Log Safety: UNSAFE */ declare interface CreateScheduleRequestDatasetUpdatedTrigger { datasetRid: _Core.DatasetRid; branchName?: _Core.BranchName; } /** * Log Safety: SAFE */ declare interface CreateScheduleRequestDuration { unit: _Core.TimeUnit; value: number; } /** * Log Safety: UNSAFE */ declare interface CreateScheduleRequestJobSucceededTrigger { datasetRid: _Core.DatasetRid; branchName?: _Core.BranchName; } /** * Log Safety: SAFE */ declare interface CreateScheduleRequestManualTarget { targetRids: Array; } /** * Log Safety: SAFE */ declare interface CreateScheduleRequestManualTrigger { } /** * Log Safety: UNSAFE */ declare interface CreateScheduleRequestMediaSetUpdatedTrigger { branchName?: _Core.BranchName; mediaSetRid: _Core.MediaSetRid; } /** * Log Safety: UNSAFE */ declare interface CreateScheduleRequestNewLogicTrigger { datasetRid: _Core.DatasetRid; branchName?: _Core.BranchName; } /** * Log Safety: UNSAFE */ declare interface CreateScheduleRequestOrTrigger { triggers: Array; } /** * Log Safety: SAFE */ declare interface CreateScheduleRequestProjectScope { projectRids: Array<_Filesystem.ProjectRid>; } /** * Log Safety: SAFE */ declare interface CreateScheduleRequestScheduleSucceededTrigger { scheduleRid: _Core.ScheduleRid; } /** * The boundaries for the schedule build. * * Log Safety: SAFE */ declare type CreateScheduleRequestScopeMode = ({ type: "project"; } & CreateScheduleRequestProjectScope) | ({ type: "user"; } & CreateScheduleRequestUserScope); /** * Log Safety: UNSAFE */ declare interface CreateScheduleRequestTableUpdatedTrigger { branchName?: _Core.BranchName; tableRid: _Core.TableRid; } /** * Log Safety: SAFE */ declare interface CreateScheduleRequestTimeTrigger { cronExpression: CronExpression; timeZone?: _Core.ZoneId; } /** * Log Safety: UNSAFE */ declare type CreateScheduleRequestTrigger = ({ type: "jobSucceeded"; } & CreateScheduleRequestJobSucceededTrigger) | ({ type: "or"; } & CreateScheduleRequestOrTrigger) | ({ type: "newLogic"; } & CreateScheduleRequestNewLogicTrigger) | ({ type: "tableUpdated"; } & CreateScheduleRequestTableUpdatedTrigger) | ({ type: "and"; } & CreateScheduleRequestAndTrigger) | ({ type: "datasetUpdated"; } & CreateScheduleRequestDatasetUpdatedTrigger) | ({ type: "scheduleSucceeded"; } & CreateScheduleRequestScheduleSucceededTrigger) | ({ type: "mediaSetUpdated"; } & CreateScheduleRequestMediaSetUpdatedTrigger) | ({ type: "time"; } & CreateScheduleRequestTimeTrigger) | ({ type: "manual"; } & CreateScheduleRequestManualTrigger); /** * Log Safety: SAFE */ declare interface CreateScheduleRequestUpstreamTarget { ignoredRids?: Array; targetRids: Array; } /** * Log Safety: SAFE */ declare interface CreateScheduleRequestUserScope { } /** * Could not create the Session. * * Log Safety: SAFE */ declare interface CreateSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateSessionPermissionDenied"; errorDescription: "Could not create the Session."; errorInstanceId: string; parameters: { agentRid: unknown; }; } /** * Log Safety: SAFE */ declare interface CreateSessionRequest { agentVersion?: AgentVersionString; } /** * Could not create the Space. * * Log Safety: SAFE */ declare interface CreateSpacePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateSpacePermissionDenied"; errorDescription: "Could not create the Space."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateSpaceRequest { enrollmentRid: _Core.EnrollmentRid; usageAccountRid?: UsageAccountRid; fileSystemId?: FileSystemId; displayName: ResourceDisplayName; organizations: Array<_Core.OrganizationRid>; description?: string; deletionPolicyOrganizations: Array<_Core.OrganizationRid>; defaultRoleSetId?: _Core.RoleSetId; } /** * Could not create the Dataset. * * Log Safety: SAFE */ declare interface CreateStreamingDatasetPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateStreamingDatasetPermissionDenied"; errorDescription: "Could not create the Dataset."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateStreamingDatasetRequest { name: _Datasets.DatasetName; parentFolderRid: _Filesystem.FolderRid; schema: _Core.StreamSchema; branchName?: _Core.BranchName; partitionsCount?: PartitionsCount; streamType?: StreamType; compressed?: Compressed; } /** * Could not create the Stream. * * Log Safety: UNSAFE */ declare interface CreateStreamPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateStreamPermissionDenied"; errorDescription: "Could not create the Stream."; errorInstanceId: string; parameters: { datasetRid: unknown; streamBranchName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateStreamRequest { schema: CreateStreamRequestStreamSchema; partitionsCount?: PartitionsCount; streamType?: StreamType; branchName: _Core.BranchName; compressed?: Compressed; } /** * Configuration for utilizing the stream as a change data capture (CDC) dataset. To configure CDC on a stream, at least one key needs to be provided. For more information on CDC in Foundry, see the Change Data Capture user documentation. * * Log Safety: UNSAFE */ declare type CreateStreamRequestChangeDataCaptureConfiguration = { type: "fullRow"; } & CreateStreamRequestFullRowChangeDataCaptureConfiguration; /** * Log Safety: UNSAFE */ declare interface CreateStreamRequestFullRowChangeDataCaptureConfiguration { orderingFieldName: _Core.FieldName; deletionFieldName: _Core.FieldName; } /** * Log Safety: UNSAFE */ declare interface CreateStreamRequestStreamSchema { keyFieldNames?: Array<_Core.FieldName>; fields: Array<_Core.Field>; changeDataCapture?: _Core.ChangeDataCaptureConfiguration; } /** * Could not create the Subscriber. * * Log Safety: UNSAFE */ declare interface CreateSubscriberPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateSubscriberPermissionDenied"; errorDescription: "Could not create the Subscriber."; errorInstanceId: string; parameters: { datasetRid: unknown; subscriberSubscriberId: unknown; streamBranchName: unknown; }; } /** * Log Safety: SAFE */ declare interface CreateSubscriberRequest { subscriberId: SubscriberId; readPosition?: ReadPosition; } /** * Log Safety: SAFE */ declare interface CreateSubscriberRequestEarliestPosition { } /** * Log Safety: SAFE */ declare interface CreateSubscriberRequestLatestPosition { } /** * Position to start reading from when registering a subscriber or resetting offsets. earliest: Start reading from the beginning of each partition (offset 0). Use this to reprocess all historical data in the stream. latest: Start reading from the current end of each partition. Use this to skip historical data and only process new records arriving after registration. specific: Start reading from explicit offsets for each partition. Use this for precise replay scenarios or to resume from a known checkpoint. * * Log Safety: SAFE */ declare type CreateSubscriberRequestReadPosition = ({ type: "specific"; } & CreateSubscriberRequestSpecificPosition) | ({ type: "earliest"; } & CreateSubscriberRequestEarliestPosition) | ({ type: "latest"; } & CreateSubscriberRequestLatestPosition); /** * Log Safety: SAFE */ declare interface CreateSubscriberRequestSpecificPosition { offsets: PartitionOffsets; } /** * Could not create the TableImport. * * Log Safety: SAFE */ declare interface CreateTableImportPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateTableImportPermissionDenied"; errorDescription: "Could not create the TableImport."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequest { datasetRid: _Core.DatasetRid; importMode: TableImportMode; displayName: TableImportDisplayName; allowSchemaChanges?: TableImportAllowSchemaChanges; branchName?: _Core.BranchName; config: CreateTableImportRequestTableImportConfig; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestDatabricksTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestDateColumnInitialIncrementalState { currentValue: string; columnName: string; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestDecimalColumnInitialIncrementalState { currentValue: string; columnName: string; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestIntegerColumnInitialIncrementalState { currentValue: number; columnName: string; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestJdbcTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestLongColumnInitialIncrementalState { currentValue: string; columnName: string; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestMicrosoftAccessTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestMicrosoftSqlServerTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestOracleTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestPostgreSqlTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestSnowflakeTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestStringColumnInitialIncrementalState { currentValue: string; columnName: string; } /** * The import configuration for a specific connector type. * * Log Safety: UNSAFE */ declare type CreateTableImportRequestTableImportConfig = ({ type: "databricksImportConfig"; } & CreateTableImportRequestDatabricksTableImportConfig) | ({ type: "jdbcImportConfig"; } & CreateTableImportRequestJdbcTableImportConfig) | ({ type: "microsoftSqlServerImportConfig"; } & CreateTableImportRequestMicrosoftSqlServerTableImportConfig) | ({ type: "postgreSqlImportConfig"; } & CreateTableImportRequestPostgreSqlTableImportConfig) | ({ type: "microsoftAccessImportConfig"; } & CreateTableImportRequestMicrosoftAccessTableImportConfig) | ({ type: "snowflakeImportConfig"; } & CreateTableImportRequestSnowflakeTableImportConfig) | ({ type: "oracleImportConfig"; } & CreateTableImportRequestOracleTableImportConfig); /** * The incremental configuration for a table import enables append-style transactions from the same table without duplication of data. You must provide a monotonically increasing column such as a timestamp or id and an initial value for this column. An incremental table import will import rows where the value is greater than the largest already imported. You can use the '?' character to reference the incremental state value when constructing your query. Normally this would be used in a WHERE clause or similar filter applied in order to only sync data with an incremental column value larger than the previously observed maximum value stored in the incremental state. * * Log Safety: UNSAFE */ declare type CreateTableImportRequestTableImportInitialIncrementalState = ({ type: "stringColumnInitialIncrementalState"; } & CreateTableImportRequestStringColumnInitialIncrementalState) | ({ type: "dateColumnInitialIncrementalState"; } & CreateTableImportRequestDateColumnInitialIncrementalState) | ({ type: "integerColumnInitialIncrementalState"; } & CreateTableImportRequestIntegerColumnInitialIncrementalState) | ({ type: "timestampColumnInitialIncrementalState"; } & CreateTableImportRequestTimestampColumnInitialIncrementalState) | ({ type: "longColumnInitialIncrementalState"; } & CreateTableImportRequestLongColumnInitialIncrementalState) | ({ type: "decimalColumnInitialIncrementalState"; } & CreateTableImportRequestDecimalColumnInitialIncrementalState); /** * Log Safety: UNSAFE */ declare interface CreateTableImportRequestTimestampColumnInitialIncrementalState { currentValue: string; columnName: string; } /* Excluded from this release type: createTemporary */ /** * Log Safety: UNSAFE */ declare interface CreateTemporaryObjectSetRequestV2 { objectSet: ObjectSet_2; } /** * Log Safety: SAFE */ declare interface CreateTemporaryObjectSetResponseV2 { objectSetRid: ObjectSetRid_2; } /** * The provided token does not have permission to create a transaction on this dataset. * * Log Safety: UNSAFE */ declare interface CreateTransactionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateTransactionPermissionDenied"; errorDescription: "The provided token does not have permission to create a transaction on this dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; }; } /** * Log Safety: SAFE */ declare interface CreateTransactionRequest { transactionType: TransactionType; } /* Excluded from this release type: createV2 */ /** * Could not create the View. * * Log Safety: SAFE */ declare interface CreateViewPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateViewPermissionDenied"; errorDescription: "Could not create the View."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface CreateViewRequest { parentFolderRid: _Filesystem.FolderRid; viewName: DatasetName; backingDatasets: Array; branch?: _Core.BranchName; primaryKey?: ViewPrimaryKey; } /** * Could not create the VirtualTable. * * Log Safety: SAFE */ declare interface CreateVirtualTablePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "CreateVirtualTablePermissionDenied"; errorDescription: "Could not create the VirtualTable."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface CreateVirtualTableRequest { markings?: Array<_Core.MarkingId>; parentRid: _Filesystem.FolderRid; name: TableName; config: VirtualTableConfig; } /** * A standard CRON expression with minute, hour, day, month and day of week. * * Log Safety: SAFE */ declare type CronExpression = LooselyBrandedString_16<"CronExpression">; /** * Configuration for table cropping. * * Log Safety: UNSAFE */ declare interface CropConfig { tablePrompt: string; } /** * Crops an image to a rectangular sub-window. * * Log Safety: UNSAFE */ declare interface CropImageOperation { xOffset: number; yOffset: number; width: number; height: number; } /** * Represents the current time argument in a logic rule. * * Log Safety: SAFE */ declare interface CurrentTimeArgument { } /** * Represents the current user argument in a logic rule. * * Log Safety: SAFE */ declare interface CurrentUserArgument { } /** * Log Safety: UNSAFE */ declare type CustomMetadata = Record; /** * Log Safety: UNSAFE */ declare interface CustomPresenceEvent { userId: _Core.UserId; clientId: ClientId; eventData: any; eventType: string; schemaVersion?: SchemaVersion; isEphemeral?: boolean; } /** * A UUID representing a custom type in a given Function. * * Log Safety: SAFE */ declare type CustomTypeId = LooselyBrandedString_5<"CustomTypeId">; /** * The method of authentication for connecting to an external Databricks system. * * Log Safety: DO_NOT_LOG */ declare type DatabricksAuthenticationMode = ({ type: "workflowIdentityFederation"; } & WorkflowIdentityFederation) | ({ type: "oauthM2M"; } & OauthMachineToMachineAuth) | ({ type: "personalAccessToken"; } & PersonalAccessToken) | ({ type: "basic"; } & BasicCredentials); /** * The configuration needed to connect to a Databricks external system. Refer to the official Databricks documentation for more information on how to obtain connection details for your system. * * Log Safety: DO_NOT_LOG */ declare interface DatabricksConnectionConfiguration { hostName: string; httpPath: string; authentication: DatabricksAuthenticationMode; jdbcProperties: JdbcProperties; } /** * The table import configuration for a Databricks connection. * * Log Safety: UNSAFE */ declare interface DatabricksTableImportConfig { query: TableImportQuery; initialIncrementalState?: TableImportInitialIncrementalState; } /** * The dataframe reader used for reading the dataset schema. * * Log Safety: SAFE */ declare type DataframeReader = "AVRO" | "CSV" | "PARQUET" | "DATASOURCE"; export declare namespace DataHealth { export { AllowedColumnValuesCheckConfig, ApproximateUniquePercentageCheckConfig, BooleanColumnValue, BranchName_3 as BranchName, BuildDurationCheckConfig, BuildStatusCheckConfig, Check, CheckConfig, CheckGroupRid, CheckIntent, CheckReport, CheckReportLimit, CheckResult, CheckResultStatus, ColumnCountConfig, ColumnInfo, ColumnName_3 as ColumnName, ColumnTypeCheckConfig, ColumnTypeConfig, ColumnValue, CreateCheckRequest, DatasetRid_3 as DatasetRid, DatasetSubject, DateBounds, DateBoundsConfig, DateColumnRangeCheckConfig, DateColumnValue, EscalationConfig, GetLatestCheckReportsResponse, IgnoreEmptyTransactions, JobDurationCheckConfig, JobStatusCheckConfig, MedianDeviation, MedianDeviationBoundsType, MedianDeviationConfig, NullPercentageCheckConfig, NumericBounds, NumericBoundsConfig, NumericColumnCheckConfig, NumericColumnMeanCheckConfig, NumericColumnMedianCheckConfig, NumericColumnRangeCheckConfig, NumericColumnValue, PercentageBounds, PercentageBoundsConfig, PercentageCheckConfig, PercentageValue, PrimaryKeyCheckConfig, PrimaryKeyConfig, ReplaceAllowedColumnValuesCheckConfig, ReplaceApproximateUniquePercentageCheckConfig, ReplaceBuildDurationCheckConfig, ReplaceBuildStatusCheckConfig, ReplaceCheckConfig, ReplaceCheckRequest, ReplaceColumnTypeCheckConfig, ReplaceColumnTypeConfig, ReplaceDateColumnRangeCheckConfig, ReplaceJobDurationCheckConfig, ReplaceJobStatusCheckConfig, ReplaceNullPercentageCheckConfig, ReplaceNumericColumnCheckConfig, ReplaceNumericColumnMeanCheckConfig, ReplaceNumericColumnMedianCheckConfig, ReplaceNumericColumnRangeCheckConfig, ReplacePercentageCheckConfig, ReplacePrimaryKeyCheckConfig, ReplacePrimaryKeyConfig, ReplaceScheduleDurationCheckConfig, ReplaceScheduleStatusCheckConfig, ReplaceSchemaComparisonCheckConfig, ReplaceTimeSinceLastUpdatedCheckConfig, ReplaceTotalColumnCountCheckConfig, ScheduleDurationCheckConfig, ScheduleRid_2 as ScheduleRid, ScheduleStatusCheckConfig, ScheduleSubject, SchemaComparisonCheckConfig, SchemaComparisonConfig, SchemaComparisonType, SchemaInfo, SeverityLevel, StatusCheckConfig, StringColumnValue, TimeBounds, TimeBoundsConfig, TimeCheckConfig, TimeSinceLastUpdatedCheckConfig, TotalColumnCountCheckConfig, TransactionTimeCheckConfig, TrendConfig, TrendType, CheckAlreadyExists, CheckNotFound, CheckReportLimitAboveMaximum, CheckReportLimitBelowMinimum, CheckReportNotFound, CheckTypeNotSupported, CreateCheckPermissionDenied, DeleteCheckPermissionDenied, GetLatestCheckReportsPermissionDenied, InvalidNumericColumnCheckConfig, InvalidPercentageCheckConfig, InvalidTimeCheckConfig, InvalidTransactionTimeCheckConfig, InvalidTrendConfig, ModifyingCheckTypeNotSupported, PercentageValueAboveMaximum, PercentageValueBelowMinimum, ReplaceCheckPermissionDenied, Checks, CheckReports } } declare namespace _DataHealth { export { AllowedColumnValuesCheckConfig, ApproximateUniquePercentageCheckConfig, BooleanColumnValue, BranchName_3 as BranchName, BuildDurationCheckConfig, BuildStatusCheckConfig, Check, CheckConfig, CheckGroupRid, CheckIntent, CheckReport, CheckReportLimit, CheckResult, CheckResultStatus, ColumnCountConfig, ColumnInfo, ColumnName_3 as ColumnName, ColumnTypeCheckConfig, ColumnTypeConfig, ColumnValue, CreateCheckRequest, DatasetRid_3 as DatasetRid, DatasetSubject, DateBounds, DateBoundsConfig, DateColumnRangeCheckConfig, DateColumnValue, EscalationConfig, GetLatestCheckReportsResponse, IgnoreEmptyTransactions, JobDurationCheckConfig, JobStatusCheckConfig, MedianDeviation, MedianDeviationBoundsType, MedianDeviationConfig, NullPercentageCheckConfig, NumericBounds, NumericBoundsConfig, NumericColumnCheckConfig, NumericColumnMeanCheckConfig, NumericColumnMedianCheckConfig, NumericColumnRangeCheckConfig, NumericColumnValue, PercentageBounds, PercentageBoundsConfig, PercentageCheckConfig, PercentageValue, PrimaryKeyCheckConfig, PrimaryKeyConfig, ReplaceAllowedColumnValuesCheckConfig, ReplaceApproximateUniquePercentageCheckConfig, ReplaceBuildDurationCheckConfig, ReplaceBuildStatusCheckConfig, ReplaceCheckConfig, ReplaceCheckRequest, ReplaceColumnTypeCheckConfig, ReplaceColumnTypeConfig, ReplaceDateColumnRangeCheckConfig, ReplaceJobDurationCheckConfig, ReplaceJobStatusCheckConfig, ReplaceNullPercentageCheckConfig, ReplaceNumericColumnCheckConfig, ReplaceNumericColumnMeanCheckConfig, ReplaceNumericColumnMedianCheckConfig, ReplaceNumericColumnRangeCheckConfig, ReplacePercentageCheckConfig, ReplacePrimaryKeyCheckConfig, ReplacePrimaryKeyConfig, ReplaceScheduleDurationCheckConfig, ReplaceScheduleStatusCheckConfig, ReplaceSchemaComparisonCheckConfig, ReplaceTimeSinceLastUpdatedCheckConfig, ReplaceTotalColumnCountCheckConfig, ScheduleDurationCheckConfig, ScheduleRid_2 as ScheduleRid, ScheduleStatusCheckConfig, ScheduleSubject, SchemaComparisonCheckConfig, SchemaComparisonConfig, SchemaComparisonType, SchemaInfo, SeverityLevel, StatusCheckConfig, StringColumnValue, TimeBounds, TimeBoundsConfig, TimeCheckConfig, TimeSinceLastUpdatedCheckConfig, TotalColumnCountCheckConfig, TransactionTimeCheckConfig, TrendConfig, TrendType, CheckAlreadyExists, CheckNotFound, CheckReportLimitAboveMaximum, CheckReportLimitBelowMinimum, CheckReportNotFound, CheckTypeNotSupported, CreateCheckPermissionDenied, DeleteCheckPermissionDenied, GetLatestCheckReportsPermissionDenied, InvalidNumericColumnCheckConfig, InvalidPercentageCheckConfig, InvalidTimeCheckConfig, InvalidTransactionTimeCheckConfig, InvalidTrendConfig, ModifyingCheckTypeNotSupported, PercentageValueAboveMaximum, PercentageValueBelowMinimum, ReplaceCheckPermissionDenied, Checks, CheckReports } } declare namespace _DataHealth_2 { export { LooselyBrandedString_8 as LooselyBrandedString, AllowedColumnValuesCheckConfig, ApproximateUniquePercentageCheckConfig, BooleanColumnValue, BranchName_3 as BranchName, BuildDurationCheckConfig, BuildStatusCheckConfig, Check, CheckConfig, CheckGroupRid, CheckIntent, CheckReport, CheckReportLimit, CheckResult, CheckResultStatus, ColumnCountConfig, ColumnInfo, ColumnName_3 as ColumnName, ColumnTypeCheckConfig, ColumnTypeConfig, ColumnValue, CreateCheckRequest, DatasetRid_3 as DatasetRid, DatasetSubject, DateBounds, DateBoundsConfig, DateColumnRangeCheckConfig, DateColumnValue, EscalationConfig, GetLatestCheckReportsResponse, IgnoreEmptyTransactions, JobDurationCheckConfig, JobStatusCheckConfig, MedianDeviation, MedianDeviationBoundsType, MedianDeviationConfig, NullPercentageCheckConfig, NumericBounds, NumericBoundsConfig, NumericColumnCheckConfig, NumericColumnMeanCheckConfig, NumericColumnMedianCheckConfig, NumericColumnRangeCheckConfig, NumericColumnValue, PercentageBounds, PercentageBoundsConfig, PercentageCheckConfig, PercentageValue, PrimaryKeyCheckConfig, PrimaryKeyConfig, ReplaceAllowedColumnValuesCheckConfig, ReplaceApproximateUniquePercentageCheckConfig, ReplaceBuildDurationCheckConfig, ReplaceBuildStatusCheckConfig, ReplaceCheckConfig, ReplaceCheckRequest, ReplaceColumnTypeCheckConfig, ReplaceColumnTypeConfig, ReplaceDateColumnRangeCheckConfig, ReplaceJobDurationCheckConfig, ReplaceJobStatusCheckConfig, ReplaceNullPercentageCheckConfig, ReplaceNumericColumnCheckConfig, ReplaceNumericColumnMeanCheckConfig, ReplaceNumericColumnMedianCheckConfig, ReplaceNumericColumnRangeCheckConfig, ReplacePercentageCheckConfig, ReplacePrimaryKeyCheckConfig, ReplacePrimaryKeyConfig, ReplaceScheduleDurationCheckConfig, ReplaceScheduleStatusCheckConfig, ReplaceSchemaComparisonCheckConfig, ReplaceTimeSinceLastUpdatedCheckConfig, ReplaceTotalColumnCountCheckConfig, ScheduleDurationCheckConfig, ScheduleRid_2 as ScheduleRid, ScheduleStatusCheckConfig, ScheduleSubject, SchemaComparisonCheckConfig, SchemaComparisonConfig, SchemaComparisonType, SchemaInfo, SeverityLevel, StatusCheckConfig, StringColumnValue, TimeBounds, TimeBoundsConfig, TimeCheckConfig, TimeSinceLastUpdatedCheckConfig, TotalColumnCountCheckConfig, TransactionTimeCheckConfig, TrendConfig, TrendType } } /** * Log Safety: UNSAFE */ declare interface Dataset { rid: _Core.DatasetRid; name: DatasetName; parentFolderRid: _Filesystem.FolderRid; } /** * Log Safety: UNSAFE */ declare interface Dataset_2 { rid: _Core.DatasetRid; name: _Datasets.DatasetName; parentFolderRid: _Filesystem.FolderRid; } /** * A field in a Foundry dataset. * * Log Safety: UNSAFE */ declare interface DatasetFieldSchema { type: SchemaFieldType; name?: FieldName; nullable: boolean; userDefinedTypeClass?: string; customMetadata?: CustomMetadata; arraySubtype?: DatasetFieldSchema; precision?: number; scale?: number; mapKeyType?: DatasetFieldSchema; mapValueType?: DatasetFieldSchema; subSchemas?: Array; } /** * Dataset input configuration. * * Log Safety: UNSAFE */ declare interface DatasetInput { rid: _Core.DatasetRid; columnMapping: Record>; ignoreColumns: Array<_Core.ColumnName>; selectColumns: Array<_Core.ColumnName>; } /** * Log Safety: SAFE */ declare interface DatasetJobOutput { datasetRid: _Core.DatasetRid; outputTransactionRid?: _Datasets.TransactionRid; } /** * Log Safety: UNSAFE */ declare type DatasetName = LooselyBrandedString_6<"DatasetName">; /** * The requested dataset could not be found, or the client token does not have access to it. * * Log Safety: SAFE */ declare interface DatasetNotFound { errorCode: "NOT_FOUND"; errorName: "DatasetNotFound"; errorDescription: "The requested dataset could not be found, or the client token does not have access to it."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * The dataset does not support being read. * * Log Safety: SAFE */ declare interface DatasetReadNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "DatasetReadNotSupported"; errorDescription: "The dataset does not support being read."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * The Resource Identifier (RID) of a Dataset. * * Log Safety: SAFE */ declare type DatasetRid = LooselyBrandedString<"DatasetRid">; /** * The Resource Identifier (RID) of a Dataset. * * Log Safety: SAFE */ declare type DatasetRid_2 = LooselyBrandedString_6<"DatasetRid">; /** * The Resource Identifier (RID) of a Dataset. * * Log Safety: SAFE */ declare type DatasetRid_3 = LooselyBrandedString_8<"DatasetRid">; /** * The Resource Identifier (RID) of a Dataset. * * Log Safety: SAFE */ declare type DatasetRid_4 = LooselyBrandedString_15<"DatasetRid">; export declare namespace Datasets { export { AddBackingDatasetsRequest, AddPrimaryKeyRequest, Branch, BranchName_2 as BranchName, CreateBranchRequest, CreateDatasetRequest, CreateTransactionRequest, CreateViewRequest, DataframeReader, Dataset, DatasetName, DatasetRid_2 as DatasetRid, File_2 as File, FileUpdatedTime, FolderRid_3 as FolderRid, GetDatasetJobsAndFilter, GetDatasetJobsComparisonType, GetDatasetJobsOrFilter, GetDatasetJobsQuery, GetDatasetJobsRequest, GetDatasetJobsSort, GetDatasetJobsSortDirection, GetDatasetJobsSortType, GetDatasetJobsTimeFilter, GetDatasetJobsTimeFilterField, GetDatasetSchemaResponse, GetHealthCheckReportsResponse, GetJobResponse, GetSchemaDatasetsBatchRequestElement, GetSchemaDatasetsBatchResponse, JobDetails, ListBranchesResponse, ListFilesResponse, ListHealthChecksResponse, ListSchedulesResponse, ListTransactionsOfDatasetResponse, ListTransactionsResponse, MarkingId_3 as MarkingId, PrimaryKeyLatestWinsResolutionStrategy, PrimaryKeyResolutionDuplicate, PrimaryKeyResolutionStrategy, PrimaryKeyResolutionUnique, PutDatasetSchemaRequest, RemoveBackingDatasetsRequest, ReplaceBackingDatasetsRequest, TableExportFormat, Transaction, TransactionCreatedTime, TransactionRid, TransactionStatus, TransactionType, View, ViewBackingDataset, ViewPrimaryKey, ViewPrimaryKeyResolution, AbortTransactionPermissionDenied, AddBackingDatasetsPermissionDenied, AddPrimaryKeyPermissionDenied, BranchAlreadyExists, BranchNotFound, BuildTransactionPermissionDenied, ColumnTypesNotSupported, CommitTransactionPermissionDenied, CreateBranchPermissionDenied, CreateDatasetPermissionDenied, CreateTransactionPermissionDenied, CreateViewPermissionDenied, DatasetNotFound, DatasetReadNotSupported, DatasetViewNotFound, DeleteBranchPermissionDenied, DeleteFilePermissionDenied, DeleteSchemaPermissionDenied, FileAlreadyExists, FileNotFound, FileNotFoundOnBranch, FileNotFoundOnTransactionRange, FileSizeLimitExceeded, GetBranchTransactionHistoryPermissionDenied, GetDatasetHealthCheckReportsPermissionDenied, GetDatasetHealthChecksPermissionDenied, GetDatasetJobsPermissionDenied, GetDatasetSchedulesPermissionDenied, GetDatasetSchemaPermissionDenied, GetFileContentPermissionDenied, InputBackingDatasetNotInOutputViewProject, InvalidBranchName, InvalidTransactionType, InvalidViewBackingDataset, InvalidViewPrimaryKeyColumnType, InvalidViewPrimaryKeyDeletionColumn, JobTransactionPermissionDenied, NotAllColumnsInPrimaryKeyArePresent, OpenTransactionAlreadyExists, PutDatasetSchemaPermissionDenied, PutSchemaPermissionDenied, ReadTableDatasetPermissionDenied, ReadTableError, ReadTableRowLimitExceeded, ReadTableTimeout, RemoveBackingDatasetsPermissionDenied, ReplaceBackingDatasetsPermissionDenied, SchemaNotFound, TransactionNotCommitted, TransactionNotFound, TransactionNotOpen, UploadFilePermissionDenied, ViewDatasetCleanupFailed, ViewNotFound, ViewPrimaryKeyCannotBeModified, ViewPrimaryKeyDeletionColumnNotInDatasetSchema, ViewPrimaryKeyMustContainAtLeastOneColumn, ViewPrimaryKeyRequiresBackingDatasets, Branches, Datasets_2 as Datasets, Files, Transactions, Views } } declare namespace _Datasets { export { AddBackingDatasetsRequest, AddPrimaryKeyRequest, Branch, BranchName_2 as BranchName, CreateBranchRequest, CreateDatasetRequest, CreateTransactionRequest, CreateViewRequest, DataframeReader, Dataset, DatasetName, DatasetRid_2 as DatasetRid, File_2 as File, FileUpdatedTime, FolderRid_3 as FolderRid, GetDatasetJobsAndFilter, GetDatasetJobsComparisonType, GetDatasetJobsOrFilter, GetDatasetJobsQuery, GetDatasetJobsRequest, GetDatasetJobsSort, GetDatasetJobsSortDirection, GetDatasetJobsSortType, GetDatasetJobsTimeFilter, GetDatasetJobsTimeFilterField, GetDatasetSchemaResponse, GetHealthCheckReportsResponse, GetJobResponse, GetSchemaDatasetsBatchRequestElement, GetSchemaDatasetsBatchResponse, JobDetails, ListBranchesResponse, ListFilesResponse, ListHealthChecksResponse, ListSchedulesResponse, ListTransactionsOfDatasetResponse, ListTransactionsResponse, MarkingId_3 as MarkingId, PrimaryKeyLatestWinsResolutionStrategy, PrimaryKeyResolutionDuplicate, PrimaryKeyResolutionStrategy, PrimaryKeyResolutionUnique, PutDatasetSchemaRequest, RemoveBackingDatasetsRequest, ReplaceBackingDatasetsRequest, TableExportFormat, Transaction, TransactionCreatedTime, TransactionRid, TransactionStatus, TransactionType, View, ViewBackingDataset, ViewPrimaryKey, ViewPrimaryKeyResolution, AbortTransactionPermissionDenied, AddBackingDatasetsPermissionDenied, AddPrimaryKeyPermissionDenied, BranchAlreadyExists, BranchNotFound, BuildTransactionPermissionDenied, ColumnTypesNotSupported, CommitTransactionPermissionDenied, CreateBranchPermissionDenied, CreateDatasetPermissionDenied, CreateTransactionPermissionDenied, CreateViewPermissionDenied, DatasetNotFound, DatasetReadNotSupported, DatasetViewNotFound, DeleteBranchPermissionDenied, DeleteFilePermissionDenied, DeleteSchemaPermissionDenied, FileAlreadyExists, FileNotFound, FileNotFoundOnBranch, FileNotFoundOnTransactionRange, FileSizeLimitExceeded, GetBranchTransactionHistoryPermissionDenied, GetDatasetHealthCheckReportsPermissionDenied, GetDatasetHealthChecksPermissionDenied, GetDatasetJobsPermissionDenied, GetDatasetSchedulesPermissionDenied, GetDatasetSchemaPermissionDenied, GetFileContentPermissionDenied, InputBackingDatasetNotInOutputViewProject, InvalidBranchName, InvalidTransactionType, InvalidViewBackingDataset, InvalidViewPrimaryKeyColumnType, InvalidViewPrimaryKeyDeletionColumn, JobTransactionPermissionDenied, NotAllColumnsInPrimaryKeyArePresent, OpenTransactionAlreadyExists, PutDatasetSchemaPermissionDenied, PutSchemaPermissionDenied, ReadTableDatasetPermissionDenied, ReadTableError, ReadTableRowLimitExceeded, ReadTableTimeout, RemoveBackingDatasetsPermissionDenied, ReplaceBackingDatasetsPermissionDenied, SchemaNotFound, TransactionNotCommitted, TransactionNotFound, TransactionNotOpen, UploadFilePermissionDenied, ViewDatasetCleanupFailed, ViewNotFound, ViewPrimaryKeyCannotBeModified, ViewPrimaryKeyDeletionColumnNotInDatasetSchema, ViewPrimaryKeyMustContainAtLeastOneColumn, ViewPrimaryKeyRequiresBackingDatasets, Branches, Datasets_2 as Datasets, Files, Transactions, Views } } export declare namespace Datasets_2 { export { create_10 as create, get_21 as get, getSchedules, readTable, getSchema, getSchemaBatch, putSchema } } declare namespace _Datasets_2 { export { LooselyBrandedString_6 as LooselyBrandedString, AddBackingDatasetsRequest, AddPrimaryKeyRequest, Branch, BranchName_2 as BranchName, CreateBranchRequest, CreateDatasetRequest, CreateTransactionRequest, CreateViewRequest, DataframeReader, Dataset, DatasetName, DatasetRid_2 as DatasetRid, File_2 as File, FileUpdatedTime, FolderRid_3 as FolderRid, GetDatasetJobsAndFilter, GetDatasetJobsComparisonType, GetDatasetJobsOrFilter, GetDatasetJobsQuery, GetDatasetJobsRequest, GetDatasetJobsSort, GetDatasetJobsSortDirection, GetDatasetJobsSortType, GetDatasetJobsTimeFilter, GetDatasetJobsTimeFilterField, GetDatasetSchemaResponse, GetHealthCheckReportsResponse, GetJobResponse, GetSchemaDatasetsBatchRequestElement, GetSchemaDatasetsBatchResponse, JobDetails, ListBranchesResponse, ListFilesResponse, ListHealthChecksResponse, ListSchedulesResponse, ListTransactionsOfDatasetResponse, ListTransactionsResponse, MarkingId_3 as MarkingId, PrimaryKeyLatestWinsResolutionStrategy, PrimaryKeyResolutionDuplicate, PrimaryKeyResolutionStrategy, PrimaryKeyResolutionUnique, PutDatasetSchemaRequest, RemoveBackingDatasetsRequest, ReplaceBackingDatasetsRequest, TableExportFormat, Transaction, TransactionCreatedTime, TransactionRid, TransactionStatus, TransactionType, View, ViewBackingDataset, ViewPrimaryKey, ViewPrimaryKeyResolution } } export declare namespace Datasets_3 { export { } } /** * The schema for a Foundry dataset. Files uploaded to this dataset must match this schema. * * Log Safety: UNSAFE */ declare interface DatasetSchema { fieldSchemaList: Array; } /** * A schema could not be found for the specified dataset. * * Log Safety: SAFE */ declare interface DatasetSchemaNotFoundError { datasetRid: _Core.DatasetRid; } /** * A dataset resource type. * * Log Safety: UNSAFE */ declare interface DatasetSubject { datasetRid: _Core.DatasetRid; branchId: _Core.BranchName; } /** * Trigger whenever a new transaction is committed to the dataset on the target branch. * * Log Safety: UNSAFE */ declare interface DatasetUpdatedTrigger { datasetRid: _Core.DatasetRid; branchName: _Core.BranchName; } /** * The requested dataset view could not be found. A dataset view represents the effective file contents of a dataset for a branch at a point in time, calculated from transactions (SNAPSHOT, APPEND, UPDATE, DELETE). The view may not exist if the dataset has no transactions, contains no files, the branch is not valid, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface DatasetViewNotFound { errorCode: "NOT_FOUND"; errorName: "DatasetViewNotFound"; errorDescription: "The requested dataset view could not be found. A dataset view represents the effective file contents of a dataset for a branch at a point in time, calculated from transactions (SNAPSHOT, APPEND, UPDATE, DELETE). The view may not exist if the dataset has no transactions, contains no files, the branch is not valid, or the client token does not have access to it."; errorInstanceId: string; parameters: { datasetRid: unknown; branch: unknown; }; } /** * The id of a datasource branch. Branch ids are user supplied strings, not RIDs. * * Log Safety: UNSAFE */ declare type DatasourceBranchId = LooselyBrandedString_5<"DatasourceBranchId">; /** * Randomly generated identifier for an object type's datasource. * * Log Safety: SAFE */ declare type DatasourceRid = LooselyBrandedString_5<"DatasourceRid">; /** * The data type of a band. * * Log Safety: SAFE */ declare type DataType = "UNDEFINED" | "BYTE" | "UINT16" | "INT16" | "UINT32" | "INT32" | "FLOAT32" | "FLOAT64" | "COMPLEX_INT16" | "COMPLEX_INT32" | "COMPLEX_FLOAT32" | "COMPLEX_FLOAT64" | "UINT64" | "INT64" | "INT8"; /** * Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. | Type | JSON encoding | Example | |-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| | Array | array | ["alpha", "bravo", "charlie"] | | Attachment | string | "ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e" | | Boolean | boolean | true | | Byte | number | 31 | | CipherText | string | "CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER" | | Date | ISO 8601 extended local date string | "2021-05-01" | | Decimal | string | "2.718281828" | | Double | number | 3.14159265 | | EntrySet | array of JSON objects | [{"key": "EMP1234", "value": "true"}, {"key": "EMP4444", "value": "false"}] | | Float | number | 3.14159265 | | Integer | number | 238940 | | Long | string | "58319870951433" | | Marking | string | "MU" | | Null | null | null | | Object Set | string OR the object set definition | ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z | | Ontology Object Reference | JSON encoding of the object's primary key | 10033123 or "EMP1234" | | Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| {"objectTypeApiName":"Employee", "primaryKeyValue":"EMP1234"} | | Ontology Object Type Reference | string of the object type's api name | "Employee" | | Scenario Reference | string of the scenario RID | "ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48" | | Set | array | ["alpha", "bravo", "charlie"] | | Short | number | 8739 | | String | string | "Call me Ishmael" | | Struct | JSON object | {"name": "John Doe", "age": 42} | | TwoDimensionalAggregation | JSON object | {"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]} | | ThreeDimensionalAggregation | JSON object | {"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]} | | Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" | * * Log Safety: UNSAFE */ declare type DataValue = any; /** * Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. | Type | JSON encoding | Example | |-----------------------------|-------------------------------------------------------|-------------------------------------------------------------------------------| | Array | array | ["alpha", "bravo", "charlie"] | | Attachment | string | "ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e" | | Boolean | boolean | true | | Byte | number | 31 | | Date | ISO 8601 extended local date string | "2021-05-01" | | Decimal | string | "2.718281828" | | Float | number | 3.14159265 | | Double | number | 3.14159265 | | Integer | number | 238940 | | Long | string | "58319870951433" | | Marking | string | "MU" | | Null | null | null | | Set | array | ["alpha", "bravo", "charlie"] | | Short | number | 8739 | | String | string | "Call me Ishmael" | | Struct | JSON object | {"name": "John Doe", "age": 42} | | TwoDimensionalAggregation | JSON object | {"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]} | | ThreeDimensionalAggregation | JSON object | {"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}| | Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" | * * Log Safety: UNSAFE */ declare type DataValue_2 = any; /** * The range of date values a check is expected to be within. * * Log Safety: SAFE */ declare interface DateBounds { lowerBound?: string; upperBound?: string; } /** * Configuration for date bounds check with severity settings. * * Log Safety: SAFE */ declare interface DateBoundsConfig { dateBounds: DateBounds; severity: SeverityLevel; } /** * The state for an incremental table import using a column with a date type. * * Log Safety: UNSAFE */ declare interface DateColumnInitialIncrementalState { columnName: string; currentValue: string; } /** * Checks that values in a date column fall within a specified range. * * Log Safety: UNSAFE */ declare interface DateColumnRangeCheckConfig { subject: DatasetSubject; columnName: ColumnName_3; dateBoundsConfig: DateBoundsConfig; } /** * A date column value. * * Log Safety: UNSAFE */ declare interface DateColumnValue { value: string; } /** * The parameter value must fall within the specified date or timestamp range. * * Log Safety: UNSAFE */ declare interface DatetimeAllowedValues { gt?: ParameterDatetimeValue; gte?: ParameterDatetimeValue; lt?: ParameterDatetimeValue; lte?: ParameterDatetimeValue; } /** * Log Safety: UNSAFE */ declare type DatetimeFormat = ({ type: "stringFormat"; } & DatetimeStringFormat) | ({ type: "localizedFormat"; } & DatetimeLocalizedFormat); /** * Predefined localized formatting options. * * Log Safety: SAFE */ declare interface DatetimeLocalizedFormat { format: DatetimeLocalizedFormatType; } /** * Localized date/time format types. * * Log Safety: SAFE */ declare type DatetimeLocalizedFormatType = "DATE_FORMAT_RELATIVE_TO_NOW" | "DATE_FORMAT_DATE" | "DATE_FORMAT_YEAR_AND_MONTH" | "DATE_FORMAT_DATE_TIME" | "DATE_FORMAT_DATE_TIME_SHORT" | "DATE_FORMAT_TIME" | "DATE_FORMAT_ISO_INSTANT"; /** * A datetime parameter value. * * Log Safety: UNSAFE */ declare interface DatetimeParameter { value: string; } /** * A strictly specified date format pattern. * * Log Safety: SAFE */ declare interface DatetimeStringFormat { pattern: string; } /** * Log Safety: UNSAFE */ declare type DatetimeTimezone = ({ type: "static"; } & DatetimeTimezoneStatic) | ({ type: "user"; } & DatetimeTimezoneUser); /** * Log Safety: UNSAFE */ declare interface DatetimeTimezoneStatic { zoneId: PropertyTypeReferenceOrStringConstant; } /** * The user's local timezone. * * Log Safety: SAFE */ declare interface DatetimeTimezoneUser { } /** * Log Safety: SAFE */ declare interface DateType { } /** * Log Safety: SAFE */ declare interface DateType_2 { } /** * Log Safety: UNSAFE */ declare interface DateValue { value: string; } /** * The state for an incremental table import using a column with a decimal data type. * * Log Safety: UNSAFE */ declare interface DecimalColumnInitialIncrementalState { columnName: string; currentValue: string; } /** * Log Safety: SAFE */ declare interface DecimalColumnType { precision: number; scale: number; } /** * Log Safety: SAFE */ declare interface DecimalType { precision?: number; scale?: number; } /** * Decrypt the value of a ciphertext property. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt */ declare function decrypt($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, property: _Ontologies_2.PropertyApiName, $queryParams?: { branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.DecryptionResult>; /** * Decrypts bounding boxes in an image using a commutative encryption algorithm. * * Log Safety: SAFE */ declare interface DecryptImageOperation { polygons: Array; cipherLicenseRid: string; } /** * The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown. * * Log Safety: DO_NOT_LOG */ declare interface DecryptionResult { plaintext: Plaintext; } /** * Exact match groupBy clause cannot specify a default value and allow null values. * * Log Safety: SAFE */ declare interface DefaultAndNullGroupsNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "DefaultAndNullGroupsNotSupported"; errorDescription: "Exact match groupBy clause cannot specify a default value and allow null values."; errorInstanceId: string; parameters: {}; } /** * The requested default roles are not in the role set of the space for the project template. * * Log Safety: SAFE */ declare interface DefaultRolesNotInSpaceRoleSet { errorCode: "INVALID_ARGUMENT"; errorName: "DefaultRolesNotInSpaceRoleSet"; errorDescription: "The requested default roles are not in the role set of the space for the project template."; errorInstanceId: string; parameters: {}; } /** * Deletes the Branch with the given BranchName. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/{datasetRid}/branches/{branchName} */ declare function deleteBranch($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [datasetRid: _Core.DatasetRid, branchName: _Core.BranchName]): Promise; /** * The provided token does not have permission to delete the given branch from this dataset. * * Log Safety: UNSAFE */ declare interface DeleteBranchPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteBranchPermissionDenied"; errorDescription: "The provided token does not have permission to delete the given branch from this dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; }; } /* Excluded from this release type: deleteCheck */ /** * Could not delete the Check. * * Log Safety: SAFE */ declare interface DeleteCheckPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteCheckPermissionDenied"; errorDescription: "Could not delete the Check."; errorInstanceId: string; parameters: { checkRid: unknown; }; } /* Excluded from this release type: deleteDocument */ /** * Could not delete the Document. * * Log Safety: SAFE */ declare interface DeleteDocumentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteDocumentPermissionDenied"; errorDescription: "Could not delete the Document."; errorInstanceId: string; parameters: { documentId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface DeleteEdit { previousProperties: Record; } /** * Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default * branch - `master` for most enrollments. The file will still be visible on historical views. * * #### Advanced Usage * * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. * To **delete a File from a specific Branch** specify the Branch's name as `branchName`. A new delete Transaction * will be created and committed on this branch. * To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier * as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a * single transaction. See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to * open a transaction. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/{datasetRid}/files/{filePath} */ declare function deleteFile($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, filePath: _Core.FilePath, $queryParams?: { branchName?: _Core.BranchName | undefined; transactionRid?: _Datasets_2.TransactionRid | undefined; } ]): Promise; /** * Delete the FileImport with the specified RID. * Deleting the file import does not delete the destination dataset but the dataset will no longer * be updated by this import. * * @public * * Required Scopes: [api:connectivity-file-import-write] * URL: /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} */ declare function deleteFileImport($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, fileImportRid: _Connectivity.FileImportRid ]): Promise; /** * Could not delete the FileImport. * * Log Safety: SAFE */ declare interface DeleteFileImportPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteFileImportPermissionDenied"; errorDescription: "Could not delete the FileImport."; errorInstanceId: string; parameters: { fileImportRid: unknown; connectionRid: unknown; }; } /** * Could not delete the File. * * Log Safety: UNSAFE */ declare interface DeleteFilePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteFilePermissionDenied"; errorDescription: "Could not delete the File."; errorInstanceId: string; parameters: { datasetRid: unknown; filePath: unknown; }; } /** * Delete the Group with the specified id. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/groups/{groupId} */ declare function deleteGroup($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [groupId: _Core.GroupId]): Promise; /** * Could not delete the Group. * * Log Safety: SAFE */ declare interface DeleteGroupPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteGroupPermissionDenied"; errorDescription: "Could not delete the Group."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface DeleteInterfaceLinkLogicRule { interfaceTypeApiName: InterfaceTypeApiName; interfaceLinkTypeApiName: InterfaceLinkTypeApiName; sourceObject: ParameterId_2; targetObject: ParameterId_2; } /** * Log Safety: UNSAFE */ declare interface DeleteInterfaceObjectRule { interfaceTypeApiName: InterfaceTypeApiName; } /** * Log Safety: UNSAFE */ declare interface DeleteLink { linkTypeApiNameAtoB: LinkTypeApiName_2; linkTypeApiNameBtoA: LinkTypeApiName_2; aSideObject: LinkSideObject; bSideObject: LinkSideObject; } /** * Log Safety: UNSAFE */ declare interface DeleteLinkEdit { objectType: ObjectTypeApiName; primaryKey: PrimaryKeyValue; linkType: LinkTypeApiName_2; linkedObjectPrimaryKey: PrimaryKeyValue; } /** * Log Safety: UNSAFE */ declare interface DeleteLinkLogicRule { linkTypeApiName: LinkTypeApiName_2; sourceObject: ParameterId_2; targetObject: ParameterId_2; } /** * Log Safety: UNSAFE */ declare interface DeleteLinkRule { linkTypeApiNameAtoB: LinkTypeApiName_2; linkTypeApiNameBtoA: LinkTypeApiName_2; aSideObjectTypeApiName: ObjectTypeApiName; bSideObjectTypeApiName: ObjectTypeApiName; } /** * Log Safety: UNSAFE */ declare interface DeleteObject { primaryKey: PropertyValue_2; objectType: ObjectTypeApiName; } /** * Log Safety: UNSAFE */ declare interface DeleteObjectEdit { objectType: ObjectTypeApiName; primaryKey: PropertyValue_2; } /** * Log Safety: UNSAFE */ declare interface DeleteObjectLogicRule { objectToDelete: ParameterId_2; } /** * Log Safety: UNSAFE */ declare interface DeleteObjectRule { objectTypeApiName: ObjectTypeApiName; } /* Excluded from this release type: deleteRelease */ /** * Could not delete the Release. * * Log Safety: UNSAFE */ declare interface DeleteReleasePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteReleasePermissionDenied"; errorDescription: "Could not delete the Release."; errorInstanceId: string; parameters: { widgetSetRid: unknown; releaseVersion: unknown; }; } /** * Move the given resource to the trash. Following this operation, the resource can be restored, using the * `restore` operation, or permanently deleted using the `permanentlyDelete` operation. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/resources/{resourceRid} */ declare function deleteResource($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [resourceRid: _Filesystem_2.ResourceRid]): Promise; /** * Could not delete the Resource. * * Log Safety: UNSAFE */ declare interface DeleteResourcePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteResourcePermissionDenied"; errorDescription: "Could not delete the Resource."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Delete the Schedule with the specified rid. * * @public * * Required Scopes: [api:orchestration-write] * URL: /v2/orchestration/schedules/{scheduleRid} */ declare function deleteSchedule($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [scheduleRid: _Core.ScheduleRid]): Promise; /** * Could not delete the Schedule. * * Log Safety: SAFE */ declare interface DeleteSchedulePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteSchedulePermissionDenied"; errorDescription: "Could not delete the Schedule."; errorInstanceId: string; parameters: { scheduleRid: unknown; }; } /** * todo * * Log Safety: UNSAFE */ declare interface DeleteSchemaPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteSchemaPermissionDenied"; errorDescription: "todo"; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; transactionId: unknown; }; } /* Excluded from this release type: deleteSession */ /** * Could not delete the Session. * * Log Safety: SAFE */ declare interface DeleteSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteSessionPermissionDenied"; errorDescription: "Could not delete the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /* Excluded from this release type: deleteSpace */ /** * Could not delete the Space. * * Log Safety: SAFE */ declare interface DeleteSpacePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteSpacePermissionDenied"; errorDescription: "Could not delete the Space."; errorInstanceId: string; parameters: { spaceRid: unknown; }; } /* Excluded from this release type: deleteSubscriber */ /** * Could not delete the Subscriber. * * Log Safety: UNSAFE */ declare interface DeleteSubscriberPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteSubscriberPermissionDenied"; errorDescription: "Could not delete the Subscriber."; errorInstanceId: string; parameters: { datasetRid: unknown; subscriberSubscriberId: unknown; streamBranchName: unknown; }; } /** * Delete the TableImport with the specified RID. * Deleting the table import does not delete the destination dataset but the dataset will no longer * be updated by this import. * * @public * * Required Scopes: [api:connectivity-table-import-write] * URL: /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid} */ declare function deleteTableImport($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, tableImportRid: _Connectivity.TableImportRid ]): Promise; /** * Could not delete the TableImport. * * Log Safety: SAFE */ declare interface DeleteTableImportPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteTableImportPermissionDenied"; errorDescription: "Could not delete the TableImport."; errorInstanceId: string; parameters: { tableImportRid: unknown; connectionRid: unknown; }; } /** * Delete the User with the specified id. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/users/{userId} */ declare function deleteUser($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [userId: _Core.UserId]): Promise; /** * Could not delete the User. * * Log Safety: SAFE */ declare interface DeleteUserPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteUserPermissionDenied"; errorDescription: "Could not delete the User."; errorInstanceId: string; parameters: { userId: unknown; }; } /** * Delete the Version with the specified version. * * @public * * Required Scopes: [third-party-application:deploy-application-website] * URL: /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} */ declare function deleteVersion($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ thirdPartyApplicationRid: _ThirdPartyApplications.ThirdPartyApplicationRid, versionVersion: _ThirdPartyApplications.VersionVersion ]): Promise; /** * Could not delete the Version. * * Log Safety: UNSAFE */ declare interface DeleteVersionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeleteVersionPermissionDenied"; errorDescription: "Could not delete the Version."; errorInstanceId: string; parameters: { thirdPartyApplicationRid: unknown; versionVersion: unknown; }; } /** * Deletion method type describing whether the resource was trashed (Compass), archived (Artifacts), or hard-deleted. * * Log Safety: SAFE */ declare type DeletionMethod = "TRASHED" | "ARCHIVED" | "HARD_DELETED"; /** * Pointer to the Delta table in cloud object storage (e.g., Azure Data Lake Storage, Google Cloud Storage, S3). * * Log Safety: UNSAFE */ declare interface DeltaVirtualTableConfig { path: string; } /** * Deploy a version of the Website. * * @public * * Required Scopes: [third-party-application:deploy-application-website] * URL: /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy */ declare function deploy($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ thirdPartyApplicationRid: _ThirdPartyApplications.ThirdPartyApplicationRid, $body: _ThirdPartyApplications.DeployWebsiteRequest ]): Promise<_ThirdPartyApplications.Website>; /** * Could not deploy the Website. * * Log Safety: SAFE */ declare interface DeployWebsitePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "DeployWebsitePermissionDenied"; errorDescription: "Could not deploy the Website."; errorInstanceId: string; parameters: { thirdPartyApplicationRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface DeployWebsiteRequest { version: VersionVersion; } /** * This status indicates that the PropertyType is reaching the end of its life and will be removed as per the deadline specified. * * Log Safety: UNSAFE */ declare interface DeprecatedPropertyTypeStatus { message: string; deadline: string; replacedBy?: PropertyTypeRid_2; } /** * The name of the derived property that will be returned. * * Log Safety: UNSAFE */ declare type DerivedPropertyApiName = LooselyBrandedString_5<"DerivedPropertyApiName">; /** * At least one of the requested derived property API names already exist on the object set. * * Log Safety: UNSAFE */ declare interface DerivedPropertyApiNamesNotUnique { errorCode: "INVALID_ARGUMENT"; errorName: "DerivedPropertyApiNamesNotUnique"; errorDescription: "At least one of the requested derived property API names already exist on the object set."; errorInstanceId: string; parameters: { derivedPropertyApiNames: unknown; }; } /** * Definition of a derived property. * * Log Safety: UNSAFE */ declare type DerivedPropertyDefinition = ({ type: "add"; } & AddPropertyExpression) | ({ type: "absoluteValue"; } & AbsoluteValuePropertyExpression) | ({ type: "extract"; } & ExtractPropertyExpression) | ({ type: "selection"; } & SelectedPropertyExpression) | ({ type: "negate"; } & NegatePropertyExpression) | ({ type: "subtract"; } & SubtractPropertyExpression) | ({ type: "property"; } & PropertyApiNameSelector_2) | ({ type: "least"; } & LeastPropertyExpression) | ({ type: "divide"; } & DividePropertyExpression) | ({ type: "multiply"; } & MultiplyPropertyExpression) | ({ type: "greatest"; } & GreatestPropertyExpression); /** * The representation of a time series property backed by a derived time series calculated with a formula. * * Log Safety: UNSAFE */ declare interface DerivedTimeSeriesProperty { templateRid: TimeseriesTemplateRid; templateVersion?: TimeseriesTemplateVersion; } /** * Log Safety: UNSAFE */ declare interface DevModeSettings { status: DevModeStatus; widgetSetSettings: Record; } /** * Log Safety: UNSAFE */ declare interface DevModeSettingsV2 { status: DevModeStatus; snapshot?: DevModeSnapshot; } /** * A content-addressed snapshot of the dev mode settings. Snapshots are immutable and identified by their content-addressed ID. * * Log Safety: UNSAFE */ declare interface DevModeSnapshot { snapshotId: DevModeSnapshotId; widgetSetSettings: Record; } /** * A content-addressed identifier for a dev mode settings snapshot. * * Log Safety: SAFE */ declare type DevModeSnapshotId = LooselyBrandedString_24<"DevModeSnapshotId">; /** * The user's global development mode status for widget sets. * * Log Safety: SAFE */ declare type DevModeStatus = "ENABLED" | "PAUSED" | "DISABLED"; /** * The key of a DICOM data element. * * Log Safety: UNSAFE */ declare type DicomDataElementKey = LooselyBrandedString_14<"DicomDataElementKey">; /** * Metadata for DICOM (Digital Imaging and Communications in Medicine) media items. * * Log Safety: UNSAFE */ declare interface DicomMediaItemMetadata { metaInformation: DicomMetaInformation; mediaType: DicomMediaType; commonDataElements: CommonDicomDataElements; otherDataElements: Record; sizeBytes: number; } /** * The type of DICOM media. * * Log Safety: SAFE */ declare type DicomMediaType = "IMAGE" | "MULTI_FRAME_IMAGE" | "VIDEO" | "STRUCTURED_REPORT"; /** * DICOM meta information. * * Log Safety: UNSAFE */ declare type DicomMetaInformation = { type: "v1"; } & DicomMetaInformationV1; /** * DICOM meta information version 1. * * Log Safety: UNSAFE */ declare interface DicomMetaInformationV1 { mediaStorageSop: string; mediaStorageSopInstance: string; transferSyntax: string; } /** * The operation to perform for DICOM to image conversion. * * Log Safety: UNSAFE */ declare type DicomToImageOperation = { type: "renderImageLayer"; } & RenderImageLayerOperation; /** * Renders DICOM (Digital Imaging and Communications in Medicine) files as images. * * Log Safety: UNSAFE */ declare interface DicomToImageTransformation { encoding: ImageryEncodeFormat; operation: DicomToImageOperation; } /** * Log Safety: UNSAFE */ declare interface DillModelFiles { serializedModelFunction: string; } /** * The dimensions of an image. * * Log Safety: SAFE */ declare interface Dimensions { width: number; height: number; } /** * Creates a live deployment that tracks the latest model version on a branch. * * Log Safety: UNSAFE */ declare interface DirectCreateLiveDeploymentTarget { modelRid: ModelRid; branch: string; } /** * The RID of a direct-write source backing an object type. * * Log Safety: SAFE */ declare type DirectSourceRid = LooselyBrandedString_5<"DirectSourceRid">; /** * Union of all security principals usable within disjunctive security conditions. These principals are used to grant additional role access beyond mandatory security. This includes the special 'all' principal, which grants access to any users who meet mandatory for a given discretionary role. * * Log Safety: SAFE */ declare type DiscretionaryPrincipal = ({ type: "all"; } & AllPrincipal) | ({ type: "groupId"; } & DiscretionaryPrincipalGroupId) | ({ type: "userId"; } & DiscretionaryPrincipalUserId); /** * Log Safety: SAFE */ declare interface DiscretionaryPrincipalGroupId { groupId: _Core.GroupId; } /** * Log Safety: SAFE */ declare interface DiscretionaryPrincipalUserId { userId: _Core.UserId; } /** * Indicates whether a discretionary security update event corresponds to all-principal permissions or user/group-specific permissions. * * Log Safety: SAFE */ declare type DiscretionarySecurityPrincipalType = "ALL_PRINCIPAL" | "USER"; /** * The disjunctive set of markings required to access the property value. Disjunctive markings are represented as a conjunctive list of disjunctive sets. The top-level set is a conjunction of sets, where each inner set should be treated as a unit where any marking within the set can satisfy the set. All sets within the top level set should be satisfied. * * Log Safety: UNSAFE */ declare type DisjunctiveMarkingSummary = Array>; /** * The display name of the entity. * * Log Safety: UNSAFE */ declare type DisplayName = LooselyBrandedString<"DisplayName">; /** * A measurement of distance. * * Log Safety: UNSAFE */ declare interface Distance { value: number; unit: DistanceUnit; } /** * Log Safety: SAFE */ declare type DistanceUnit = "MILLIMETERS" | "CENTIMETERS" | "METERS" | "KILOMETERS" | "INCHES" | "FEET" | "YARDS" | "MILES" | "NAUTICAL_MILES"; /** * An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column. * * Log Safety: SAFE */ declare interface DistinctEnumValuesExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "DistinctEnumValuesExceededLimit"; errorDescription: "An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column."; errorInstanceId: string; parameters: { maxDistinctValues: unknown; }; } /** * Divides the left numeric value by the right numeric value. * * Log Safety: UNSAFE */ declare interface DividePropertyExpression { left: DerivedPropertyDefinition; right: DerivedPropertyDefinition; } /** * Log Safety: SAFE */ declare interface Document_2 { rid: DocumentRid; } /** * Log Safety: UNSAFE */ declare interface Document_3 { id: DocumentRid_2; documentTypeName: DocumentTypeName; ontologyRid: DocumentOntologyRid; name: DocumentName; description?: string; parentFolderRid?: _Filesystem.FolderRid; security: DocumentSecurity; createdBy: _Core.CreatedBy; createdTime: _Core.CreatedTime; updatedBy: _Core.UpdatedBy; updatedTime: _Core.UpdatedTime; operations: Array; operationalVersion?: SchemaVersion; } /** * A request from client to subscribe to a document's activity updates, required on a subscription request to /documents/{documentId}/activity. * * Log Safety: SAFE */ declare interface DocumentActivitySubscriptionRequest { clientId: ClientId; clientSupportedVersionRange: ClientSupportedVersionRange; } /** * Activity event data emitted when a document is created. * * Log Safety: UNSAFE */ declare interface DocumentCreateEventData { initialMandatorySecurity: DocumentMandatorySecurity; name: string; } /** * Versioned event data for custom application-defined activity events. * * Log Safety: UNSAFE */ declare interface DocumentCustomEventData { eventType: string; data: any; version?: number; schemaVersion?: number; } /** * The format of a document media item. * * Log Safety: SAFE */ declare type DocumentDecodeFormat = "PDF" | "DOC" | "DOCX" | "TXT" | "PPTX" | "RTF"; /** * Update broadcast to all clients upon document deletion. Attempting to resubscribe to this document after deletion will fail with permission denied. * * Log Safety: SAFE */ declare interface DocumentDeletionUpdate { deletionMethod: DeletionMethod; } /** * Activity event data emitted when a document's description is updated. * * Log Safety: UNSAFE */ declare interface DocumentDescriptionUpdateEventData { newDescription: string; isInitial: boolean; } /** * Log Safety: SAFE */ declare interface DocumentDiscretionarySecurity { owners: Array; editors: Array; viewers: Array; } /** * Activity event data emitted when a document's discretionary security is updated. A single user action that updates both all-principal and user/group-specific permissions will trigger two separate events, one for each principal type. * * Log Safety: SAFE */ declare interface DocumentDiscretionarySecurityUpdateEventData { principalType: DiscretionarySecurityPrincipalType; previousDiscretionarySecurity?: DocumentDiscretionarySecurity; newDiscretionarySecurity: DocumentDiscretionarySecurity; } /** * Log Safety: UNSAFE */ declare interface DocumentEditDescription { eventData: DocumentCustomEventData; eventType?: string; } /** * The output format for encoding documents. * * Log Safety: UNSAFE */ declare type DocumentEncodeFormat = { type: "pdf"; } & PdfFormat; /** * Extracts content from a document with layout information preserved. * * Log Safety: SAFE */ declare interface DocumentExtractLayoutAwareContentOperation { parameters: LayoutAwareExtractionParameters; } /** * Log Safety: UNSAFE */ declare interface DocumentMandatorySecurity { classification: Array; markings: Array; } /** * Activity event data emitted when a document's mandatory security (classification and markings) is updated. * * Log Safety: UNSAFE */ declare interface DocumentMandatorySecurityUpdateEventData { newClassification: Array; newMarkings: Array; } /** * Metadata for document media items. * * Log Safety: UNSAFE */ declare interface DocumentMediaItemMetadata { format: DocumentDecodeFormat; pages?: number; sizeBytes: number; title?: string; author?: string; } /** * A websocket type sent over the document metadata channel when a metadata field has changed. The client should reload the Document to retrieve the updated metadata values. * * Log Safety: SAFE */ declare interface DocumentMetadataUpdate { mandatorySecurityChanged: boolean; discretionarySecurityChanged: boolean; deleted: boolean; } /** * Log Safety: UNSAFE */ declare type DocumentName = LooselyBrandedString_19<"DocumentName">; /** * The requested document was not found. * * Log Safety: SAFE */ declare interface DocumentNotFound { errorCode: "NOT_FOUND"; errorName: "DocumentNotFound"; errorDescription: "The requested document was not found."; errorInstanceId: string; parameters: { documentRid: unknown; }; } /** * The given Document could not be found. * * Log Safety: SAFE */ declare interface DocumentNotFound_2 { errorCode: "NOT_FOUND"; errorName: "DocumentNotFound"; errorDescription: "The given Document could not be found."; errorInstanceId: string; parameters: { documentId: unknown; }; } /** * Log Safety: SAFE */ declare type DocumentOntologyRid = LooselyBrandedString_19<"DocumentOntologyRid">; /** * An operation that the requesting user is permitted to perform on a document, based on the document's security settings and the user's principals. * * Log Safety: SAFE */ declare type DocumentOperation = "VIEW" | "EDIT" | "OWN" | "DELETE"; /** * The Gatekeeper parent the new Document is created under, also used with the documentTypeName to locate the associated Document Type instance. The populated variant must match the file system required by that Document Type: parentFolder for Compass-backed types, namespace for Artifact-backed types. * * Log Safety: SAFE */ declare type DocumentParent = ({ type: "parentFolder"; } & DocumentParentFolder) | ({ type: "namespace"; } & DocumentParentNamespace); /** * A Compass folder parent for the new Document. * * Log Safety: SAFE */ declare interface DocumentParentFolder { folderRid: _Filesystem.FolderRid; } /** * An Artifact's parent namespace for the new Document. * * Log Safety: SAFE */ declare interface DocumentParentNamespace { namespaceRid: NamespaceRid_2; } /** * Sent when a user's presence changes on a document. That is, sent when a user opens or closes the document. Note that just because a user is not present on a particular document does not mean that they are overall "offline" -- they may have other documents or non-document applications open in the platform. * * Log Safety: SAFE */ declare interface DocumentPresenceChangeEvent { userId: _Core.UserId; status: UserPresence; } /** * A request from client to subscribe to a document's presence updates, required on a subscription request to /documents/{documentId}/presence. * * Log Safety: SAFE */ declare interface DocumentPresenceSubscriptionRequest { clientId: ClientId; clientSupportedVersionRange: ClientSupportedVersionRange; } /** * Update sent by client to apply to internal Y.Doc on server. * * Log Safety: UNSAFE */ declare interface DocumentPublishMessage { yjsUpdate: YjsUpdate; editId: EditId; clientId: ClientId; clientSupportedVersionRange: ClientSupportedVersionRange; documentUpdateSchemaVersion?: SchemaVersion; description?: DocumentEditDescription; } /** * Activity event data emitted when a document is renamed. * * Log Safety: UNSAFE */ declare interface DocumentRenameEventData { previousName: string; newName: string; } /** * The unique identifier for a Document * * Log Safety: SAFE */ declare type DocumentRid = LooselyBrandedString_17<"DocumentRid">; /** * Identifier for an PACK Document. * * Log Safety: SAFE */ declare type DocumentRid_2 = LooselyBrandedString_19<"DocumentRid">; export declare namespace Documents { export { } } /** * Filter criteria for document search. * * Log Safety: UNSAFE */ declare interface DocumentSearchQuery { documentName?: string; } /** * Request body for searching documents. * * Log Safety: UNSAFE */ declare interface DocumentSearchRequest { ontologyRid?: string; query?: DocumentSearchQuery; orderBy?: DocumentSort; pageSize?: _Core.PageSize; pageToken?: PageToken_2; } /** * Log Safety: UNSAFE */ declare interface DocumentSearchResponse { data: Array; nextPageToken?: PageToken_2; } /** * Log Safety: UNSAFE */ declare interface DocumentSecurity { mandatory: DocumentMandatorySecurity; discretionary: DocumentDiscretionarySecurity; } /** * Sorting specification for document search. * * Log Safety: SAFE */ declare interface DocumentSort { field: DocumentSortField; direction: _Core.OrderByDirection; } /** * The field to sort documents by. * * Log Safety: SAFE */ declare type DocumentSortField = "NAME" | "CREATED_TIME" | "LAST_MODIFIED_TIME" | "LAST_VIEW_TIME"; /** * The storage backend for a document type's schema. * * Log Safety: UNSAFE */ declare type DocumentStorageType = { type: "yjs"; } & YjsSchema; /** * The operation to perform for document to document conversion. * * Log Safety: UNSAFE */ declare type DocumentToDocumentOperation = ({ type: "slicePdfRange"; } & SlicePdfRangeOperation) | ({ type: "convertDocument"; } & ConvertDocumentOperation); /** * Transforms documents to documents. * * Log Safety: UNSAFE */ declare interface DocumentToDocumentTransformation { encoding: DocumentEncodeFormat; operation: DocumentToDocumentOperation; } /** * The operation to perform for document to image conversion. * * Log Safety: UNSAFE */ declare type DocumentToImageOperation = ({ type: "renderPageToFitBoundingBox"; } & RenderPageToFitBoundingBoxOperation) | ({ type: "renderPage"; } & RenderPageOperation); /** * Renders document pages as images. * * Log Safety: UNSAFE */ declare interface DocumentToImageTransformation { encoding: ImageryEncodeFormat; operation: DocumentToImageOperation; } /** * The operation to perform for document to text conversion. * * Log Safety: UNSAFE */ declare type DocumentToTextOperation = ({ type: "extractTableOfContents"; } & ExtractTableOfContentsOperation) | ({ type: "getPdfPageDimensions"; } & GetPdfPageDimensionsOperation) | ({ type: "extractAllText"; } & ExtractAllTextOperation) | ({ type: "extractVlmText"; } & ExtractVlmTextOperation) | ({ type: "extractTextFromPagesToArray"; } & ExtractTextFromPagesToArrayOperation) | ({ type: "ocrOnPage"; } & OcrOnPageOperation) | ({ type: "extractFormFields"; } & ExtractFormFieldsOperation) | ({ type: "extractLayoutAwareTextV2"; } & ExtractDocumentLayoutAwareTextV2Operation) | ({ type: "extractTextV2"; } & ExtractDocumentTextV2Operation) | ({ type: "extractUnstructuredTextFromPage"; } & ExtractUnstructuredTextFromPageOperation) | ({ type: "extractLayoutAwareContent"; } & DocumentExtractLayoutAwareContentOperation) | ({ type: "ocrOnPages"; } & OcrOnPagesOperation); /** * Extracts text from documents. * * Log Safety: UNSAFE */ declare interface DocumentToTextTransformation { operation: DocumentToTextOperation; } /** * Log Safety: UNSAFE */ declare interface DocumentType_2 { rid: DocumentTypeRid; name: DocumentTypeName; operationalVersion?: SchemaVersion; fileSystemType?: FileSystemType; owningApplicationId?: string; } /** * This Document Type Name already exists for the given ontology. * * Log Safety: UNSAFE */ declare interface DocumentTypeAlreadyExists { errorCode: "CONFLICT"; errorName: "DocumentTypeAlreadyExists"; errorDescription: "This Document Type Name already exists for the given ontology."; errorInstanceId: string; parameters: { documentTypeName: unknown; }; } /** * First-party document type definition loaded from a published asset. Used by products that ship document-type schemas as part of their deployment. * * Log Safety: UNSAFE */ declare interface DocumentTypeAsset { comment?: string; documentTypeName: DocumentTypeName; documentStorageType: DocumentStorageType; fileSystemType: FileSystemType; schemaVersion: SchemaVersion; owningApplicationId?: string; forceOverwrite?: boolean; } /** * The configured name for a DocumentType. This is unique within an ontology but not globally unique. * * Log Safety: UNSAFE */ declare type DocumentTypeName = LooselyBrandedString_19<"DocumentTypeName">; /** * The Document Type Name does not exist, or the user does not have permission to view the Document Type. * * Log Safety: UNSAFE */ declare interface DocumentTypeNameNotFound { errorCode: "NOT_FOUND"; errorName: "DocumentTypeNameNotFound"; errorDescription: "The Document Type Name does not exist, or the user does not have permission to view the Document Type."; errorInstanceId: string; parameters: { documentTypeName: unknown; }; } /** * Creating a hidden child document or a document matching another document's security is only supported for Compass-backed Document Types. * * Log Safety: UNSAFE */ declare interface DocumentTypeNotCompassBacked { errorCode: "INVALID_ARGUMENT"; errorName: "DocumentTypeNotCompassBacked"; errorDescription: "Creating a hidden child document or a document matching another document's security is only supported for Compass-backed Document Types."; errorInstanceId: string; parameters: { documentTypeName: unknown; }; } /** * The given DocumentType could not be found. * * Log Safety: SAFE */ declare interface DocumentTypeNotFound { errorCode: "NOT_FOUND"; errorName: "DocumentTypeNotFound"; errorDescription: "The given DocumentType could not be found."; errorInstanceId: string; parameters: { documentTypeRid: unknown; }; } /** * Identifier for an PACK Document Type. * * Log Safety: SAFE */ declare type DocumentTypeRid = LooselyBrandedString_19<"DocumentTypeRid">; export declare namespace DocumentTypes { export { } } /** * The schema definition for a real-time document type. * * Log Safety: UNSAFE */ declare interface DocumentTypeSchema { primaryModelKeys: Array; models: Record; } /** * Update broadcast to all clients after being applied on server. * * Log Safety: UNSAFE */ declare interface DocumentUpdate { update?: YjsUpdate; clientId: ClientId; clientSupportedVersionRange: ClientSupportedVersionRange; updateSchemaVersion?: SchemaVersion; revisionId: RevisionId; baseRevisionId: RevisionId; editIds: Array; } /** * Union type to allow broadcasting different collaborative message types. * * Log Safety: UNSAFE */ declare type DocumentUpdateMessage = ({ type: "deletion"; } & DocumentDeletionUpdate) | ({ type: "update"; } & DocumentUpdate) | ({ type: "error"; } & ErrorMessage); /** * A request from client to subscribe to a document's collaborative updates, required on a subscription request to /documents/{documentId}/updates * * Log Safety: SAFE */ declare interface DocumentUpdateSubscriptionRequest { clientId: ClientId; clientSupportedVersionRange: ClientSupportedVersionRange; lastRevisionId?: RevisionId; } /** * @deprecated Use `DoesNotIntersectBoundingBoxQuery` in the `foundry.ontologies` package * * Returns objects where the specified field does not intersect the bounding box provided. * * Log Safety: UNSAFE */ declare interface DoesNotIntersectBoundingBoxQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: BoundingBoxValue; } /** * Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface DoesNotIntersectBoundingBoxQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: BoundingBoxValue_2; } /** * @deprecated Use `DoesNotIntersectPolygonQuery` in the `foundry.ontologies` package * * Returns objects where the specified field does not intersect the polygon provided. * * Log Safety: UNSAFE */ declare interface DoesNotIntersectPolygonQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: PolygonValue; } /** * Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface DoesNotIntersectPolygonQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: PolygonValue_2; } /** * The domain that the connection is allowed to access. * * Log Safety: DO_NOT_LOG */ declare interface Domain { scheme?: UriScheme; host: string; port?: number; auth?: RestAuthenticationMode; } /** * The domain must use HTTPS if authentication is required. * * Log Safety: SAFE */ declare interface DomainMustUseHttpsWithAuthentication { errorCode: "INVALID_ARGUMENT"; errorName: "DomainMustUseHttpsWithAuthentication"; errorDescription: "The domain must use HTTPS if authentication is required."; errorInstanceId: string; parameters: {}; } /** * A double parameter value. * * Log Safety: UNSAFE */ declare interface DoubleParameter { value: number; } /** * Aggregated statistics for numeric series. * * Log Safety: UNSAFE */ declare interface DoubleSeriesAggregations { min?: number; max?: number; last?: number; } /** * A series of double values. * * Log Safety: UNSAFE */ declare interface DoubleSeriesV1 { series: Array; } /** * A single double value in a series. * * Log Safety: UNSAFE */ declare interface DoubleSeriesValueV1 { value: number; timestamp: EpochMillis; step: string; } /** * Log Safety: SAFE */ declare interface DoubleType { } /** * Log Safety: SAFE */ declare interface DoubleType_2 { } /** * Log Safety: UNSAFE */ declare interface DoubleValue { value: number; } /** * Log Safety: UNSAFE */ declare type DoubleValue_2 = number; /** * The vector to search with. The vector must be of the same dimension as the vectors stored in the provided propertyIdentifier. * * Log Safety: UNSAFE */ declare interface DoubleVector { value: Array; } /** * The driver content must be provided as a jar. * * Log Safety: UNSAFE */ declare interface DriverContentMustBeUploadedAsJar { errorCode: "INVALID_ARGUMENT"; errorName: "DriverContentMustBeUploadedAsJar"; errorDescription: "The driver content must be provided as a jar."; errorInstanceId: string; parameters: { driverName: unknown; }; } /** * Duplicate jar with different versions already exists on connection. * * Log Safety: UNSAFE */ declare interface DriverJarAlreadyExists { errorCode: "CONFLICT"; errorName: "DriverJarAlreadyExists"; errorDescription: "Duplicate jar with different versions already exists on connection."; errorInstanceId: string; parameters: { driverName: unknown; connectionRid: unknown; }; } /** * Checkpoint justification where the user selects one or more options from a dropdown. * * Log Safety: UNSAFE */ declare interface DropdownJustification { selectedOptions: Array; prompt: string; description?: string; title: string; } /** * A selection made within a multi-select dropdown justification. * * Log Safety: UNSAFE */ declare interface DropdownSelection { selectedOption: string; additionalResponse?: string; } /** * The build request contains duplicate branches. The branch and any fallback branches must all be distinct. * * Log Safety: UNSAFE */ declare interface DuplicateBuildBranches { errorCode: "INVALID_ARGUMENT"; errorName: "DuplicateBuildBranches"; errorDescription: "The build request contains duplicate branches. The branch and any fallback branches must all be distinct."; errorInstanceId: string; parameters: { duplicateBranchNames: unknown; }; } /** * The requested sort order includes duplicate properties. * * Log Safety: UNSAFE */ declare interface DuplicateOrderBy { errorCode: "INVALID_ARGUMENT"; errorName: "DuplicateOrderBy"; errorDescription: "The requested sort order includes duplicate properties."; errorInstanceId: string; parameters: { properties: unknown; }; } /** * A measurement of duration. * * Log Safety: SAFE */ declare interface Duration { value: number; unit: TimeUnit; } /** * An ISO 8601 formatted duration. * * Log Safety: UNSAFE */ declare type Duration_2 = LooselyBrandedString_5<"Duration">; /** * Log Safety: SAFE */ declare interface Duration_3 { unit: _Core.TimeUnit; value: number; } /** * Specifies the unit of the input duration value. * * Log Safety: SAFE */ declare type DurationBaseValue = "SECONDS" | "MILLISECONDS"; /** * Log Safety: UNSAFE */ declare type DurationFormatStyle = ({ type: "humanReadable"; } & HumanReadableFormat) | ({ type: "timecode"; } & TimeCodeFormat); /** * Specifies the maximum precision to apply when formatting a duration. * * Log Safety: SAFE */ declare type DurationPrecision = "DAYS" | "HOURS" | "MINUTES" | "SECONDS" | "AUTO"; /** * A duration of time measured in seconds. * * Log Safety: SAFE */ declare type DurationSeconds = string; /** * Start reading from the beginning of the stream. Sets offset to 0 for all partitions, allowing the subscriber to read all historical data from the start. * * Log Safety: SAFE */ declare interface EarliestPosition { } /** * Log Safety: UNSAFE */ declare type EditHistoryEdit = ({ type: "createEdit"; } & CreateEdit) | ({ type: "deleteEdit"; } & DeleteEdit) | ({ type: "modifyEdit"; } & ModifyEdit); /** * A unique identifier for an edit to an AppKit Document. * * Log Safety: SAFE */ declare type EditId = LooselyBrandedString_19<"EditId">; /** * The user does not have permission to edit this ObjectType. * * Log Safety: SAFE */ declare interface EditObjectPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "EditObjectPermissionDenied"; errorDescription: "The user does not have permission to edit this ObjectType."; errorInstanceId: string; parameters: {}; } /** * A property on an object type that is permissioned to a tabular datasource, but the contents are only populated through Actions. * * Log Safety: SAFE */ declare interface EditOnlyPropertyMapping { } /** * Log Safety: UNSAFE */ declare type EditsHistoryFilter = ({ type: "timestampFilter"; } & EditsHistoryTimestampFilter) | ({ type: "operationIdsFilter"; } & EditsHistoryOperationIdsFilter); /** * Log Safety: SAFE */ declare interface EditsHistoryOperationIdsFilter { operationIds: Array; } /** * Log Safety: SAFE */ declare type EditsHistorySortOrder = "newest_first" | "oldest_first"; /** * Log Safety: SAFE */ declare interface EditsHistoryTimestampFilter { startTime?: string; endTime?: string; } /** * Log Safety: SAFE */ declare type EditTypeFilter = "create" | "modify" | "delete"; /** * Metadata about an email attachment. * * Log Safety: UNSAFE */ declare interface EmailAttachment { attachmentIndex: number; fileName?: string; mimeType: string; } /** * The format of an email media item. * * Log Safety: SAFE */ declare type EmailDecodeFormat = "EML"; /** * Metadata for email media items. * * Log Safety: UNSAFE */ declare interface EmailMediaItemMetadata { format: EmailDecodeFormat; sizeBytes: number; sender: Array; date: string; attachmentCount: number; to: Array; cc: Array; subject?: string; attachments: Array; } /** * The operation to perform for email to attachment extraction. * * Log Safety: UNSAFE */ declare type EmailToAttachmentOperation = { type: "getEmailAttachment"; } & GetEmailAttachmentOperation; /** * Extracts attachments from email. * * Log Safety: UNSAFE */ declare interface EmailToAttachmentTransformation { operation: EmailToAttachmentOperation; } /** * The output format for email body extraction. * * Log Safety: SAFE */ declare type EmailToTextEncodeFormat = "TEXT" | "HTML"; /** * The operation to perform for email to text extraction. * * Log Safety: UNSAFE */ declare type EmailToTextOperation = { type: "getEmailBody"; } & GetEmailBodyOperation; /** * Extracts text content from email. * * Log Safety: UNSAFE */ declare interface EmailToTextTransformation { operation: EmailToTextOperation; } /** * Log Safety: UNSAFE */ declare type EmbeddingModel = ({ type: "lms"; } & LmsEmbeddingModel) | ({ type: "foundryLiveDeployment"; } & FoundryLiveDeployment); /* Excluded from this release type: embeddings */ /* Excluded from this release type: enable */ /* Excluded from this release type: enable_2 */ /** * Could not enable the DevModeSettings. * * Log Safety: SAFE */ declare interface EnableDevModeSettingsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "EnableDevModeSettingsPermissionDenied"; errorDescription: "Could not enable the DevModeSettings."; errorInstanceId: string; parameters: {}; } /** * Could not enable the DevModeSettingsV2. * * Log Safety: SAFE */ declare interface EnableDevModeSettingsV2PermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "EnableDevModeSettingsV2PermissionDenied"; errorDescription: "Could not enable the DevModeSettingsV2."; errorInstanceId: string; parameters: {}; } /* Excluded from this release type: encrypt */ /** * When reading an encrypted property, the secret name representing the encrypted value will be returned. When writing to an encrypted property: If a plaintext value is passed as an input, the plaintext value will be encrypted and saved to the property. If a secret name is passed as an input, the secret name must match the existing secret name of the property and the property will retain its previously encrypted value. * * Log Safety: DO_NOT_LOG */ declare type EncryptedProperty = ({ type: "asSecretName"; } & AsSecretName) | ({ type: "asPlaintextValue"; } & AsPlaintextValue); /** * The encrypted property must be specified as a plaintext value. * * Log Safety: SAFE */ declare interface EncryptedPropertyMustBeSpecifiedAsPlaintextValue { errorCode: "INVALID_ARGUMENT"; errorName: "EncryptedPropertyMustBeSpecifiedAsPlaintextValue"; errorDescription: "The encrypted property must be specified as a plaintext value."; errorInstanceId: string; parameters: { propertyName: unknown; }; } /** * Encrypts bounding boxes in an image using a commutative encryption algorithm. * * Log Safety: SAFE */ declare interface EncryptImageOperation { polygons: Array; cipherLicenseRid: string; } /** * The request to encrypt a plaintext value into a CipherText value. * * Log Safety: DO_NOT_LOG */ declare interface EncryptionRequest { plaintext: Plaintext; } /** * The result of a CipherText encryption. If successful, the encrypted ciphertext value will be returned. Otherwise, an error will be thrown. * * Log Safety: UNSAFE */ declare interface EncryptionResult { ciphertext: CipherText; } /* Excluded from this release type: encryptWithDefaultChannel */ /** * Log Safety: UNSAFE */ declare interface Enrollment { rid: _Core.EnrollmentRid; name: EnrollmentName; createdTime?: _Core.CreatedTime; } /** * Log Safety: UNSAFE */ declare type EnrollmentName = LooselyBrandedString_3<"EnrollmentName">; /** * The given Enrollment could not be found. * * Log Safety: SAFE */ declare interface EnrollmentNotFound { errorCode: "NOT_FOUND"; errorName: "EnrollmentNotFound"; errorDescription: "The given Enrollment could not be found."; errorInstanceId: string; parameters: { enrollmentRid: unknown; }; } /** * An enrollment was not found for the user. * * Log Safety: SAFE */ declare interface EnrollmentNotFound_2 { errorCode: "NOT_FOUND"; errorName: "EnrollmentNotFound"; errorDescription: "An enrollment was not found for the user."; errorInstanceId: string; parameters: { enrollmentRid: unknown; }; } /** * Log Safety: SAFE */ declare type EnrollmentRid = LooselyBrandedString<"EnrollmentRid">; /** * Log Safety: SAFE */ declare interface EnrollmentRoleAssignment { principalType: _Core.PrincipalType; principalId: _Core.PrincipalId; roleId: _Core.RoleId; } export declare namespace EnrollmentRoleAssignments { export { } } /** * One of the provided role IDs was not found. * * Log Safety: SAFE */ declare interface EnrollmentRoleNotFound { errorCode: "NOT_FOUND"; errorName: "EnrollmentRoleNotFound"; errorDescription: "One of the provided role IDs was not found."; errorInstanceId: string; parameters: {}; } export declare namespace Enrollments { export { } } /** * Log Safety: UNSAFE */ declare interface EntrySetType { keyType: QueryDataType; valueType: QueryDataType; } /** * Log Safety: UNSAFE */ declare interface EnumConstraint { options: Array; } /** * Log Safety: SAFE */ declare interface EnumConstraint_2 { options: Array; } /** * Milliseconds since unix time zero. This representation is used to maintain consistency with the Parquet format. * * Log Safety: SAFE */ declare type EpochMillis = string; /** * Returns objects where the specified field is equal to a value. For string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager. * * Log Safety: UNSAFE */ declare interface EqualsQuery { field: FieldNameV1; value: PropertyValue_2; } /** * @deprecated Use `EqualsQueryV2` in the `foundry.ontologies` package * * Returns objects where the specified field is equal to a value. * * Log Safety: UNSAFE */ declare interface EqualsQueryV2 { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: PropertyValue; } /** * Returns objects where the specified field is equal to a value. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. For string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager. * * Log Safety: UNSAFE */ declare interface EqualsQueryV2_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: PropertyValue_2; } /** * Log Safety: UNSAFE */ declare interface Error_2 { error: ErrorName; args: Array; } /** * Log Safety: SAFE */ declare type ErrorCode = "INTERNAL_ERROR" | "REVISION_TOO_OLD" | "CLIENT_VERSION_TOO_LOW" | "DOCUMENT_TYPE_OPERATIONAL_VERSION_BUMPED"; /** * Indicates the server was not able to load the securities of the property. * * Log Safety: SAFE */ declare interface ErrorComputingSecurity { } /** * Message sent to clients when an error occurs. The subscription may not remain in a valid state after this message and should be reopened. * * Log Safety: SAFE */ declare interface ErrorMessage { code: ErrorCode; errorInstanceId: string; args: Record; } /** * Log Safety: SAFE */ declare type ErrorName = LooselyBrandedString_5<"ErrorName">; /** * The configuration for when the severity of the failing health check should be escalated to CRITICAL – after a given number of failures, possibly within a time interval. * * Log Safety: UNSAFE */ declare interface EscalationConfig { failuresToCritical: number; timeIntervalInSeconds?: string; } /** * Union of all activity event data types. Platform-defined events have typed data, while custom application-defined events use a versioned generic payload. * * Log Safety: UNSAFE */ declare type EventDataUnion = ({ type: "documentCustomEvent"; } & DocumentCustomEventData) | ({ type: "documentCreate"; } & DocumentCreateEventData) | ({ type: "documentMandatorySecurityUpdate"; } & DocumentMandatorySecurityUpdateEventData) | ({ type: "documentRename"; } & DocumentRenameEventData) | ({ type: "documentDiscretionarySecurityUpdate"; } & DocumentDiscretionarySecurityUpdateEventData) | ({ type: "documentDescriptionUpdate"; } & DocumentDescriptionUpdateEventData); /** * A unique identifier for this activity event. * * Log Safety: UNSAFE */ declare type EventId = LooselyBrandedString_19<"EventId">; /** * A principal representing all users of the platform. * * Log Safety: SAFE */ declare interface Everyone { } /** * Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface ExactDistinctAggregationV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; name?: AggregationMetricName; direction?: OrderByDirection_2; } /** * This status indicates that the PropertyType is an example. It is backed by notional data that should not be used for actual workflows, but can be used to test those workflows. * * Log Safety: SAFE */ declare interface ExamplePropertyTypeStatus { } /** * 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. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/queries/{queryApiName}/execute */ declare function execute($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, queryApiName: _Ontologies_2.QueryApiName, $body: _Ontologies_2.ExecuteQueryRequest, $queryParams?: { version?: _Ontologies_2.FunctionVersion | undefined; branch?: _Core.FoundryBranch | undefined; sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; transactionId?: _Ontologies_2.OntologyTransactionId | undefined; scenarioRid?: _Ontologies_2.OntologyScenarioRid | undefined; }, $headerParams?: { attribution?: _Core.Attribution | undefined; traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies_2.ExecuteQueryResponse>; /* Excluded from this release type: execute_2 */ /** * Executes the FileImport, which runs asynchronously as a [Foundry Build](https://www.palantir.com/docs/foundry/data-integration/builds/). * The returned BuildRid can be used to check the status via the Orchestration API. * * @public * * Required Scopes: [api:connectivity-file-import-execute] * URL: /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}/execute */ declare function execute_3($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, fileImportRid: _Connectivity.FileImportRid ]): Promise<_Core.BuildRid>; /** * Executes the TableImport, which runs asynchronously as a [Foundry Build](https://www.palantir.com/docs/foundry/data-integration/builds/). * The returned BuildRid can be used to check the status via the Orchestration API. * * @public * * Required Scopes: [api:connectivity-table-import-execute] * URL: /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}/execute */ declare function execute_4($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, tableImportRid: _Connectivity.TableImportRid ]): Promise<_Core.BuildRid>; /** * Executes a new query. Only the user that invoked the query can operate on the query. The size of query * results are limited by default to 1 million rows. Contact your Palantir representative to discuss limit * increases. * * @public * * Required Scopes: [api:sql-queries-execute] * URL: /v2/sqlQueries/execute */ declare function execute_5($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _SqlQueries.ExecuteSqlQueryRequest]): Promise<_SqlQueries.QueryStatus>; /* Excluded from this release type: executeAsync */ /** * Could not executeAsync the Query. * * Log Safety: UNSAFE */ declare interface ExecuteAsyncQueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ExecuteAsyncQueryPermissionDenied"; errorDescription: "Could not executeAsync the Query."; errorInstanceId: string; parameters: { queryApiName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ExecuteAsyncQueryRequest { ontology?: _Ontologies.OntologyIdentifier; parameters: Record; version?: FunctionVersion_2; branch?: _Core.FoundryBranch; latestVersionResolution?: LatestVersionResolution; includePrerelease?: IncludePrerelease; } /** * Could not execute the FileImport. * * Log Safety: SAFE */ declare interface ExecuteFileImportPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ExecuteFileImportPermissionDenied"; errorDescription: "Could not execute the FileImport."; errorInstanceId: string; parameters: { fileImportRid: unknown; connectionRid: unknown; }; } /* Excluded from this release type: executeOntology */ /** * Could not executeOntology the SqlQuery. * * Log Safety: SAFE */ declare interface ExecuteOntologySqlQueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ExecuteOntologySqlQueryPermissionDenied"; errorDescription: "Could not executeOntology the SqlQuery."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface ExecuteOntologySqlQueryRequest { query: string; parameters?: Parameters_2; rowLimit?: number; dryRun?: boolean; branch?: _Core.FoundryBranch; scenarioRid?: ScenarioRid; ontologyIdentifier?: _Ontologies.OntologyIdentifier; tableProviders?: Record; } /** * Response from submitting a query for async execution. * * Log Safety: UNSAFE */ declare type ExecuteQueryAsyncResponse = ({ type: "submitted"; } & ExecutionSubmitted) | ({ type: "completed"; } & ExecutionCompleted); /** * Could not execute the Query. * * Log Safety: UNSAFE */ declare interface ExecuteQueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ExecuteQueryPermissionDenied"; errorDescription: "Could not execute the Query."; errorInstanceId: string; parameters: { queryApiName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ExecuteQueryRequest { parameters: Record; } /** * Log Safety: UNSAFE */ declare interface ExecuteQueryRequest_2 { parameters: Record; version?: FunctionVersion_2; branch?: _Core.FoundryBranch; latestVersionResolution?: LatestVersionResolution; includePrerelease?: IncludePrerelease; } /** * Log Safety: UNSAFE */ declare interface ExecuteQueryResponse { value: DataValue; } /** * Log Safety: UNSAFE */ declare interface ExecuteQueryResponse_2 { value: DataValue_2; } /** * Could not execute the SqlQuery. * * Log Safety: SAFE */ declare interface ExecuteSqlQueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ExecuteSqlQueryPermissionDenied"; errorDescription: "Could not execute the SqlQuery."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface ExecuteSqlQueryRequest { query: string; fallbackBranchIds?: Array<_Core.BranchName>; serializationFormat?: SerializationFormat; } /** * Could not execute the TableImport. * * Log Safety: SAFE */ declare interface ExecuteTableImportPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ExecuteTableImportPermissionDenied"; errorDescription: "Could not execute the TableImport."; errorInstanceId: string; parameters: { tableImportRid: unknown; connectionRid: unknown; }; } /** * Log Safety: SAFE */ declare interface Execution { id: ExecutionId; } /** * The query completed immediately. No polling needed. * * Log Safety: UNSAFE */ declare interface ExecutionCompleted { value: DataValue_2; } /** * Unique identifier for an async query execution. * * Log Safety: SAFE */ declare type ExecutionId = LooselyBrandedString_9<"ExecutionId">; /** * No async query execution found with the given ID. * * Log Safety: SAFE */ declare interface ExecutionNotFound { errorCode: "NOT_FOUND"; errorName: "ExecutionNotFound"; errorDescription: "No async query execution found with the given ID."; errorInstanceId: string; parameters: { executionId: unknown; }; } export declare namespace Executions { export { } } /** * The query was submitted for async processing. Use the executionId to poll for results via getResult or to cancel via cancel. * * Log Safety: SAFE */ declare interface ExecutionSubmitted { executionId: ExecutionId; } /** * Log Safety: UNSAFE */ declare interface Experiment { rid: ExperimentRid; modelRid: ModelRid; createdTime: _Core.CreatedTime; createdBy: _Core.CreatedBy; source: ExperimentSource; status: ExperimentStatus; statusMessage?: string; branch: _Core.BranchName; parameters: Array; series: Array; summaryMetrics: Array; artifacts: Record; tags: Array; linkedModelVersion?: ModelVersionRid; jobRid?: _Core.JobRid; } /** * This status indicates that the PropertyType is in development. * * Log Safety: SAFE */ declare interface ExperimentalPropertyTypeStatus { } /** * Details about an experiment artifact. * * Log Safety: SAFE */ declare type ExperimentArtifactDetails = { type: "table"; } & TableArtifactDetails; /** * Metadata about an experiment artifact. * * Log Safety: UNSAFE */ declare interface ExperimentArtifactMetadata { name: ExperimentArtifactName; description?: string; sizeBytes: _Core.SizeBytes; details: ExperimentArtifactDetails; } /** * The name of an experiment artifact. * * Log Safety: UNSAFE */ declare type ExperimentArtifactName = LooselyBrandedString_15<"ExperimentArtifactName">; /** * The requested artifact was not found in the experiment. * * Log Safety: UNSAFE */ declare interface ExperimentArtifactNotFound { errorCode: "NOT_FOUND"; errorName: "ExperimentArtifactNotFound"; errorDescription: "The requested artifact was not found in the experiment."; errorInstanceId: string; parameters: { modelRid: unknown; experimentRid: unknown; artifactName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ExperimentArtifactTable { name: ExperimentArtifactName; } /** * Experiment created from an authoring repository. * * Log Safety: SAFE */ declare interface ExperimentAuthoringSource { stemmaRid: string; } /** * Experiment created from a code workspace. * * Log Safety: SAFE */ declare interface ExperimentCodeWorkspaceSource { containerRid: string; deploymentRid?: string; } /** * The given Experiment could not be found. * * Log Safety: SAFE */ declare interface ExperimentNotFound { errorCode: "NOT_FOUND"; errorName: "ExperimentNotFound"; errorDescription: "The given Experiment could not be found."; errorInstanceId: string; parameters: { experimentRid: unknown; modelRid: unknown; }; } /** * The Resource Identifier (RID) of an Experiment. * * Log Safety: SAFE */ declare type ExperimentRid = LooselyBrandedString_15<"ExperimentRid">; export declare namespace Experiments { export { } } /** * Experiment created from the SDK. * * Log Safety: SAFE */ declare interface ExperimentSdkSource { } /** * Log Safety: UNSAFE */ declare interface ExperimentSeries { name: SeriesName; } export declare namespace ExperimentSeriesList { export { } } /** * The requested series was not found in the experiment. * * Log Safety: UNSAFE */ declare interface ExperimentSeriesNotFound { errorCode: "NOT_FOUND"; errorName: "ExperimentSeriesNotFound"; errorDescription: "The requested series was not found in the experiment."; errorInstanceId: string; parameters: { modelRid: unknown; experimentRid: unknown; seriesName: unknown; }; } /** * The source from which the experiment was created. * * Log Safety: SAFE */ declare type ExperimentSource = ({ type: "codeWorkspace"; } & ExperimentCodeWorkspaceSource) | ({ type: "authoring"; } & ExperimentAuthoringSource) | ({ type: "sdk"; } & ExperimentSdkSource); /** * The current status of an experiment. * * Log Safety: SAFE */ declare type ExperimentStatus = "RUNNING" | "SUCCEEDED" | "FAILED"; /** * A tag associated with an experiment. * * Log Safety: UNSAFE */ declare type ExperimentTagText = LooselyBrandedString_15<"ExperimentTagText">; /** * You cannot pass includeExpirations if transitive is true. * * Log Safety: SAFE */ declare interface ExpirationForTransitiveGroupMembersNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "ExpirationForTransitiveGroupMembersNotSupported"; errorDescription: "You cannot pass includeExpirations if transitive is true."; errorInstanceId: string; parameters: {}; } /** * The user does not have export permissions on this Document. * * Log Safety: SAFE */ declare interface ExportDocumentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ExportDocumentPermissionDenied"; errorDescription: "The user does not have export permissions on this Document."; errorInstanceId: string; parameters: { documentRid: unknown; }; } /** * The user does not have export permissions on this GenerationJob. * * Log Safety: SAFE */ declare interface ExportGenerationJobPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ExportGenerationJobPermissionDenied"; errorDescription: "The user does not have export permissions on this GenerationJob."; errorInstanceId: string; parameters: { generationJobRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ExportJob { rid: ExportJobRid; status: ExportJobStatus; } /** * Log Safety: SAFE */ declare interface ExportJobDocumentSource { documentRid: DocumentRid; } /** * The export job failed * * Log Safety: UNSAFE */ declare interface ExportJobFailed { errorMessage: string; errorCode?: string; errorInstanceId?: string; } /** * Log Safety: SAFE */ declare interface ExportJobGenerationJobSource { templateRid: TemplateRid; generationJobRid: GenerationJobRid; } /** * The given ExportJob could not be found. * * Log Safety: SAFE */ declare interface ExportJobNotFound { errorCode: "NOT_FOUND"; errorName: "ExportJobNotFound"; errorDescription: "The given ExportJob could not be found."; errorInstanceId: string; parameters: { exportJobRid: unknown; }; } /** * Log Safety: SAFE */ declare interface ExportJobPdfTarget { userLocale: _Core.Locale; userTimezone: _Core.ZoneId; } /** * The unique identifier for an ExportJob * * Log Safety: SAFE */ declare type ExportJobRid = LooselyBrandedString_17<"ExportJobRid">; /** * The export job is currently running * * Log Safety: SAFE */ declare interface ExportJobRunning { } export declare namespace ExportJobs { export { } } /** * Defines the source of contents for an ExportJob * * Log Safety: SAFE */ declare type ExportJobSource = ({ type: "generationJobSource"; } & ExportJobGenerationJobSource) | ({ type: "documentSource"; } & ExportJobDocumentSource); /** * The status of an export job * * Log Safety: UNSAFE */ declare type ExportJobStatus = ({ type: "running"; } & ExportJobRunning) | ({ type: "failed"; } & ExportJobFailed) | ({ type: "succeeded"; } & ExportJobSucceeded); /** * The export job succeeded * * Log Safety: SAFE */ declare interface ExportJobSucceeded { fileRid: FileRid; } /** * The target format that the job will export to. * * Log Safety: SAFE */ declare type ExportJobTarget = { type: "pdf"; } & ExportJobPdfTarget; /** * Extracts text across all pages of the document. For PDF documents, includes all text. For DocX documents, includes only regular paragraphs. * * Log Safety: SAFE */ declare interface ExtractAllTextOperation { } /** * Extracts the first audio stream from the video unchanged. * * Log Safety: SAFE */ declare interface ExtractAudioOperation { } /** * Log Safety: SAFE */ declare type ExtractDatePart = "DAYS" | "MONTHS" | "QUARTERS" | "YEARS"; /** * Configuration for v2 layout-aware document text extraction. * * Log Safety: UNSAFE */ declare interface ExtractDocumentLayoutAwareTextV2Config { format?: TextOutputFormat; mode?: OcrMode; languages: Array; } /** * Extract layout aware text with bounding boxes across all pages using the v2 text extraction endpoint. This only supports PDFs. * * Log Safety: UNSAFE */ declare interface ExtractDocumentLayoutAwareTextV2Operation { pageRange?: PageRange; config: ExtractDocumentLayoutAwareTextV2Config; } /** * Configuration for v2 document text extraction. * * Log Safety: UNSAFE */ declare interface ExtractDocumentTextV2Config { format?: TextOutputFormat; mode?: OcrMode; languages: Array; } /** * Extract text across all pages using the v2 text extraction endpoint with per page text. This only supports PDFs. * * Log Safety: UNSAFE */ declare interface ExtractDocumentTextV2Operation { pageRange?: PageRange; config: ExtractDocumentTextV2Config; } /** * Extracts the first full scene frame from the video. If both width and height are not specified, preserves the original size. If only one dimension is specified, the other is calculated to preserve aspect ratio. * * Log Safety: SAFE */ declare interface ExtractFirstFrameOperation { height?: number; width?: number; } /** * Extracts form field data from a PDF document. * * Log Safety: SAFE */ declare interface ExtractFormFieldsOperation { } /** * Extracts frames from the video at specified timestamps. If only one dimension is specified, the other is calculated to preserve aspect ratio. * * Log Safety: UNSAFE */ declare interface ExtractFramesAtTimestampsOperation { height?: number; width?: number; timestamp: number; } /** * Returns the main value of a struct as configured in the ontology. * * Log Safety: SAFE */ declare interface ExtractMainValueLoadLevel { } /** * Extracts the specified date part from a date or timestamp. * * Log Safety: UNSAFE */ declare interface ExtractPropertyExpression { property: DerivedPropertyDefinition; part: ExtractDatePart; } /** * Extracts all scene frames from a video as images in an archive. * * Log Safety: UNSAFE */ declare interface ExtractSceneFramesOperation { encoding: ImageryEncodeFormat; sceneScore?: SceneScore; } /** * Extracts the table of contents from a document. * * Log Safety: SAFE */ declare interface ExtractTableOfContentsOperation { } /** * Extracts text from multiple pages into a list of strings. * * Log Safety: SAFE */ declare interface ExtractTextFromPagesToArrayOperation { startPage?: number; endPage?: number; } /** * Wrapper for text extraction preprocessing. * * Log Safety: UNSAFE */ declare interface ExtractTextPreprocessingWrapper { extractText: ExtractDocumentTextV2Config; } /** * Extracts unstructured text from a specified page. * * Log Safety: UNSAFE */ declare interface ExtractUnstructuredTextFromPageOperation { pageNumber: number; } /** * Extract text from a document using vision language models (VLMs). VLMs can understand document layout and structure more intelligently than traditional OCR. * * Log Safety: UNSAFE */ declare interface ExtractVlmTextOperation { llmSpec: LlmSpec; preprocessingConfiguration?: VlmPreprocessingConfig; imageSpec?: ImageSpec; outputFormat: VlmOutputFormat; pageRange?: PageRange; } /** * Log Safety: UNSAFE */ declare interface FailedQueryStatus { errorMessage: string; } /** * The byte stream could not be processed. * * Log Safety: SAFE */ declare interface FailedToProcessBinaryRecord { errorCode: "INTERNAL"; errorName: "FailedToProcessBinaryRecord"; errorDescription: "The byte stream could not be processed."; errorInstanceId: string; parameters: {}; } /** * The failed output of a tool call. * * Log Safety: UNSAFE */ declare interface FailureToolCallOutput { correctionMessage: string; } /** * The branches to retrieve JobSpecs from if no JobSpec is found on the target branch. * * Log Safety: UNSAFE */ declare type FallbackBranches = Array<_Core.BranchName>; /** * GeoJSon 'Feature' object * * Log Safety: UNSAFE */ declare interface Feature { geometry?: Geometry; properties: Record; id?: any; bbox?: BBox; } /** * GeoJSon 'FeatureCollection' object * * Log Safety: UNSAFE */ declare interface FeatureCollection { features: Array; bbox?: BBox; } /** * Log Safety: UNSAFE */ declare type FeatureCollectionTypes = { type: "Feature"; } & Feature; /** * Log Safety: UNSAFE */ declare type FeaturePropertyKey = LooselyBrandedString_2<"FeaturePropertyKey">; /** * A field in a Foundry schema. For more information on supported data types, see the supported field types user documentation. * * Log Safety: UNSAFE */ declare interface Field { name: FieldName; schema: FieldSchema; } /** * Log Safety: UNSAFE */ declare type FieldDataType = ({ type: "struct"; } & StructFieldType) | ({ type: "date"; } & DateType) | ({ type: "string"; } & StringType) | ({ type: "byte"; } & ByteType) | ({ type: "double"; } & DoubleType) | ({ type: "integer"; } & IntegerType) | ({ type: "float"; } & FloatType) | ({ type: "long"; } & LongType) | ({ type: "boolean"; } & BooleanType) | ({ type: "array"; } & ArrayFieldType) | ({ type: "binary"; } & BinaryType_2) | ({ type: "short"; } & ShortType) | ({ type: "decimal"; } & DecimalType) | ({ type: "map"; } & MapFieldType) | ({ type: "timestamp"; } & TimestampType); /** * A field definition within a record. * * Log Safety: UNSAFE */ declare interface FieldDef { key: FieldKey; name: string; description?: string; isOptional?: boolean; metadata: SchemaMetadata; fieldType: FieldTypeUnion; } /** * A key identifying a field within a model. * * Log Safety: UNSAFE */ declare type FieldKey = LooselyBrandedString_19<"FieldKey">; /** * Log Safety: UNSAFE */ declare type FieldName = LooselyBrandedString<"FieldName">; /** * A reference to an Ontology object property with the form properties.{propertyApiName}. * * Log Safety: UNSAFE */ declare type FieldNameV1 = LooselyBrandedString_5<"FieldNameV1">; /** * The specification of the type of a Foundry schema field. * * Log Safety: UNSAFE */ declare interface FieldSchema { nullable: boolean; customMetadata?: CustomMetadata; dataType: FieldDataType; } /** * An array type with null value handling. * * Log Safety: UNSAFE */ declare interface FieldTypeArray { allowNullValue: boolean; value: FieldValueType; } /** * A map type with key and value definitions. * * Log Safety: UNSAFE */ declare interface FieldTypeMap { allowNullValue: boolean; key: FieldValueType; value: FieldValueType; } /** * A set type with null value handling. * * Log Safety: UNSAFE */ declare interface FieldTypeSet { allowNullValue: boolean; value: FieldValueType; } /** * The type of a field, which can be a collection, map, or value. * * Log Safety: UNSAFE */ declare type FieldTypeUnion = ({ type: "set"; } & FieldTypeSet) | ({ type: "array"; } & FieldTypeArray) | ({ type: "map"; } & FieldTypeMap) | ({ type: "value"; } & FieldValueType); /** * A dataset column type is not compatible with the trainer's supported column types. * * Log Safety: UNSAFE */ declare interface FieldValidationError { datasetRid: _Core.DatasetRid; fieldName?: string; fieldType: string; } /** * A boolean field value with optional default. * * Log Safety: SAFE */ declare interface FieldValueBoolean { defaultValue?: boolean; } /** * A datetime field value. * * Log Safety: UNSAFE */ declare interface FieldValueDatetime { value: any; } /** * A reference to another document. * * Log Safety: SAFE */ declare interface FieldValueDocumentRef { documentTypeRids: Array; } /** * A double field value with optional constraints and default. * * Log Safety: UNSAFE */ declare interface FieldValueDouble { defaultValue?: DoubleValue_2; minValue?: DoubleValue_2; maxValue?: DoubleValue_2; } /** * An integer field value with optional constraints and default. * * Log Safety: UNSAFE */ declare interface FieldValueInteger { defaultValue?: IntegerValue_2; minValue?: IntegerValue_2; maxValue?: IntegerValue_2; } /** * A reference to media content. * * Log Safety: UNSAFE */ declare interface FieldValueMediaRef { value: any; } /** * A reference to another model within the schema. * * Log Safety: UNSAFE */ declare interface FieldValueModelRef { modelTypes: Array; } /** * A reference to an ontology object or interface. * * Log Safety: SAFE */ declare interface FieldValueObjectRef { interfaceTypeRids: Array; objectTypeRids: Array; } /** * A string field value with optional constraints and default. * * Log Safety: UNSAFE */ declare interface FieldValueString { defaultValue?: string; minLength?: TextLength; maxLength?: TextLength; } /** * A text field value with optional constraints and default. Text should be used over string values for word-editor style complex text. * * Log Safety: UNSAFE */ declare interface FieldValueText { defaultValue?: string; minLength?: TextLength; maxLength?: TextLength; } /** * The field value type for a field definition. * * Log Safety: UNSAFE */ declare interface FieldValueType { valueType: FieldValueUnion; } /** * The possible value types for a field. * * Log Safety: UNSAFE */ declare type FieldValueUnion = ({ type: "mediaRef"; } & FieldValueMediaRef) | ({ type: "modelRef"; } & FieldValueModelRef) | ({ type: "datetime"; } & FieldValueDatetime) | ({ type: "userRef"; } & FieldValueUserRef) | ({ type: "boolean"; } & FieldValueBoolean) | ({ type: "docRef"; } & FieldValueDocumentRef) | ({ type: "string"; } & FieldValueString) | ({ type: "double"; } & FieldValueDouble) | ({ type: "unmanagedJson"; } & FieldValueUnmanagedJson) | ({ type: "integer"; } & FieldValueInteger) | ({ type: "text"; } & FieldValueText) | ({ type: "object"; } & FieldValueObjectRef); /** * An unmanaged JSON field value. * * Log Safety: SAFE */ declare interface FieldValueUnmanagedJson { } /** * A reference to a user. * * Log Safety: SAFE */ declare interface FieldValueUserRef { } /** * Log Safety: UNSAFE */ declare interface File_2 { path: _Core.FilePath; transactionRid: TransactionRid; sizeBytes?: string; updatedTime: FileUpdatedTime; } /** * Log Safety: SAFE */ declare interface File_3 { rid: FileRid; } /** * The given file path already exists in the dataset and transaction. * * Log Safety: UNSAFE */ declare interface FileAlreadyExists { errorCode: "NOT_FOUND"; errorName: "FileAlreadyExists"; errorDescription: "The given file path already exists in the dataset and transaction."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; path: unknown; }; } /** * If any file has a relative path matching the regular expression, sync all files in the subfolder that are not otherwise filtered. * * Log Safety: UNSAFE */ declare interface FileAnyPathMatchesFilter { regex: string; } /** * Import all filtered files only if there are at least the specified number of files remaining. * * Log Safety: SAFE */ declare interface FileAtLeastCountFilter { minFilesCount: number; } /** * The provided minFilesCount property in the FileAtLeastCountFilter must be strictly greater than 0. * * Log Safety: SAFE */ declare interface FileAtLeastCountFilterInvalidMinCount { errorCode: "INVALID_ARGUMENT"; errorName: "FileAtLeastCountFilterInvalidMinCount"; errorDescription: "The provided minFilesCount property in the FileAtLeastCountFilter must be strictly greater than 0."; errorInstanceId: string; parameters: { minFilesCount: unknown; }; } /** * Only import files that have changed or been added since the last import run. Whether or not a file is considered to be changed is determined by the specified file properties. This will exclude files uploaded in any previous imports, regardless of the file import mode used. A SNAPSHOT file import mode does not reset the filter. * * Log Safety: SAFE */ declare interface FileChangedSinceLastUploadFilter { fileProperties: Array; } /** * The .zip archive contains too many files. * * Log Safety: SAFE */ declare interface FileCountLimitExceeded { errorCode: "INVALID_ARGUMENT"; errorName: "FileCountLimitExceeded"; errorDescription: "The .zip archive contains too many files."; errorInstanceId: string; parameters: { fileCountLimit: unknown; }; } /** * The .zip archive contains too many files. * * Log Safety: SAFE */ declare interface FileCountLimitExceeded_2 { errorCode: "INVALID_ARGUMENT"; errorName: "FileCountLimitExceeded"; errorDescription: "The .zip archive contains too many files."; errorInstanceId: string; parameters: { fileCountLimit: unknown; }; } /** * The format of files in the upstream source. * * Log Safety: SAFE */ declare type FileFormat = "AVRO" | "CSV" | "PARQUET"; /** * The ID of an audit log file * * Log Safety: SAFE */ declare type FileId = LooselyBrandedString_10<"FileId">; /** * Log Safety: UNSAFE */ declare interface FileImport { rid: FileImportRid; connectionRid: ConnectionRid; datasetRid: _Core.DatasetRid; branchName?: _Core.BranchName; displayName: FileImportDisplayName; fileImportFilters: Array; importMode: FileImportMode; subfolder?: string; } /** * A custom file import filter. Custom file import filters can be fetched but cannot currently be used when creating or updating file imports. * * Log Safety: UNSAFE */ declare interface FileImportCustomFilter { config: any; } /** * Custom file import filters can be fetched but cannot currently be used when creating or updating file imports. * * Log Safety: UNSAFE */ declare interface FileImportCustomFilterCannotBeUsedToCreateOrUpdateFileImports { errorCode: "INVALID_ARGUMENT"; errorName: "FileImportCustomFilterCannotBeUsedToCreateOrUpdateFileImports"; errorDescription: "Custom file import filters can be fetched but cannot currently be used when creating or updating file imports."; errorInstanceId: string; parameters: { config: unknown; }; } /** * Log Safety: UNSAFE */ declare type FileImportDisplayName = LooselyBrandedString_12<"FileImportDisplayName">; /** * Filters allow you to filter source files before they are imported into Foundry. * * Log Safety: UNSAFE */ declare type FileImportFilter = ({ type: "pathNotMatchesFilter"; } & FilePathNotMatchesFilter) | ({ type: "anyPathMatchesFilter"; } & FileAnyPathMatchesFilter) | ({ type: "filesCountLimitFilter"; } & FilesCountLimitFilter) | ({ type: "changedSinceLastUploadFilter"; } & FileChangedSinceLastUploadFilter) | ({ type: "customFilter"; } & FileImportCustomFilter) | ({ type: "lastModifiedAfterFilter"; } & FileLastModifiedAfterFilter) | ({ type: "pathMatchesFilter"; } & FilePathMatchesFilter) | ({ type: "atLeastCountFilter"; } & FileAtLeastCountFilter) | ({ type: "fileSizeFilter"; } & FileSizeFilter); /** * Import mode governs how raw files are read from an external system, and written into a Foundry dataset. SNAPSHOT: Defines a new dataset state consisting only of files from a particular import execution. APPEND: Purely additive and yields data from previous import executions in addition to newly added files. UPDATE: Replaces existing files from previous import executions based on file names. * * Log Safety: SAFE */ declare type FileImportMode = "SNAPSHOT" | "APPEND" | "UPDATE"; /** * The given FileImport could not be found. * * Log Safety: SAFE */ declare interface FileImportNotFound { errorCode: "NOT_FOUND"; errorName: "FileImportNotFound"; errorDescription: "The given FileImport could not be found."; errorInstanceId: string; parameters: { fileImportRid: unknown; connectionRid: unknown; }; } /** * The specified connection does not support file imports. * * Log Safety: SAFE */ declare interface FileImportNotSupportedForConnection { errorCode: "INVALID_ARGUMENT"; errorName: "FileImportNotSupportedForConnection"; errorDescription: "The specified connection does not support file imports."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /** * The Resource Identifier (RID) of a FileImport (also known as a batch sync). * * Log Safety: SAFE */ declare type FileImportRid = LooselyBrandedString_12<"FileImportRid">; export declare namespace FileImports { export { create_15 as create, deleteFileImport, list_31 as list, get_45 as get, replace_12 as replace, execute_3 as execute } } /** * Only import files that have been modified after a specified timestamp * * Log Safety: UNSAFE */ declare interface FileLastModifiedAfterFilter { afterTimestamp?: string; } /** * The name of a File within Foundry. Examples: my-file.txt, my-file.jpg, dataframe.snappy.parquet. * * Log Safety: UNSAFE */ declare type Filename = LooselyBrandedString<"Filename">; /** * The given File could not be found. * * Log Safety: UNSAFE */ declare interface FileNotFound { errorCode: "NOT_FOUND"; errorName: "FileNotFound"; errorDescription: "The given File could not be found."; errorInstanceId: string; parameters: { datasetRid: unknown; filePath: unknown; }; } /** * The requested file was not found. * * Log Safety: SAFE */ declare interface FileNotFound_2 { errorCode: "NOT_FOUND"; errorName: "FileNotFound"; errorDescription: "The requested file was not found."; errorInstanceId: string; parameters: { fileRid: unknown; }; } /** * The requested file could not be found on the given branch, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface FileNotFoundOnBranch { errorCode: "NOT_FOUND"; errorName: "FileNotFoundOnBranch"; errorDescription: "The requested file could not be found on the given branch, or the client token does not have access to it."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; path: unknown; }; } /** * The requested file could not be found on the given transaction range, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface FileNotFoundOnTransactionRange { errorCode: "NOT_FOUND"; errorName: "FileNotFoundOnTransactionRange"; errorDescription: "The requested file could not be found on the given transaction range, or the client token does not have access to it."; errorInstanceId: string; parameters: { datasetRid: unknown; startTransactionRid: unknown; endTransactionRid: unknown; path: unknown; }; } /** * The path to a File within Foundry. Paths are relative and must not start with a leading slash. Examples: my-file.txt, path/to/my-file.jpg, dataframe.snappy.parquet. * * Log Safety: UNSAFE */ declare type FilePath = LooselyBrandedString<"FilePath">; /** * A locator for a specific file in a widget set's release directory. * * Log Safety: UNSAFE */ declare type FilePath_2 = LooselyBrandedString_24<"FilePath">; /** * Only import files whose path (relative to the root of the source) matches the regular expression. Example Suppose we are importing files from relative/subfolder. relative/subfolder contains: relative/subfolder/include-file.txt relative/subfolder/exclude-file.txt relative/subfolder/other-file.txt With the relative/subfolder/include-.*.txt regex, only relative/subfolder/include-file.txt will be imported. * * Log Safety: UNSAFE */ declare interface FilePathMatchesFilter { regex: string; } /** * Only import files whose path (relative to the root of the source) does not match the regular expression. Example Suppose we are importing files from relative/subfolder. relative/subfolder contains: relative/subfolder/include-file.txt relative/subfolder/exclude-file.txt relative/subfolder/other-file.txt With the relative/subfolder/exclude-.*.txt regex, both relative/subfolder/include-file.txt and relative/subfolder/other-file.txt will be imported, and relative/subfolder/exclude-file.txt will be excluded from the import. * * Log Safety: UNSAFE */ declare interface FilePathNotMatchesFilter { regex: string; } /** * Log Safety: SAFE */ declare type FileProperty = "LAST_MODIFIED" | "SIZE"; /** * The unique identifier for a File * * Log Safety: SAFE */ declare type FileRid = LooselyBrandedString_17<"FileRid">; export declare namespace Files { export { deleteFile, list_19 as list, get_22 as get, upload, content } } export declare namespace Files_2 { export { } } /** * Only retain filesCount number of files in each transaction. The choice of files to retain is made without any guarantee of order. This option can increase the reliability of incremental syncs. * * Log Safety: SAFE */ declare interface FilesCountLimitFilter { filesCount: number; } /** * The filesCount property in the FilesCountLimitFilter must be strictly greater than 0. * * Log Safety: SAFE */ declare interface FilesCountLimitFilterInvalidLimit { errorCode: "INVALID_ARGUMENT"; errorName: "FilesCountLimitFilterInvalidLimit"; errorDescription: "The filesCount property in the FilesCountLimitFilter must be strictly greater than 0."; errorInstanceId: string; parameters: { filesCount: unknown; }; } /** * Only import files whose size is between the specified minimum and maximum values. At least one of gt or lt should be present. If both are present, the value specified for gt must be strictly less than lt - 1. * * Log Safety: SAFE */ declare interface FileSizeFilter { gt?: _Core.SizeBytes; lt?: _Core.SizeBytes; } /** * The gt property in the FileSizeFilter cannot be a negative number. * * Log Safety: SAFE */ declare interface FileSizeFilterGreaterThanCannotBeNegative { errorCode: "INVALID_ARGUMENT"; errorName: "FileSizeFilterGreaterThanCannotBeNegative"; errorDescription: "The gt property in the FileSizeFilter cannot be a negative number."; errorInstanceId: string; parameters: { gt: unknown; }; } /** * The provided gt and lt properties in the FileSizeFilter are invalid. No files will ever satisfy the provided range. The value specified for gt must be strictly less than lt - 1. * * Log Safety: SAFE */ declare interface FileSizeFilterInvalidGreaterThanAndLessThanRange { errorCode: "INVALID_ARGUMENT"; errorName: "FileSizeFilterInvalidGreaterThanAndLessThanRange"; errorDescription: "The provided gt and lt properties in the FileSizeFilter are invalid. No files will ever satisfy the provided range. The value specified for gt must be strictly less than lt - 1."; errorInstanceId: string; parameters: { gt: unknown; lt: unknown; }; } /** * The lt property in the FileSizeFilter must be at least 1 byte. * * Log Safety: SAFE */ declare interface FileSizeFilterLessThanMustBeOneByteOrLarger { errorCode: "INVALID_ARGUMENT"; errorName: "FileSizeFilterLessThanMustBeOneByteOrLarger"; errorDescription: "The lt property in the FileSizeFilter must be at least 1 byte."; errorInstanceId: string; parameters: { lt: unknown; }; } /** * Both the gt and lt properties are missing from the FileSizeFilter. At least one of these properties must be present * * Log Safety: SAFE */ declare interface FileSizeFilterMissingGreaterThanAndLessThan { errorCode: "INVALID_ARGUMENT"; errorName: "FileSizeFilterMissingGreaterThanAndLessThan"; errorDescription: "Both the gt and lt properties are missing from the FileSizeFilter. At least one of these properties must be present"; errorInstanceId: string; parameters: {}; } /** * The requested file is larger than the configured maximum download size. Contact Palantir Support to discuss limit increases. * * Log Safety: UNSAFE */ declare interface FileSizeLimitExceeded { errorCode: "INVALID_ARGUMENT"; errorName: "FileSizeLimitExceeded"; errorDescription: "The requested file is larger than the configured maximum download size. Contact Palantir Support to discuss limit increases."; errorInstanceId: string; parameters: { datasetRid: unknown; path: unknown; fileSizeBytes: unknown; maxFileSizeBytes: unknown; }; } /** * A file inside the .zip archive is too big. You must ensure that all files inside the .zip archive are within the limit. * * Log Safety: UNSAFE */ declare interface FileSizeLimitExceeded_2 { errorCode: "INVALID_ARGUMENT"; errorName: "FileSizeLimitExceeded"; errorDescription: "A file inside the .zip archive is too big. You must ensure that all files inside the .zip archive are within the limit."; errorInstanceId: string; parameters: { fileSizeBytesLimit: unknown; currentFileSizeBytes: unknown; currentFilePath: unknown; }; } /** * A file inside the .zip archive is too big. You must ensure that all files inside the .zip archive are within the limit. * * Log Safety: UNSAFE */ declare interface FileSizeLimitExceeded_3 { errorCode: "INVALID_ARGUMENT"; errorName: "FileSizeLimitExceeded"; errorDescription: "A file inside the .zip archive is too big. You must ensure that all files inside the .zip archive are within the limit."; errorInstanceId: string; parameters: { fileSizeBytesLimit: unknown; currentFileSizeBytes: unknown; currentFilePath: unknown; }; } /** * Pointer to the table in cloud object storage (e.g., Azure Data Lake Storage, Google Cloud Storage, S3). * * Log Safety: UNSAFE */ declare interface FilesVirtualTableConfig { format: FileFormat; path: string; } export declare namespace Filesystem { export { AccessRequirements, AddExternalResourceReferenceRequest, AddFilesystemResourceReferenceRequest, AddMarkingsRequest, AddOrganizationsRequest, AddProjectResourceReferencesRequest, AddResourceReferenceRequest, AddResourceRolesRequest, AddResourceTagsRequest, CreateFolderRequest, CreateProjectFromTemplateRequest, CreateProjectRequest, CreateSpaceRequest, Everyone, FileSystemId, Folder, FolderRid_2 as FolderRid, FolderType, GetByPathResourcesBatchRequestElement, GetByPathResourcesBatchResponse, GetFoldersBatchRequestElement, GetFoldersBatchResponse, GetRecentlyViewedResponse, GetResourcesBatchRequestElement, GetResourcesBatchResponse, IsDirectlyApplied, ListChildrenOfFolderResponse, ListMarkingsOfResourceResponse, ListOrganizationsOfProjectResponse, ListProjectResourceReferencesResponse, ListResourceRolesResponse, ListResourceTagsResponse, ListSpacesResponse, Marking_2 as Marking, Organization_2 as Organization, PrincipalIdOnly, PrincipalWithId, Project, ProjectExternalResourceReference, ProjectFilesystemResourceReference, ProjectResourceLevelRoleGrantsAllowed, ProjectResourceReference, ProjectResourceReferenceType, ProjectResourceReferenceUnion, ProjectRid, ProjectTemplateRid, ProjectTemplateVariableId, ProjectTemplateVariableValue, RecentlyViewedLimit, RecentlyViewedResource, RemoveMarkingsRequest, RemoveOrganizationsRequest, RemoveProjectResourceReferencesRequest, RemoveResourceRolesRequest, RemoveResourceTagsRequest, ReplaceFolderRequest, ReplaceProjectRequest, ReplaceSpaceRequest, Resource, ResourceDisplayName, ResourcePath, ResourceRid, ResourceRole, ResourceRoleIdentifier, ResourceRolePrincipal, ResourceRolePrincipalIdentifier, ResourceTag, ResourceTagDisplayName, ResourceType, Space, SpaceMavenIdentifier, SpaceRid, TagRid, TrashStatus, UsageAccountRid, AddGroupToParentGroupPermissionDenied, AddMarkingsPermissionDenied, AddOrganizationsPermissionDenied, AddProjectResourceReferencesPermissionDenied, AddResourceRolesPermissionDenied, AddResourceTagsPermissionDenied, CircularDependency, CreateFolderOutsideProjectNotSupported, CreateFolderPermissionDenied, CreateGroupPermissionDenied_2 as CreateGroupPermissionDenied, CreateProjectFromTemplatePermissionDenied, CreateProjectNoOwnerLikeRoleGrant, CreateProjectPermissionDenied, CreateSpacePermissionDenied, DefaultRolesNotInSpaceRoleSet, DeleteResourcePermissionDenied, DeleteSpacePermissionDenied, EnrollmentNotFound_2 as EnrollmentNotFound, FolderNotFound_2 as FolderNotFound, ForbiddenOperationOnAutosavedResource, ForbiddenOperationOnHiddenResource, GetAccessRequirementsPermissionDenied, GetByPathPermissionDenied, GetRecentlyViewedPermissionDenied, GetRootFolderNotSupported, GetSpaceResourceNotSupported, InvalidDefaultRoles, InvalidDescription, InvalidDisplayName, InvalidFolder, InvalidOrganizationHierarchy, InvalidOrganizations, InvalidParentFolder, InvalidPath, InvalidPrincipalIdsForGroupTemplate, InvalidProject, InvalidResourceReference, InvalidRoleIds, InvalidVariable, InvalidVariableEnumOption, MarkingNotFound_2 as MarkingNotFound, MissingDisplayName, MissingVariableValue, NotAuthorizedToApplyOrganization, OrganizationCannotBeRemoved, OrganizationMarkingNotOnSpace, OrganizationMarkingNotSupported, OrganizationsNotFound, PathNotFound, PermanentlyDeleteResourcePermissionDenied, ProjectCreationNotSupported, ProjectNameAlreadyExists, ProjectNotFound, ProjectTemplateNotFound, RecentlyViewedLimitBelowMinimum, RemoveMarkingsPermissionDenied, RemoveOrganizationsPermissionDenied, RemoveProjectResourceReferencesPermissionDenied, RemoveResourceRolesPermissionDenied, RemoveResourceTagsPermissionDenied, ReplaceFolderPermissionDenied, ReplaceProjectPermissionDenied, ReplaceSpacePermissionDenied, ReservedSpaceCannotBeReplaced, ResourceNameAlreadyExists_2 as ResourceNameAlreadyExists, ResourceNotDirectlyTrashed, ResourceNotFound, ResourceNotTrashed, RestoreResourcePermissionDenied, RoleSetNotFound, SpaceInternalError, SpaceInvalidArgument, SpaceNameInvalid, SpaceNotEmpty, SpaceNotFound, TagNotFound, TemplateGroupNameConflict, TemplateMarkingNameConflict, TrashingAutosavedResourcesNotSupported, TrashingHiddenResourcesNotSupported, TrashingSpaceNotSupported, UsageAccountServiceIsNotPresent, Folders, Projects, ProjectResourceReferences, Resources, ResourceRoles, ResourceTags, Spaces } } declare namespace _Filesystem { export { AccessRequirements, AddExternalResourceReferenceRequest, AddFilesystemResourceReferenceRequest, AddMarkingsRequest, AddOrganizationsRequest, AddProjectResourceReferencesRequest, AddResourceReferenceRequest, AddResourceRolesRequest, AddResourceTagsRequest, CreateFolderRequest, CreateProjectFromTemplateRequest, CreateProjectRequest, CreateSpaceRequest, Everyone, FileSystemId, Folder, FolderRid_2 as FolderRid, FolderType, GetByPathResourcesBatchRequestElement, GetByPathResourcesBatchResponse, GetFoldersBatchRequestElement, GetFoldersBatchResponse, GetRecentlyViewedResponse, GetResourcesBatchRequestElement, GetResourcesBatchResponse, IsDirectlyApplied, ListChildrenOfFolderResponse, ListMarkingsOfResourceResponse, ListOrganizationsOfProjectResponse, ListProjectResourceReferencesResponse, ListResourceRolesResponse, ListResourceTagsResponse, ListSpacesResponse, Marking_2 as Marking, Organization_2 as Organization, PrincipalIdOnly, PrincipalWithId, Project, ProjectExternalResourceReference, ProjectFilesystemResourceReference, ProjectResourceLevelRoleGrantsAllowed, ProjectResourceReference, ProjectResourceReferenceType, ProjectResourceReferenceUnion, ProjectRid, ProjectTemplateRid, ProjectTemplateVariableId, ProjectTemplateVariableValue, RecentlyViewedLimit, RecentlyViewedResource, RemoveMarkingsRequest, RemoveOrganizationsRequest, RemoveProjectResourceReferencesRequest, RemoveResourceRolesRequest, RemoveResourceTagsRequest, ReplaceFolderRequest, ReplaceProjectRequest, ReplaceSpaceRequest, Resource, ResourceDisplayName, ResourcePath, ResourceRid, ResourceRole, ResourceRoleIdentifier, ResourceRolePrincipal, ResourceRolePrincipalIdentifier, ResourceTag, ResourceTagDisplayName, ResourceType, Space, SpaceMavenIdentifier, SpaceRid, TagRid, TrashStatus, UsageAccountRid, AddGroupToParentGroupPermissionDenied, AddMarkingsPermissionDenied, AddOrganizationsPermissionDenied, AddProjectResourceReferencesPermissionDenied, AddResourceRolesPermissionDenied, AddResourceTagsPermissionDenied, CircularDependency, CreateFolderOutsideProjectNotSupported, CreateFolderPermissionDenied, CreateGroupPermissionDenied_2 as CreateGroupPermissionDenied, CreateProjectFromTemplatePermissionDenied, CreateProjectNoOwnerLikeRoleGrant, CreateProjectPermissionDenied, CreateSpacePermissionDenied, DefaultRolesNotInSpaceRoleSet, DeleteResourcePermissionDenied, DeleteSpacePermissionDenied, EnrollmentNotFound_2 as EnrollmentNotFound, FolderNotFound_2 as FolderNotFound, ForbiddenOperationOnAutosavedResource, ForbiddenOperationOnHiddenResource, GetAccessRequirementsPermissionDenied, GetByPathPermissionDenied, GetRecentlyViewedPermissionDenied, GetRootFolderNotSupported, GetSpaceResourceNotSupported, InvalidDefaultRoles, InvalidDescription, InvalidDisplayName, InvalidFolder, InvalidOrganizationHierarchy, InvalidOrganizations, InvalidParentFolder, InvalidPath, InvalidPrincipalIdsForGroupTemplate, InvalidProject, InvalidResourceReference, InvalidRoleIds, InvalidVariable, InvalidVariableEnumOption, MarkingNotFound_2 as MarkingNotFound, MissingDisplayName, MissingVariableValue, NotAuthorizedToApplyOrganization, OrganizationCannotBeRemoved, OrganizationMarkingNotOnSpace, OrganizationMarkingNotSupported, OrganizationsNotFound, PathNotFound, PermanentlyDeleteResourcePermissionDenied, ProjectCreationNotSupported, ProjectNameAlreadyExists, ProjectNotFound, ProjectTemplateNotFound, RecentlyViewedLimitBelowMinimum, RemoveMarkingsPermissionDenied, RemoveOrganizationsPermissionDenied, RemoveProjectResourceReferencesPermissionDenied, RemoveResourceRolesPermissionDenied, RemoveResourceTagsPermissionDenied, ReplaceFolderPermissionDenied, ReplaceProjectPermissionDenied, ReplaceSpacePermissionDenied, ReservedSpaceCannotBeReplaced, ResourceNameAlreadyExists_2 as ResourceNameAlreadyExists, ResourceNotDirectlyTrashed, ResourceNotFound, ResourceNotTrashed, RestoreResourcePermissionDenied, RoleSetNotFound, SpaceInternalError, SpaceInvalidArgument, SpaceNameInvalid, SpaceNotEmpty, SpaceNotFound, TagNotFound, TemplateGroupNameConflict, TemplateMarkingNameConflict, TrashingAutosavedResourcesNotSupported, TrashingHiddenResourcesNotSupported, TrashingSpaceNotSupported, UsageAccountServiceIsNotPresent, Folders, Projects, ProjectResourceReferences, Resources, ResourceRoles, ResourceTags, Spaces } } declare namespace _Filesystem_2 { export { LooselyBrandedString_7 as LooselyBrandedString, AccessRequirements, AddExternalResourceReferenceRequest, AddFilesystemResourceReferenceRequest, AddMarkingsRequest, AddOrganizationsRequest, AddProjectResourceReferencesRequest, AddResourceReferenceRequest, AddResourceRolesRequest, AddResourceTagsRequest, CreateFolderRequest, CreateProjectFromTemplateRequest, CreateProjectRequest, CreateSpaceRequest, Everyone, FileSystemId, Folder, FolderRid_2 as FolderRid, FolderType, GetByPathResourcesBatchRequestElement, GetByPathResourcesBatchResponse, GetFoldersBatchRequestElement, GetFoldersBatchResponse, GetRecentlyViewedResponse, GetResourcesBatchRequestElement, GetResourcesBatchResponse, IsDirectlyApplied, ListChildrenOfFolderResponse, ListMarkingsOfResourceResponse, ListOrganizationsOfProjectResponse, ListProjectResourceReferencesResponse, ListResourceRolesResponse, ListResourceTagsResponse, ListSpacesResponse, Marking_2 as Marking, Organization_2 as Organization, PrincipalIdOnly, PrincipalWithId, Project, ProjectExternalResourceReference, ProjectFilesystemResourceReference, ProjectResourceLevelRoleGrantsAllowed, ProjectResourceReference, ProjectResourceReferenceType, ProjectResourceReferenceUnion, ProjectRid, ProjectTemplateRid, ProjectTemplateVariableId, ProjectTemplateVariableValue, RecentlyViewedLimit, RecentlyViewedResource, RemoveMarkingsRequest, RemoveOrganizationsRequest, RemoveProjectResourceReferencesRequest, RemoveResourceRolesRequest, RemoveResourceTagsRequest, ReplaceFolderRequest, ReplaceProjectRequest, ReplaceSpaceRequest, Resource, ResourceDisplayName, ResourcePath, ResourceRid, ResourceRole, ResourceRoleIdentifier, ResourceRolePrincipal, ResourceRolePrincipalIdentifier, ResourceTag, ResourceTagDisplayName, ResourceType, Space, SpaceMavenIdentifier, SpaceRid, TagRid, TrashStatus, UsageAccountRid } } /** * The ID of the filesystem that will be used for all projects in the Space. * * Log Safety: SAFE */ declare type FileSystemId = LooselyBrandedString_7<"FileSystemId">; /** * Log Safety: SAFE */ declare interface FilesystemResource { } /** * The file system backing storage for documents of this type. Documents can currently be stored in Gotham Artifacts or in Compass. * * Log Safety: SAFE */ declare type FileSystemType = "ARTIFACTS" | "COMPASS"; /** * Log Safety: UNSAFE */ declare type FileUpdatedTime = string; /** * Log Safety: SAFE */ declare interface FilterBinaryType { } /** * Log Safety: SAFE */ declare interface FilterBooleanType { } /** * Log Safety: SAFE */ declare interface FilterDateTimeType { } /** * Log Safety: SAFE */ declare interface FilterDateType { } /** * Log Safety: SAFE */ declare interface FilterDoubleType { } /** * Log Safety: SAFE */ declare interface FilterEnumType { values: Array; } /** * Log Safety: SAFE */ declare interface FilterFloatType { } /** * Log Safety: SAFE */ declare interface FilterIntegerType { } /** * Log Safety: SAFE */ declare interface FilterLongType { } /** * Log Safety: SAFE */ declare interface FilterRidType { } /** * Log Safety: SAFE */ declare interface FilterStringType { } /** * Log Safety: SAFE */ declare type FilterType = ({ type: "dateTime"; } & FilterDateTimeType) | ({ type: "date"; } & FilterDateType) | ({ type: "boolean"; } & FilterBooleanType) | ({ type: "string"; } & FilterStringType) | ({ type: "double"; } & FilterDoubleType) | ({ type: "binary"; } & FilterBinaryType) | ({ type: "integer"; } & FilterIntegerType) | ({ type: "float"; } & FilterFloatType) | ({ type: "rid"; } & FilterRidType) | ({ type: "uuid"; } & FilterUuidType) | ({ type: "enum"; } & FilterEnumType) | ({ type: "long"; } & FilterLongType); /** * Log Safety: SAFE */ declare interface FilterUuidType { } /** * Represents the value of a property filter. For instance, false is the FilterValue in properties.{propertyApiName}.isNull=false. * * Log Safety: UNSAFE */ declare type FilterValue = LooselyBrandedString_5<"FilterValue">; /** * An absolute datetime bound (ISO 8601 timestamp or date string). * * Log Safety: UNSAFE */ declare interface FixedDatetimeValue { value: ParameterConstraintValue; } /** * Integer key for fixed value mapping. * * Log Safety: SAFE */ declare type FixedValuesMapKey = number; /** * The flip axis from EXIF orientation. * * Log Safety: SAFE */ declare type FlipAxis = "HORIZONTAL" | "VERTICAL" | "UNKNOWN"; /** * Log Safety: SAFE */ declare interface FloatType { } /** * Log Safety: SAFE */ declare interface FloatType_2 { } /** * Log Safety: UNSAFE */ declare interface Folder { rid: FolderRid_2; displayName: ResourceDisplayName; description?: string; documentation?: string; path: ResourcePath; type: FolderType; createdBy: _Core.CreatedBy; updatedBy: _Core.UpdatedBy; createdTime: _Core.CreatedTime; updatedTime: _Core.UpdatedTime; trashStatus: TrashStatus; parentFolderRid: FolderRid_2; projectRid?: ProjectRid; spaceRid: SpaceRid; } /** * The requested folder could not be found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface FolderNotFound { errorCode: "NOT_FOUND"; errorName: "FolderNotFound"; errorDescription: "The requested folder could not be found, or the client token does not have access to it."; errorInstanceId: string; parameters: { folderRid: unknown; }; } /** * The given Folder could not be found. * * Log Safety: SAFE */ declare interface FolderNotFound_2 { errorCode: "NOT_FOUND"; errorName: "FolderNotFound"; errorDescription: "The given Folder could not be found."; errorInstanceId: string; parameters: { folderRid: unknown; }; } /** * Log Safety: UNSAFE */ declare type FolderRid = LooselyBrandedString<"FolderRid">; /** * The unique resource identifier (RID) of a Folder. * * Log Safety: SAFE */ declare type FolderRid_2 = LooselyBrandedString_7<"FolderRid">; /** * The unique resource identifier (RID) of a Folder. * * Log Safety: SAFE */ declare type FolderRid_3 = LooselyBrandedString_6<"FolderRid">; /** * The unique resource identifier (RID) of a Folder. * * Log Safety: SAFE */ declare type FolderRid_4 = LooselyBrandedString_12<"FolderRid">; /** * The unique resource identifier (RID) of a Folder. * * Log Safety: SAFE */ declare type FolderRid_5 = LooselyBrandedString_19<"FolderRid">; export declare namespace Folders { export { create_5 as create, get_14 as get, getBatch_5 as getBatch, children } } /** * A folder can be a regular Folder, a Project or a Space. * * Log Safety: SAFE */ declare type FolderType = "FOLDER" | "SPACE" | "PROJECT"; /** * Performing this operation on an autosaved resource is not supported. * * Log Safety: UNSAFE */ declare interface ForbiddenOperationOnAutosavedResource { errorCode: "INVALID_ARGUMENT"; errorName: "ForbiddenOperationOnAutosavedResource"; errorDescription: "Performing this operation on an autosaved resource is not supported."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Performing this operation on a hidden resource is not supported. * * Log Safety: UNSAFE */ declare interface ForbiddenOperationOnHiddenResource { errorCode: "INVALID_ARGUMENT"; errorName: "ForbiddenOperationOnHiddenResource"; errorDescription: "Performing this operation on a hidden resource is not supported."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Whether to ignore staleness information when running the build. * * Log Safety: SAFE */ declare type ForceBuild = boolean; /** * The Foundry branch identifier, specifically its rid. Different identifier types may be used in the future as values. * * Log Safety: SAFE */ declare type FoundryBranch = LooselyBrandedString<"FoundryBranch">; /** * The requested foundry branch could not be found, or the client token does not have access to it. * * Log Safety: SAFE */ declare interface FoundryBranchNotFound { errorCode: "NOT_FOUND"; errorName: "FoundryBranchNotFound"; errorDescription: "The requested foundry branch could not be found, or the client token does not have access to it."; errorInstanceId: string; parameters: { branch: unknown; }; } /** * Log Safety: UNSAFE */ declare interface FoundryLiveDeployment { rid?: string; inputParamName?: string; outputParamName?: string; } /** * A unique identifier of a Foundry object property. * * Log Safety: SAFE */ declare type FoundryObjectPropertyTypeRid = LooselyBrandedString<"FoundryObjectPropertyTypeRid">; /** * A unique identifier of a Foundry object type. * * Log Safety: SAFE */ declare type FoundryObjectTypeRid = LooselyBrandedString<"FoundryObjectTypeRid">; /** * The Foundry worker is used to run capabilities in Foundry. This is the preferred method for connections, as these connections benefit from Foundry's containerized and scalable job execution, improved stability and do not incur the maintenance overhead associated with agents. * * Log Safety: SAFE */ declare interface FoundryWorker { networkEgressPolicyRids: Array<_Core.NetworkEgressPolicyRid>; } /** * Configuration for change data capture which resolves the latest state of the dataset based on new full rows being pushed to the stream. For example, if a value for a row is updated, it is only sufficient to publish the entire new state of that row to the stream. * * Log Safety: UNSAFE */ declare interface FullRowChangeDataCaptureConfiguration { deletionFieldName: FieldName; orderingFieldName: FieldName; } /** * 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. * * Log Safety: UNSAFE */ declare interface FullTextStringContainsPredicate { value: string; } /** * Matches strings representing the same sequence of characters as the given string. * * Log Safety: UNSAFE */ declare interface FullTextStringExactPredicate { value: string; } /** * A predicate for matching strings. * * Log Safety: UNSAFE */ declare type FullTextStringPredicateV2 = ({ type: "contains"; } & FullTextStringContainsPredicate) | ({ type: "exact"; } & FullTextStringExactPredicate); /** * A function already exists for this model. * * Log Safety: SAFE */ declare interface FunctionAlreadyExists { errorCode: "CONFLICT"; errorName: "FunctionAlreadyExists"; errorDescription: "A function already exists for this model."; errorInstanceId: string; parameters: { modelRid: unknown; }; } /** * The authored function failed to execute because of a user induced error. The message argument is meant to be displayed to the user. * * Log Safety: UNSAFE */ declare interface FunctionEncounteredUserFacingError { errorCode: "INVALID_ARGUMENT"; errorName: "FunctionEncounteredUserFacingError"; errorDescription: "The authored function failed to execute because of a user induced error. The message argument is meant to be displayed to the user."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; }; } /** * Log Safety: UNSAFE */ declare interface FunctionExecutionFailed { errorCode: "INVALID_ARGUMENT"; errorName: "FunctionExecutionFailed"; errorDescription: ""; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; stacktrace: unknown; }; } /** * Log Safety: UNSAFE */ declare interface FunctionExecutionTimedOut { errorCode: "INVALID_ARGUMENT"; errorName: "FunctionExecutionTimedOut"; errorDescription: ""; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * The query function has no published versions. * * Log Safety: SAFE */ declare interface FunctionHasNoPublishedVersion { errorCode: "NOT_FOUND"; errorName: "FunctionHasNoPublishedVersion"; errorDescription: "The query function has no published versions."; errorInstanceId: string; parameters: { functionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface FunctionInvalidInput { errorCode: "INVALID_ARGUMENT"; errorName: "FunctionInvalidInput"; errorDescription: ""; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. * * Log Safety: UNSAFE */ declare interface FunctionLocatorNotFound { errorCode: "NOT_FOUND"; errorName: "FunctionLocatorNotFound"; errorDescription: "The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; functionRid: unknown; functionVersion: unknown; }; } /** * Log Safety: UNSAFE */ declare interface FunctionLogicRule { functionRid: FunctionRid; functionVersion: FunctionVersion; functionInputValues: Record; } /** * The query function could not be found. * * Log Safety: SAFE */ declare interface FunctionNotFound { errorCode: "NOT_FOUND"; errorName: "FunctionNotFound"; errorDescription: "The query function could not be found."; errorInstanceId: string; parameters: { functionRid: unknown; }; } /** * The function runtime does not support execution with a transaction. * * Log Safety: UNSAFE */ declare interface FunctionNotSupportedWithTransaction { errorCode: "INVALID_ARGUMENT"; errorName: "FunctionNotSupportedWithTransaction"; errorDescription: "The function runtime does not support execution with a transaction."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; }; } /** * The function runtime does not support execution with a transaction. * * Log Safety: UNSAFE */ declare interface FunctionNotSupportedWithTransaction_2 { errorCode: "INVALID_ARGUMENT"; errorName: "FunctionNotSupportedWithTransaction"; errorDescription: "The function runtime does not support execution with a transaction."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; }; } /** * The name of an input to a function. * * Log Safety: UNSAFE */ declare type FunctionParameterName = LooselyBrandedString_5<"FunctionParameterName">; /** * Context retrieved from running a function to include as additional context in the prompt to the Agent. * * Log Safety: UNSAFE */ declare interface FunctionRetrievedContext { functionRid: _Functions.FunctionRid; functionVersion: _Functions.FunctionVersion; retrievedPrompt: string; } /** * The unique resource identifier of a Function, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type FunctionRid = LooselyBrandedString_5<"FunctionRid">; /** * The unique resource identifier of a Function, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type FunctionRid_2 = LooselyBrandedString_9<"FunctionRid">; /** * Returns action types which use the function with the given rid. * * Log Safety: SAFE */ declare interface FunctionRidActionTypesQueryV2 { value: FunctionRid; } export declare namespace Functions { export { ArrayConstraint_2 as ArrayConstraint, CancelExecutionResponse, DataValue_2 as DataValue, EnumConstraint_2 as EnumConstraint, ExecuteAsyncQueryRequest, ExecuteQueryAsyncResponse, ExecuteQueryRequest_2 as ExecuteQueryRequest, ExecuteQueryResponse_2 as ExecuteQueryResponse, Execution, ExecutionCompleted, ExecutionId, ExecutionSubmitted, FunctionRid_2 as FunctionRid, FunctionVersion_2 as FunctionVersion, GetByRidQueriesBatchRequestElement, GetByRidQueriesBatchResponse, GetExecutionResultResponse, GetResultExecutionRequest, IncludePrerelease, LatestVersionResolution, LengthConstraint_2 as LengthConstraint, MapConstraint, NullableConstraint, NullableConstraintValue, Parameter_3 as Parameter, ParameterId_3 as ParameterId, Query_2 as Query, QueryAggregationKeyType_2 as QueryAggregationKeyType, QueryAggregationRangeSubType_2 as QueryAggregationRangeSubType, QueryAggregationRangeType_2 as QueryAggregationRangeType, QueryAggregationValueType_2 as QueryAggregationValueType, QueryApiName_2 as QueryApiName, QueryArrayType_2 as QueryArrayType, QueryDataType_2 as QueryDataType, QueryRuntimeErrorParameter_2 as QueryRuntimeErrorParameter, QuerySetType_2 as QuerySetType, QueryStructField_2 as QueryStructField, QueryStructType_2 as QueryStructType, QueryTypeReferenceType_2 as QueryTypeReferenceType, QueryUnionType_2 as QueryUnionType, RangesConstraint_2 as RangesConstraint, RegexConstraint_2 as RegexConstraint, RidConstraint_2 as RidConstraint, RunningExecution, StreamingExecuteEventsQueryRequest, StreamingExecuteQueryRequest, StreamingExecuteQueryResponse, StreamingQueryData, StreamingQueryError, StructConstraint_2 as StructConstraint, StructFieldApiName_3 as StructFieldApiName, StructFieldName_2 as StructFieldName, StructV1Constraint, SucceededExecution, ThreeDimensionalAggregation_2 as ThreeDimensionalAggregation, TransactionId, TwoDimensionalAggregation_2 as TwoDimensionalAggregation, TypeReferenceIdentifier_2 as TypeReferenceIdentifier, UuidConstraint_2 as UuidConstraint, ValueType_2 as ValueType, ValueTypeApiName_2 as ValueTypeApiName, ValueTypeConstraint_2 as ValueTypeConstraint, ValueTypeDataType, ValueTypeDataTypeArrayType, ValueTypeDataTypeBinaryType, ValueTypeDataTypeBooleanType, ValueTypeDataTypeByteType, ValueTypeDataTypeDateType, ValueTypeDataTypeDecimalType, ValueTypeDataTypeDoubleType, ValueTypeDataTypeFloatType, ValueTypeDataTypeIntegerType, ValueTypeDataTypeLongType, ValueTypeDataTypeMapType, ValueTypeDataTypeOptionalType, ValueTypeDataTypeShortType, ValueTypeDataTypeStringType, ValueTypeDataTypeStructElement, ValueTypeDataTypeStructFieldIdentifier, ValueTypeDataTypeStructType, ValueTypeDataTypeTimestampType, ValueTypeDataTypeUnionType, ValueTypeDataTypeValueTypeReference, ValueTypeDescription, ValueTypeReference, ValueTypeRid_2 as ValueTypeRid, ValueTypeVersion, ValueTypeVersionId_2 as ValueTypeVersionId, VersionId_2 as VersionId, AsyncConsistentSnapshotError, AsyncFunctionNotSupportedWithTransaction, AsyncInvalidQueryOutputValue, AsyncQueryEncounteredUserFacingError, AsyncQueryMemoryExceededLimit, AsyncQueryRuntimeError, AsyncQueryTimeExceededLimit, CancelExecutionNotSupported, CancelExecutionPermissionDenied, ConsistentSnapshotError_2 as ConsistentSnapshotError, ExecuteAsyncQueryPermissionDenied, ExecuteQueryPermissionDenied, ExecutionNotFound, FunctionHasNoPublishedVersion, FunctionNotFound, FunctionNotSupportedWithTransaction_2 as FunctionNotSupportedWithTransaction, GetByRidPermissionDenied, GetResultExecutionPermissionDenied, InvalidQueryOutputValue_2 as InvalidQueryOutputValue, InvalidQueryParameterValue_2 as InvalidQueryParameterValue, InvalidVersionResolutionParameters, MissingParameter_2 as MissingParameter, QueryEncounteredUserFacingError_2 as QueryEncounteredUserFacingError, QueryMemoryExceededLimit_2 as QueryMemoryExceededLimit, QueryNotFound_2 as QueryNotFound, QueryRuntimeError_2 as QueryRuntimeError, QueryTimeExceededLimit_2 as QueryTimeExceededLimit, QueryVersionNotFound_2 as QueryVersionNotFound, StreamingExecuteEventsQueryPermissionDenied, StreamingExecuteQueryPermissionDenied, UnknownParameter_2 as UnknownParameter, ValueTypeNotFound_2 as ValueTypeNotFound, VersionIdNotFound, Executions, Queries_2 as Queries, ValueTypes, VersionIds } } declare namespace _Functions { export { ArrayConstraint_2 as ArrayConstraint, CancelExecutionResponse, DataValue_2 as DataValue, EnumConstraint_2 as EnumConstraint, ExecuteAsyncQueryRequest, ExecuteQueryAsyncResponse, ExecuteQueryRequest_2 as ExecuteQueryRequest, ExecuteQueryResponse_2 as ExecuteQueryResponse, Execution, ExecutionCompleted, ExecutionId, ExecutionSubmitted, FunctionRid_2 as FunctionRid, FunctionVersion_2 as FunctionVersion, GetByRidQueriesBatchRequestElement, GetByRidQueriesBatchResponse, GetExecutionResultResponse, GetResultExecutionRequest, IncludePrerelease, LatestVersionResolution, LengthConstraint_2 as LengthConstraint, MapConstraint, NullableConstraint, NullableConstraintValue, Parameter_3 as Parameter, ParameterId_3 as ParameterId, Query_2 as Query, QueryAggregationKeyType_2 as QueryAggregationKeyType, QueryAggregationRangeSubType_2 as QueryAggregationRangeSubType, QueryAggregationRangeType_2 as QueryAggregationRangeType, QueryAggregationValueType_2 as QueryAggregationValueType, QueryApiName_2 as QueryApiName, QueryArrayType_2 as QueryArrayType, QueryDataType_2 as QueryDataType, QueryRuntimeErrorParameter_2 as QueryRuntimeErrorParameter, QuerySetType_2 as QuerySetType, QueryStructField_2 as QueryStructField, QueryStructType_2 as QueryStructType, QueryTypeReferenceType_2 as QueryTypeReferenceType, QueryUnionType_2 as QueryUnionType, RangesConstraint_2 as RangesConstraint, RegexConstraint_2 as RegexConstraint, RidConstraint_2 as RidConstraint, RunningExecution, StreamingExecuteEventsQueryRequest, StreamingExecuteQueryRequest, StreamingExecuteQueryResponse, StreamingQueryData, StreamingQueryError, StructConstraint_2 as StructConstraint, StructFieldApiName_3 as StructFieldApiName, StructFieldName_2 as StructFieldName, StructV1Constraint, SucceededExecution, ThreeDimensionalAggregation_2 as ThreeDimensionalAggregation, TransactionId, TwoDimensionalAggregation_2 as TwoDimensionalAggregation, TypeReferenceIdentifier_2 as TypeReferenceIdentifier, UuidConstraint_2 as UuidConstraint, ValueType_2 as ValueType, ValueTypeApiName_2 as ValueTypeApiName, ValueTypeConstraint_2 as ValueTypeConstraint, ValueTypeDataType, ValueTypeDataTypeArrayType, ValueTypeDataTypeBinaryType, ValueTypeDataTypeBooleanType, ValueTypeDataTypeByteType, ValueTypeDataTypeDateType, ValueTypeDataTypeDecimalType, ValueTypeDataTypeDoubleType, ValueTypeDataTypeFloatType, ValueTypeDataTypeIntegerType, ValueTypeDataTypeLongType, ValueTypeDataTypeMapType, ValueTypeDataTypeOptionalType, ValueTypeDataTypeShortType, ValueTypeDataTypeStringType, ValueTypeDataTypeStructElement, ValueTypeDataTypeStructFieldIdentifier, ValueTypeDataTypeStructType, ValueTypeDataTypeTimestampType, ValueTypeDataTypeUnionType, ValueTypeDataTypeValueTypeReference, ValueTypeDescription, ValueTypeReference, ValueTypeRid_2 as ValueTypeRid, ValueTypeVersion, ValueTypeVersionId_2 as ValueTypeVersionId, VersionId_2 as VersionId, AsyncConsistentSnapshotError, AsyncFunctionNotSupportedWithTransaction, AsyncInvalidQueryOutputValue, AsyncQueryEncounteredUserFacingError, AsyncQueryMemoryExceededLimit, AsyncQueryRuntimeError, AsyncQueryTimeExceededLimit, CancelExecutionNotSupported, CancelExecutionPermissionDenied, ConsistentSnapshotError_2 as ConsistentSnapshotError, ExecuteAsyncQueryPermissionDenied, ExecuteQueryPermissionDenied, ExecutionNotFound, FunctionHasNoPublishedVersion, FunctionNotFound, FunctionNotSupportedWithTransaction_2 as FunctionNotSupportedWithTransaction, GetByRidPermissionDenied, GetResultExecutionPermissionDenied, InvalidQueryOutputValue_2 as InvalidQueryOutputValue, InvalidQueryParameterValue_2 as InvalidQueryParameterValue, InvalidVersionResolutionParameters, MissingParameter_2 as MissingParameter, QueryEncounteredUserFacingError_2 as QueryEncounteredUserFacingError, QueryMemoryExceededLimit_2 as QueryMemoryExceededLimit, QueryNotFound_2 as QueryNotFound, QueryRuntimeError_2 as QueryRuntimeError, QueryTimeExceededLimit_2 as QueryTimeExceededLimit, QueryVersionNotFound_2 as QueryVersionNotFound, StreamingExecuteEventsQueryPermissionDenied, StreamingExecuteQueryPermissionDenied, UnknownParameter_2 as UnknownParameter, ValueTypeNotFound_2 as ValueTypeNotFound, VersionIdNotFound, Executions, Queries_2 as Queries, ValueTypes, VersionIds } } declare namespace _Functions_2 { export { LooselyBrandedString_9 as LooselyBrandedString, ArrayConstraint_2 as ArrayConstraint, CancelExecutionResponse, DataValue_2 as DataValue, EnumConstraint_2 as EnumConstraint, ExecuteAsyncQueryRequest, ExecuteQueryAsyncResponse, ExecuteQueryRequest_2 as ExecuteQueryRequest, ExecuteQueryResponse_2 as ExecuteQueryResponse, Execution, ExecutionCompleted, ExecutionId, ExecutionSubmitted, FunctionRid_2 as FunctionRid, FunctionVersion_2 as FunctionVersion, GetByRidQueriesBatchRequestElement, GetByRidQueriesBatchResponse, GetExecutionResultResponse, GetResultExecutionRequest, IncludePrerelease, LatestVersionResolution, LengthConstraint_2 as LengthConstraint, MapConstraint, NullableConstraint, NullableConstraintValue, Parameter_3 as Parameter, ParameterId_3 as ParameterId, Query_2 as Query, QueryAggregationKeyType_2 as QueryAggregationKeyType, QueryAggregationRangeSubType_2 as QueryAggregationRangeSubType, QueryAggregationRangeType_2 as QueryAggregationRangeType, QueryAggregationValueType_2 as QueryAggregationValueType, QueryApiName_2 as QueryApiName, QueryArrayType_2 as QueryArrayType, QueryDataType_2 as QueryDataType, QueryRuntimeErrorParameter_2 as QueryRuntimeErrorParameter, QuerySetType_2 as QuerySetType, QueryStructField_2 as QueryStructField, QueryStructType_2 as QueryStructType, QueryTypeReferenceType_2 as QueryTypeReferenceType, QueryUnionType_2 as QueryUnionType, RangesConstraint_2 as RangesConstraint, RegexConstraint_2 as RegexConstraint, RidConstraint_2 as RidConstraint, RunningExecution, StreamingExecuteEventsQueryRequest, StreamingExecuteQueryRequest, StreamingExecuteQueryResponse, StreamingQueryData, StreamingQueryError, StructConstraint_2 as StructConstraint, StructFieldApiName_3 as StructFieldApiName, StructFieldName_2 as StructFieldName, StructV1Constraint, SucceededExecution, ThreeDimensionalAggregation_2 as ThreeDimensionalAggregation, TransactionId, TwoDimensionalAggregation_2 as TwoDimensionalAggregation, TypeReferenceIdentifier_2 as TypeReferenceIdentifier, UuidConstraint_2 as UuidConstraint, ValueType_2 as ValueType, ValueTypeApiName_2 as ValueTypeApiName, ValueTypeConstraint_2 as ValueTypeConstraint, ValueTypeDataType, ValueTypeDataTypeArrayType, ValueTypeDataTypeBinaryType, ValueTypeDataTypeBooleanType, ValueTypeDataTypeByteType, ValueTypeDataTypeDateType, ValueTypeDataTypeDecimalType, ValueTypeDataTypeDoubleType, ValueTypeDataTypeFloatType, ValueTypeDataTypeIntegerType, ValueTypeDataTypeLongType, ValueTypeDataTypeMapType, ValueTypeDataTypeOptionalType, ValueTypeDataTypeShortType, ValueTypeDataTypeStringType, ValueTypeDataTypeStructElement, ValueTypeDataTypeStructFieldIdentifier, ValueTypeDataTypeStructType, ValueTypeDataTypeTimestampType, ValueTypeDataTypeUnionType, ValueTypeDataTypeValueTypeReference, ValueTypeDescription, ValueTypeReference, ValueTypeRid_2 as ValueTypeRid, ValueTypeVersion, ValueTypeVersionId_2 as ValueTypeVersionId, VersionId_2 as VersionId } } /** * The version of the given Function, written ..-, where - is optional. Examples: 1.2.3, 1.2.3-rc1. * * Log Safety: UNSAFE */ declare type FunctionVersion = LooselyBrandedString_5<"FunctionVersion">; /** * The version of the given Function, written ..-, where - is optional. Examples: 1.2.3, 1.2.3-rc1. * * Log Safety: UNSAFE */ declare type FunctionVersion_2 = LooselyBrandedString_9<"FunctionVersion">; /** * Fuzzy search is activated, which can help discover additional results based on small differences in spelling, although some additional results may be less relevant. * * Log Safety: SAFE */ declare interface FuzzinessAuto { } /** * Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are not returned. * * Log Safety: SAFE */ declare interface FuzzinessOff { } /** * Setting fuzzy to true allows approximate matching in search queries that support it. * * Log Safety: SAFE */ declare type Fuzzy = boolean; /** * Matches intervals containing terms that are similar to the provided term, within an edit distance defined by fuzziness. An edit is a single character change needed to make a term match, including character insertion, deletion, substitution, or transposition of two adjacent characters. * * Log Safety: UNSAFE */ declare interface FuzzyRule { term: string; fuzziness?: number; } /** * @deprecated Use `FuzzyV2` in the `foundry.ontologies` package * * Setting fuzzy to true allows approximate matching in search queries that support it. * * Log Safety: SAFE */ declare type FuzzyV2 = boolean; /** * Setting fuzzy to true allows approximate matching in search queries that support it. * * Log Safety: SAFE */ declare type FuzzyV2_2 = boolean; /** * A list of ground control points for geo-referencing. * * Log Safety: UNSAFE */ declare interface GcpList { gcps: Array; } /* Excluded from this release type: generate */ /** * Generates a vector embedding for an image using the specified model. * * Log Safety: SAFE */ declare interface GenerateEmbeddingOperation { modelId: AvailableEmbeddingModelIds; } /** * Could not generate the Template. * * Log Safety: SAFE */ declare interface GenerateTemplatePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GenerateTemplatePermissionDenied"; errorDescription: "Could not generate the Template."; errorInstanceId: string; parameters: { templateRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface GenerateTemplateRequest { templateVersion?: TemplateVersion; templateParameters: Record; } /** * Log Safety: UNSAFE */ declare interface GenerationJob { rid: GenerationJobRid; status: GenerationJobStatus; } /** * The generation job failed * * Log Safety: UNSAFE */ declare interface GenerationJobFailed { errorMessage: string; } /** * The given GenerationJob could not be found. * * Log Safety: SAFE */ declare interface GenerationJobNotFound { errorCode: "NOT_FOUND"; errorName: "GenerationJobNotFound"; errorDescription: "The given GenerationJob could not be found."; errorInstanceId: string; parameters: { generationJobRid: unknown; templateRid: unknown; }; } /** * The unique identifier for a GenerationJob * * Log Safety: SAFE */ declare type GenerationJobRid = LooselyBrandedString_17<"GenerationJobRid">; /** * The generation job is currently running * * Log Safety: SAFE */ declare interface GenerationJobRunning { } export declare namespace GenerationJobs { export { } } /** * The status of a GenerationJob * * Log Safety: UNSAFE */ declare type GenerationJobStatus = ({ type: "running"; } & GenerationJobRunning) | ({ type: "failed"; } & GenerationJobFailed) | ({ type: "succeeded"; } & GenerationJobSucceeded); /** * The operation cannot be completed because the generation job has failed status. * * Log Safety: SAFE */ declare interface GenerationJobStatusFailed { errorCode: "FAILED_PRECONDITION"; errorName: "GenerationJobStatusFailed"; errorDescription: "The operation cannot be completed because the generation job has failed status."; errorInstanceId: string; parameters: { generationJobRid: unknown; }; } /** * The operation cannot be completed because the generation job has running status. * * Log Safety: SAFE */ declare interface GenerationJobStatusRunning { errorCode: "FAILED_PRECONDITION"; errorName: "GenerationJobStatusRunning"; errorDescription: "The operation cannot be completed because the generation job has running status."; errorInstanceId: string; parameters: { generationJobRid: unknown; }; } /** * The generation job succeeded * * Log Safety: SAFE */ declare interface GenerationJobSucceeded { } export declare namespace Geo { export { BBox, Coordinate, Feature, FeatureCollection, FeatureCollectionTypes, FeaturePropertyKey, GeoJsonObject, Geometry, GeometryCollection, GeoPoint, LinearRing, LineString, LineStringCoordinates, MultiLineString, MultiPoint, MultiPolygon, Polygon, Position } } declare namespace _Geo { export { BBox, Coordinate, Feature, FeatureCollection, FeatureCollectionTypes, FeaturePropertyKey, GeoJsonObject, Geometry, GeometryCollection, GeoPoint, LinearRing, LineString, LineStringCoordinates, MultiLineString, MultiPoint, MultiPolygon, Polygon, Position } } /** * Log Safety: SAFE */ declare interface GeohashType { } /** * GeoJSon object The coordinate reference system for all GeoJSON coordinates is a geographic coordinate reference system, using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium (OGC) URN An OPTIONAL third-position element SHALL be the height in meters above or below the WGS 84 reference ellipsoid. In the absence of elevation values, applications sensitive to height or depth SHOULD interpret positions as being at local ground or sea level. * * Log Safety: UNSAFE */ declare type GeoJsonObject = ({ type: "MultiPoint"; } & MultiPoint) | ({ type: "GeometryCollection"; } & GeometryCollection) | ({ type: "MultiLineString"; } & MultiLineString) | ({ type: "FeatureCollection"; } & FeatureCollection) | ({ type: "LineString"; } & LineString) | ({ type: "MultiPolygon"; } & MultiPolygon) | ({ type: "Point"; } & GeoPoint) | ({ type: "Polygon"; } & Polygon) | ({ type: "Feature"; } & Feature); /** * A GeoJSON geometry specification. * * Log Safety: UNSAFE */ declare interface GeoJsonString { geoJson: string; } /** * Embedded geo-referencing data for an image. * * Log Safety: UNSAFE */ declare interface GeoMetadata { crs?: CoordinateReferenceSystem; geotransform?: AffineTransform; gcpInfo?: GcpList; gpsData?: GpsMetadata; } /** * Abstract type for all GeoJSon object except Feature and FeatureCollection * * Log Safety: UNSAFE */ declare type Geometry = ({ type: "MultiPoint"; } & MultiPoint) | ({ type: "GeometryCollection"; } & GeometryCollection) | ({ type: "MultiLineString"; } & MultiLineString) | ({ type: "LineString"; } & LineString) | ({ type: "MultiPolygon"; } & MultiPolygon) | ({ type: "Point"; } & GeoPoint) | ({ type: "Polygon"; } & Polygon); /** * GeoJSon geometry collection GeometryCollections composed of a single part or a number of parts of a single type SHOULD be avoided when that single part or a single object of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could be used instead. * * Log Safety: UNSAFE */ declare interface GeometryCollection { geometries: Array; bbox?: BBox; } /** * Log Safety: UNSAFE */ declare interface GeoPoint { coordinates: Position; bbox?: BBox; } /** * A point representing a latitude-longitude pair, with an option of adding elevation. * * Log Safety: UNSAFE */ declare interface GeoPoint_2 { longitude: number; latitude: number; elevation?: number; } /** * Log Safety: SAFE */ declare interface GeoPointType { } /** * Log Safety: SAFE */ declare interface GeoShapeType { } /** * Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries. * * Log Safety: UNSAFE */ declare type GeoShapeV2Geometry = ({ type: "envelope"; } & BoundingBoxValue_2) | ({ type: "geoJson"; } & GeoJsonString); /** * Returns objects where the specified field satisfies the provided geometry query with the given spatial operator. Supports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties. Either field or propertyIdentifier can be supplied, but not both. * * Log Safety: UNSAFE */ declare interface GeoShapeV2Query { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; geometry: GeoShapeV2Geometry; spatialFilterMode: SpatialFilterMode; } /** * A single geotemporal data point. Each entry is a map from property API names to property values. Standard entries include "time" (ISO 8601 timestamp) and "position" (GeoPoint), and may include additional geotemporal series metadata fields such as speed, heading, or altitude. * * Log Safety: UNSAFE */ declare type GeotemporalSeriesEntry = Record; export declare namespace GeotemporalSeriesProperties { export { } } /** * Log Safety: UNSAFE */ declare type GeotemporalSeriesProperty = LooselyBrandedString_5<"GeotemporalSeriesProperty">; /** * The unique id of a geotime series (track) associated with a GTSR. * * Log Safety: UNSAFE */ declare type GeotimeSeriesId = LooselyBrandedString_5<"GeotimeSeriesId">; /** * The unique resource identifier of a geotime integration. * * Log Safety: SAFE */ declare type GeotimeSeriesIntegrationRid = LooselyBrandedString_5<"GeotimeSeriesIntegrationRid">; /** * The representation of a geotime series integration as a data type. * * Log Safety: UNSAFE */ declare interface GeotimeSeriesProperty { geotimeSeriesId: GeotimeSeriesId; geotimeSeriesIntegrationRid: GeotimeSeriesIntegrationRid; } /** * Log Safety: SAFE */ declare interface GeotimeSeriesReferenceType { } /** * The underlying data values pointed to by a GeotimeSeriesReference. * * Log Safety: UNSAFE */ declare interface GeotimeSeriesValue { position: _Geo.Position; timestamp: string; } /* Excluded from this release type: get */ /** * Get the Organization with the specified rid. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/organizations/{organizationRid} */ declare function get_10($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [organizationRid: _Core.OrganizationRid]): Promise<_Admin.Organization>; /* Excluded from this release type: get_11 */ /** * Get the User with the specified id. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/users/{userId} */ declare function get_12($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ userId: _Core.UserId, $queryParams?: { status?: _Core.UserStatus | undefined; } ]): Promise<_Admin.User>; /** * Get the UserProviderInfo. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/users/{userId}/providerInfo */ declare function get_13($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [userId: _Core.UserId]): Promise<_Admin.UserProviderInfo>; /** * Get the Folder with the specified rid. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/folders/{folderRid} */ declare function get_14($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [folderRid: _Filesystem_2.FolderRid]): Promise<_Filesystem_2.Folder>; /** * Get the Project with the specified rid. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/projects/{projectRid} */ declare function get_15($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [projectRid: _Filesystem_2.ProjectRid]): Promise<_Filesystem_2.Project>; /** * Get the Resource with the specified rid. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/resources/{resourceRid} */ declare function get_16($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [resourceRid: _Filesystem_2.ResourceRid]): Promise<_Filesystem_2.Resource>; /* Excluded from this release type: get_17 */ /* Excluded from this release type: get_18 */ /* Excluded from this release type: get_19 */ /* Excluded from this release type: get_2 */ /** * Get a Branch of a Dataset. * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/{datasetRid}/branches/{branchName} */ declare function get_20($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [datasetRid: _Core.DatasetRid, branchName: _Core.BranchName]): Promise<_Datasets_2.Branch>; /** * Get the Dataset with the specified rid. * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/{datasetRid} */ declare function get_21($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [datasetRid: _Core.DatasetRid]): Promise<_Datasets_2.Dataset>; /** * Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest * view of the default branch - `master` for most enrollments. * * #### Advanced Usage * * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. * To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will * retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest * ancestor transaction of the branch if there are no snapshot transactions. * To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier * as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot * transaction, or the earliest ancestor transaction if there are no snapshot transactions. * To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. * This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the * `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. * To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the * `startTransactionRid` and `endTransactionRid`. * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/{datasetRid}/files/{filePath} */ declare function get_22($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, filePath: _Core.FilePath, $queryParams?: { branchName?: _Core.BranchName | undefined; startTransactionRid?: _Datasets_2.TransactionRid | undefined; endTransactionRid?: _Datasets_2.TransactionRid | undefined; } ]): Promise<_Datasets_2.File>; /** * Gets a Transaction of a Dataset. * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/{datasetRid}/transactions/{transactionRid} */ declare function get_23($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, transactionRid: _Datasets_2.TransactionRid ]): Promise<_Datasets_2.Transaction>; /** * Get metadata for a View. * * @public * * Required Scopes: [] * URL: /v2/datasets/views/{viewDatasetRid} */ declare function get_24($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ viewDatasetRid: _Core.DatasetRid, $queryParams?: { branch?: _Core.BranchName | undefined; } ]): Promise<_Datasets_2.View>; /* Excluded from this release type: get_25 */ /** * Gets a specific action type with the given API name. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/actionTypes/{actionType} */ declare function get_26($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, actionType: _Ontologies_2.ActionTypeApiName, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.ActionTypeV2>; /** * Get the metadata of an attachment. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/attachments/{attachmentRid} */ declare function get_27($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [attachmentRid: _Ontologies_2.AttachmentRid]): Promise<_Ontologies_2.AttachmentV2>; /** * Gets a specific object type with the given API name. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectTypes/{objectType} */ declare function get_28($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, $queryParams?: { branch?: _Core.FoundryBranch | undefined; includeDatasources?: boolean | undefined; } ]): Promise<_Ontologies_2.ObjectTypeV2>; /* Excluded from this release type: get_29 */ /* Excluded from this release type: get_3 */ /* Excluded from this release type: get_30 */ /** * Gets a specific object with the given primary key. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey} */ declare function get_31($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, $queryParams: { select: Array<_Ontologies_2.SelectedPropertyApiName>; sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; excludeRid?: boolean | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.OntologyObjectV2>; /** * Gets a specific ontology for a given Ontology API name or RID. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology} */ declare function get_32($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ontology: _Ontologies_2.OntologyIdentifier]): Promise<_Ontologies_2.OntologyV2>; /* Excluded from this release type: get_33 */ /** * Gets a specific query type with the given API name. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/queryTypes/{queryApiName} */ declare function get_34($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, queryApiName: _Ontologies_2.QueryApiName, $queryParams?: { version?: _Ontologies_2.FunctionVersion | undefined; sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; } ]): Promise<_Ontologies_2.QueryTypeV2>; /* Excluded from this release type: get_35 */ /* Excluded from this release type: get_36 */ /* Excluded from this release type: get_37 */ /* Excluded from this release type: get_38 */ /* Excluded from this release type: get_39 */ /* Excluded from this release type: get_4 */ /* Excluded from this release type: get_40 */ /* Excluded from this release type: get_41 */ /* Excluded from this release type: get_42 */ /* Excluded from this release type: get_43 */ /** * Get the Connection with the specified rid. * * @public * * Required Scopes: [api:connectivity-connection-read] * URL: /v2/connectivity/connections/{connectionRid} */ declare function get_44($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [connectionRid: _Connectivity.ConnectionRid]): Promise<_Connectivity.Connection>; /** * Get the FileImport with the specified rid. * * @public * * Required Scopes: [api:connectivity-file-import-read] * URL: /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} */ declare function get_45($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, fileImportRid: _Connectivity.FileImportRid ]): Promise<_Connectivity.FileImport>; /** * Get the TableImport with the specified rid. * * @public * * Required Scopes: [api:connectivity-table-import-read] * URL: /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid} */ declare function get_46($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, tableImportRid: _Connectivity.TableImportRid ]): Promise<_Connectivity.TableImport>; /* Excluded from this release type: get_47 */ /** * Get the Build with the specified rid. * * Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. * * @public * * Required Scopes: [api:orchestration-read] * URL: /v2/orchestration/builds/{buildRid} */ declare function get_48($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [buildRid: _Core.BuildRid]): Promise<_Orchestration_2.Build>; /* Excluded from this release type: get_49 */ /** * Get the Group with the specified id. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/groups/{groupId} */ declare function get_5($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [groupId: _Core.GroupId]): Promise<_Admin.Group>; /* Excluded from this release type: get_50 */ /* Excluded from this release type: get_51 */ /* Excluded from this release type: get_52 */ /* Excluded from this release type: get_53 */ /* Excluded from this release type: get_54 */ /* Excluded from this release type: get_55 */ /* Excluded from this release type: get_56 */ /* Excluded from this release type: get_57 */ /* Excluded from this release type: get_58 */ /* Excluded from this release type: get_59 */ /* Excluded from this release type: get_6 */ /* Excluded from this release type: get_60 */ /* Excluded from this release type: get_61 */ /* Excluded from this release type: get_62 */ /* Excluded from this release type: get_63 */ /* Excluded from this release type: get_64 */ /* Excluded from this release type: get_65 */ /* Excluded from this release type: get_66 */ /** * Get a stream by its branch name. If the branch does not exist, there is no stream on that branch, or the * user does not have permission to access the stream, a 404 error will be returned. * * @public * * Required Scopes: [api:streams-read] * URL: /v2/streams/datasets/{datasetRid}/streams/{streamBranchName} */ declare function get_67($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [datasetRid: _Core.DatasetRid, streamBranchName: _Core.BranchName]): Promise<_Streams.Stream>; /* Excluded from this release type: get_68 */ /** * Get the Version with the specified version. * * @public * * Required Scopes: [third-party-application:deploy-application-website] * URL: /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} */ declare function get_69($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ thirdPartyApplicationRid: _ThirdPartyApplications.ThirdPartyApplicationRid, versionVersion: _ThirdPartyApplications.VersionVersion ]): Promise<_ThirdPartyApplications.Version>; /** * Get the GroupProviderInfo. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/groups/{groupId}/providerInfo */ declare function get_7($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [groupId: _Core.GroupId]): Promise<_Admin.GroupProviderInfo>; /** * Get the Website. * * @public * * Required Scopes: [third-party-application:deploy-application-website] * URL: /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website */ declare function get_70($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ thirdPartyApplicationRid: _ThirdPartyApplications.ThirdPartyApplicationRid ]): Promise<_ThirdPartyApplications.Website>; /* Excluded from this release type: get_71 */ /* Excluded from this release type: get_72 */ /* Excluded from this release type: get_73 */ /** * Get the Marking with the specified id. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/markings/{markingId} */ declare function get_8($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [markingId: _Core.MarkingId]): Promise<_Admin.Marking>; /** * Get the MarkingCategory with the specified id. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/markingCategories/{markingCategoryId} */ declare function get_9($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [markingCategoryId: _Admin.MarkingCategoryId]): Promise<_Admin.MarkingCategory>; /** * Returns a list of access requirements a user needs in order to view a resource. Access requirements are * composed of Organizations and Markings, and can either be applied directly to the resource or inherited. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/resources/{resourceRid}/getAccessRequirements */ declare function getAccessRequirements($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [resourceRid: _Filesystem_2.ResourceRid]): Promise<_Filesystem_2.AccessRequirements>; /** * Could not getAccessRequirements the Resource. * * Log Safety: UNSAFE */ declare interface GetAccessRequirementsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetAccessRequirementsPermissionDenied"; errorDescription: "Could not getAccessRequirements the Resource."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Log Safety: SAFE */ declare interface GetActionTypeByRidBatchRequest { requests: Array; } /** * Log Safety: SAFE */ declare interface GetActionTypeByRidBatchRequestElement { actionTypeRid: ActionTypeRid; } /** * Log Safety: UNSAFE */ declare interface GetActionTypeByRidBatchResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface GetActionTypeFullMetadataBatchRequest { requests: Array; } /** * Log Safety: UNSAFE */ declare interface GetActionTypeFullMetadataBatchRequestElement { actionType: ActionTypeApiName; } /** * Log Safety: UNSAFE */ declare interface GetActionTypeFullMetadataBatchResponse { data: Array; } /* Excluded from this release type: getAffectedResources */ /** * Could not getAffectedResources the Schedule. * * Log Safety: SAFE */ declare interface GetAffectedResourcesSchedulePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetAffectedResourcesSchedulePermissionDenied"; errorDescription: "Could not getAffectedResources the Schedule."; errorInstanceId: string; parameters: { scheduleRid: unknown; }; } /** * The calling user does not have permission to list all sessions across all Agents. Listing all sessions across all agents requires the api:aip-agents-write scope. * * Log Safety: SAFE */ declare interface GetAllSessionsAgentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetAllSessionsAgentsPermissionDenied"; errorDescription: "The calling user does not have permission to list all sessions across all Agents. Listing all sessions across all agents requires the api:aip-agents-write scope."; errorInstanceId: string; parameters: {}; } /** * Get the metadata of attachments parented to the given object. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property} */ declare function getAttachment($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, property: _Ontologies_2.PropertyApiName, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.AttachmentMetadataResponse>; /** * Get the metadata of a particular attachment in an attachment list. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid} */ declare function getAttachmentByRid($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, property: _Ontologies_2.PropertyApiName, attachmentRid: _Ontologies_2.AttachmentRid, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.AttachmentV2>; /** * Execute multiple get requests on Group. * * The maximum batch size for this endpoint is 500. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/groups/getBatch */ declare function getBatch($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: Array<_Admin.GetGroupsBatchRequestElement>]): Promise<_Admin.GetGroupsBatchResponse>; /* Excluded from this release type: getBatch_10 */ /** * Execute multiple get requests on Marking. * * The maximum batch size for this endpoint is 500. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/markings/getBatch */ declare function getBatch_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: Array<_Admin.GetMarkingsBatchRequestElement>]): Promise<_Admin.GetMarkingsBatchResponse>; /* Excluded from this release type: getBatch_3 */ /** * Execute multiple get requests on User. * * The maximum batch size for this endpoint is 500. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/users/getBatch */ declare function getBatch_4($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: Array<_Admin.GetUsersBatchRequestElement>]): Promise<_Admin.GetUsersBatchResponse>; /** * Fetches multiple folders in a single request. * * The maximum batch size for this endpoint is 1000. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/folders/getBatch */ declare function getBatch_5($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: Array<_Filesystem_2.GetFoldersBatchRequestElement>]): Promise<_Filesystem_2.GetFoldersBatchResponse>; /** * Fetches multiple resources in a single request. * Returns a map from RID to the corresponding resource. If a resource does not exist, or if it is a root folder or space, its RID will not be included in the map. * At most 1,000 resources should be requested at once. * * The maximum batch size for this endpoint is 1000. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/resources/getBatch */ declare function getBatch_6($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: Array<_Filesystem_2.GetResourcesBatchRequestElement>]): Promise<_Filesystem_2.GetResourcesBatchResponse>; /* Excluded from this release type: getBatch_7 */ /** * Execute multiple get requests on Build. * * Users are allowed to make a maximum of **4 requests per second** and **25 concurrent requests**. * * The maximum batch size for this endpoint is 100. * * @public * * Required Scopes: [api:orchestration-read] * URL: /v2/orchestration/builds/getBatch */ declare function getBatch_8($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: Array<_Orchestration_2.GetBuildsBatchRequestElement>]): Promise<_Orchestration_2.GetBuildsBatchResponse>; /* Excluded from this release type: getBatch_9 */ /** * Could not transactions the Branch. * * Log Safety: UNSAFE */ declare interface GetBranchTransactionHistoryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetBranchTransactionHistoryPermissionDenied"; errorDescription: "Could not transactions the Branch."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; }; } /** * Log Safety: SAFE */ declare interface GetBuildsBatchRequestElement { buildRid: _Core.BuildRid; } /** * Log Safety: UNSAFE */ declare interface GetBuildsBatchResponse { data: Record<_Core.BuildRid, Build>; } /** * Get a resource by its absolute path. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/resources/getByPath */ declare function getByPath($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$queryParams: { path: _Filesystem_2.ResourcePath; }]): Promise<_Filesystem_2.Resource>; /** * Gets multiple resources by their absolute paths. * Returns a list of resources. If a path does not exist, is inaccessible, or refers to * a root folder or space, it will not be included in the response. * At most 1,000 paths should be requested at once. * * The maximum batch size for this endpoint is 1000. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/resources/getByPathBatch */ declare function getByPathBatch($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: Array<_Filesystem_2.GetByPathResourcesBatchRequestElement>]): Promise<_Filesystem_2.GetByPathResourcesBatchResponse>; /** * Could not getByPath the Resource. * * Log Safety: SAFE */ declare interface GetByPathPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetByPathPermissionDenied"; errorDescription: "Could not getByPath the Resource."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface GetByPathResourcesBatchRequestElement { path: ResourcePath; } /** * Log Safety: UNSAFE */ declare interface GetByPathResourcesBatchResponse { data: Array; } /** * Gets a specific action type with the given RID. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/actionTypes/byRid/{actionTypeRid} */ declare function getByRid($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, actionTypeRid: _Ontologies_2.ActionTypeRid, $queryParams?: { branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.ActionTypeV2>; /* Excluded from this release type: getByRid_2 */ /* Excluded from this release type: getByRidBatch */ /* Excluded from this release type: getByRidBatch_2 */ /* Excluded from this release type: getByRidBatch_3 */ /* Excluded from this release type: getByRidBatch_4 */ /** * Could not getByRid the Query. * * Log Safety: SAFE */ declare interface GetByRidPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetByRidPermissionDenied"; errorDescription: "Could not getByRid the Query."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface GetByRidQueriesBatchRequestElement { includePrerelease?: boolean; rid: FunctionRid_2; version?: FunctionVersion_2; } /** * Log Safety: UNSAFE */ declare interface GetByRidQueriesBatchResponse { data: Array; } /** * The provided token does not have permission to get the CBAC banner for the markings. * * Log Safety: UNSAFE */ declare interface GetCbacBannerPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetCbacBannerPermissionDenied"; errorDescription: "The provided token does not have permission to get the CBAC banner for the markings."; errorInstanceId: string; parameters: { markingIds: unknown; }; } /** * The provided token does not have permission to get the CBAC marking restrictions for the markings. * * Log Safety: UNSAFE */ declare interface GetCbacMarkingRestrictionInfoPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetCbacMarkingRestrictionInfoPermissionDenied"; errorDescription: "The provided token does not have permission to get the CBAC marking restrictions for the markings."; errorInstanceId: string; parameters: { markingIds: unknown; }; } /** * Retrieves the ConnectionConfiguration of the [Connection](https://www.palantir.com/docs/foundry/data-connection/set-up-source/) itself. * This operation is intended for use when other Connection data is not required, providing a lighter-weight alternative to `getConnection` operation. * * @public * * Required Scopes: [api:connectivity-connection-read] * URL: /v2/connectivity/connections/{connectionRid}/getConfiguration */ declare function getConfiguration($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [connectionRid: _Connectivity.ConnectionRid]): Promise<_Connectivity.ConnectionConfiguration>; /** * Returns a map of Connection RIDs to their corresponding configurations. * Connections are filtered from the response if they don't exist or the requesting token lacks the required permissions. * * The maximum batch size for this endpoint is 200. * * @public * * Required Scopes: [api:connectivity-connection-read] * URL: /v2/connectivity/connections/getConfigurationBatch */ declare function getConfigurationBatch($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ $body: Array<_Connectivity.GetConfigurationConnectionsBatchRequestElement> ]): Promise<_Connectivity.GetConfigurationConnectionsBatchResponse>; /** * Log Safety: SAFE */ declare interface GetConfigurationConnectionsBatchRequestElement { connectionRid: ConnectionRid; } /** * Log Safety: DO_NOT_LOG */ declare interface GetConfigurationConnectionsBatchResponse { data: Record; } /** * Could not getConfiguration the Connection. * * Log Safety: SAFE */ declare interface GetConfigurationPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetConfigurationPermissionDenied"; errorDescription: "Could not getConfiguration the Connection."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /* Excluded from this release type: getCurrent */ /** * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/users/getCurrent */ declare function getCurrent_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: []): Promise<_Admin.User>; /** * Could not getCurrent the Enrollment. * * Log Safety: SAFE */ declare interface GetCurrentEnrollmentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetCurrentEnrollmentPermissionDenied"; errorDescription: "Could not getCurrent the Enrollment."; errorInstanceId: string; parameters: {}; } /** * Could not getCurrent the User. * * Log Safety: SAFE */ declare interface GetCurrentUserPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetCurrentUserPermissionDenied"; errorDescription: "Could not getCurrent the User."; errorInstanceId: string; parameters: {}; } /** * Could not getHealthCheckReports the Dataset. * * Log Safety: SAFE */ declare interface GetDatasetHealthCheckReportsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetDatasetHealthCheckReportsPermissionDenied"; errorDescription: "Could not getHealthCheckReports the Dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * Could not getHealthChecks the Dataset. * * Log Safety: SAFE */ declare interface GetDatasetHealthChecksPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetDatasetHealthChecksPermissionDenied"; errorDescription: "Could not getHealthChecks the Dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * Log Safety: SAFE */ declare interface GetDatasetJobsAndFilter { items: Array; } /** * Log Safety: SAFE */ declare type GetDatasetJobsComparisonType = "GTE" | "LT"; /** * Log Safety: SAFE */ declare interface GetDatasetJobsOrFilter { items: Array; } /** * Could not jobs the Dataset. * * Log Safety: SAFE */ declare interface GetDatasetJobsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetDatasetJobsPermissionDenied"; errorDescription: "Could not jobs the Dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * Query for getting jobs on given dataset. * * Log Safety: SAFE */ declare type GetDatasetJobsQuery = ({ type: "or"; } & GetDatasetJobsOrFilter) | ({ type: "and"; } & GetDatasetJobsAndFilter) | ({ type: "timeFilter"; } & GetDatasetJobsTimeFilter); /** * Log Safety: SAFE */ declare interface GetDatasetJobsRequest { where?: GetDatasetJobsQuery; orderBy: Array; } /** * Log Safety: SAFE */ declare interface GetDatasetJobsSort { sortType: GetDatasetJobsSortType; sortDirection: GetDatasetJobsSortDirection; } /** * Log Safety: SAFE */ declare type GetDatasetJobsSortDirection = "ASCENDING" | "DESCENDING"; /** * Log Safety: SAFE */ declare type GetDatasetJobsSortType = "BY_STARTED_TIME" | "BY_FINISHED_TIME"; /** * Log Safety: SAFE */ declare interface GetDatasetJobsTimeFilter { field: GetDatasetJobsTimeFilterField; comparisonType: GetDatasetJobsComparisonType; value: string; } /** * Log Safety: SAFE */ declare type GetDatasetJobsTimeFilterField = "SUBMITTED_TIME" | "FINISHED_TIME"; /** * Could not getSchedules the Dataset. * * Log Safety: SAFE */ declare interface GetDatasetSchedulesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetDatasetSchedulesPermissionDenied"; errorDescription: "Could not getSchedules the Dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * Could not getSchema the Dataset. * * Log Safety: SAFE */ declare interface GetDatasetSchemaPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetDatasetSchemaPermissionDenied"; errorDescription: "Could not getSchema the Dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface GetDatasetSchemaResponse { branchName: _Core.BranchName; endTransactionRid: TransactionRid; schema: _Core.DatasetSchema; versionId: _Core.VersionId; } /** * Returns the history of edits (additions, modifications, deletions) for objects of a * specific object type. This endpoint provides visibility into all actions that have * modified objects of this type. * * The edits are returned in reverse chronological order (most recent first) by default. * * Note that filters are ignored for OSv1 object types. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory */ declare function getEditsHistory($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, $body: _Ontologies_2.ObjectTypeEditsHistoryRequest, $queryParams?: { branch?: _Core.FoundryBranch | undefined; scenarioRid?: _Ontologies_2.OntologyScenarioRid | undefined; } ]): Promise<_Ontologies_2.ObjectTypeEditsHistoryResponse>; /** * Retrieves the bytes of an email attachment by index. * * Log Safety: UNSAFE */ declare interface GetEmailAttachmentOperation { mimeType: string; attachmentIndex: number; } /** * Gets the email body in the specified format. * * Log Safety: SAFE */ declare interface GetEmailBodyOperation { outputFormat: EmailToTextEncodeFormat; } /* Excluded from this release type: getEndOffsets */ /** * Could not getEndOffsets the Stream. * * Log Safety: UNSAFE */ declare interface GetEndOffsetsForStreamPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetEndOffsetsForStreamPermissionDenied"; errorDescription: "Could not getEndOffsets the Stream."; errorInstanceId: string; parameters: { datasetRid: unknown; streamBranchName: unknown; }; } /** * The end offsets for each partition of a stream. * * Log Safety: SAFE */ declare type GetEndOffsetsResponse = Record; /** * Poll response for an async query execution. * * Log Safety: UNSAFE */ declare type GetExecutionResultResponse = ({ type: "running"; } & RunningExecution) | ({ type: "succeeded"; } & SucceededExecution); /** * Could not content the File. * * Log Safety: UNSAFE */ declare interface GetFileContentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetFileContentPermissionDenied"; errorDescription: "Could not content the File."; errorInstanceId: string; parameters: { datasetRid: unknown; filePath: unknown; }; } /** * Get the first point of a time series property. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint */ declare function getFirstPoint($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, property: _Ontologies_2.PropertyApiName, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; } ]): Promise<_Ontologies_2.TimeSeriesPoint | undefined>; /** * Log Safety: SAFE */ declare interface GetFoldersBatchRequestElement { folderRid: FolderRid_2; } /** * Log Safety: UNSAFE */ declare interface GetFoldersBatchResponse { data: Record; } /* Excluded from this release type: getFullMetadata */ /* Excluded from this release type: getFullMetadata_2 */ /* Excluded from this release type: getFullMetadataBatch */ /* Excluded from this release type: getFullMetadataBatch_2 */ /** * The provided token does not have permission to view the provider information for the given group. * * Log Safety: SAFE */ declare interface GetGroupProviderInfoPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetGroupProviderInfoPermissionDenied"; errorDescription: "The provided token does not have permission to view the provider information for the given group."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * Log Safety: SAFE */ declare interface GetGroupsBatchRequestElement { groupId: _Core.GroupId; } /** * Log Safety: UNSAFE */ declare interface GetGroupsBatchResponse { data: Record<_Core.GroupId, Group>; } /* Excluded from this release type: getHealthCheckReports */ /** * Log Safety: UNSAFE */ declare interface GetHealthCheckReportsResponse { data: Record<_Core.CheckRid, _DataHealth.CheckReport | undefined>; } /* Excluded from this release type: getHealthChecks */ /** * Log Safety: UNSAFE */ declare interface GetJobResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: SAFE */ declare interface GetJobsBatchRequestElement { jobRid: _Core.JobRid; } /** * Log Safety: SAFE */ declare interface GetJobsBatchResponse { data: Record<_Core.JobRid, Job>; } /** * Get the last point of a time series property. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint */ declare function getLastPoint($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, property: _Ontologies_2.PropertyApiName, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; } ]): Promise<_Ontologies_2.TimeSeriesPoint | undefined>; /* Excluded from this release type: getLatest */ /** * Could not getLatest the CheckReport. * * Log Safety: SAFE */ declare interface GetLatestCheckReportsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetLatestCheckReportsPermissionDenied"; errorDescription: "Could not getLatest the CheckReport."; errorInstanceId: string; parameters: { checkRid: unknown; }; } /** * The response for getting the latest check reports. * * Log Safety: UNSAFE */ declare interface GetLatestCheckReportsResponse { data: Array; } /** * Get the latest value of a property backed by a timeseries. If a specific geotime series integration has both a history and a live integration, we will give precedence to the live integration. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{propertyName}/latestValue */ declare function getLatestValue($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, propertyName: _Ontologies_2.PropertyApiName, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.TimeseriesEntry | undefined>; /** * Get a specific linked object that originates from another object. * * If there is no link between the two objects, `LinkedObjectNotFound` is thrown. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} */ declare function getLinkedObject($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, linkType: _Ontologies_2.LinkTypeApiName, linkedObjectPrimaryKey: _Ontologies_2.PropertyValueEscapedString, $queryParams: { select: Array<_Ontologies_2.SelectedPropertyApiName>; sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; excludeRid?: boolean | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.OntologyObjectV2>; /** * Could not content the LogFile. * * Log Safety: SAFE */ declare interface GetLogFileContentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetLogFileContentPermissionDenied"; errorDescription: "Could not content the LogFile."; errorInstanceId: string; parameters: { organizationRid: unknown; logFileId: unknown; }; } /** * The provided token does not have permission to view the marking category. * * Log Safety: UNSAFE */ declare interface GetMarkingCategoryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetMarkingCategoryPermissionDenied"; errorDescription: "The provided token does not have permission to view the marking category."; errorInstanceId: string; parameters: { markingCategoryId: unknown; }; } /** * The provided token does not have permission to view the marking. * * Log Safety: UNSAFE */ declare interface GetMarkingPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetMarkingPermissionDenied"; errorDescription: "The provided token does not have permission to view the marking."; errorInstanceId: string; parameters: { markingId: unknown; }; } /** * Retrieve Markings that the user is currently a member of. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/users/{userId}/getMarkings */ declare function getMarkings($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [userId: _Core.UserId]): Promise<_Admin.GetUserMarkingsResponse>; /** * Log Safety: UNSAFE */ declare interface GetMarkingsBatchRequestElement { markingId: _Core.MarkingId; } /** * Log Safety: UNSAFE */ declare interface GetMarkingsBatchResponse { data: Record<_Core.MarkingId, Marking>; } /** * Could not getMarkings the User. * * Log Safety: SAFE */ declare interface GetMarkingsUserPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetMarkingsUserPermissionDenied"; errorDescription: "Could not getMarkings the User."; errorInstanceId: string; parameters: { userId: unknown; }; } /* Excluded from this release type: getMediaContent */ /** * Log Safety: UNSAFE */ declare interface GetMediaItemInfoResponse { viewRid: _Core.MediaSetViewRid; path?: _Core.MediaItemPath; logicalTimestamp: LogicalTimestamp; attribution?: MediaAttribution; originallyUploadedFileMimeType?: _Core.MediaType; mimeType?: _Core.MediaType; sizeBytes?: number; } /** * The token does not have permission to view paths in this media set. * * Log Safety: SAFE */ declare interface GetMediaItemRidByPathPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetMediaItemRidByPathPermissionDenied"; errorDescription: "The token does not have permission to view paths in this media set."; errorInstanceId: string; parameters: { mediaSetRid: unknown; }; } /** * Log Safety: SAFE */ declare interface GetMediaItemRidByPathResponse { mediaItemRid?: _Core.MediaItemRid; } /* Excluded from this release type: getMediaMetadata */ /** * Information about a media set. * * Log Safety: UNSAFE */ declare interface GetMediaSetResponse { rid: _Core.MediaSetRid; mediaSchema: MediaSchema; defaultBranchName: BranchName_4; transactionPolicy: TransactionPolicy; pathsRequired: boolean; } /** * Log Safety: SAFE */ declare interface GetObjectTypeByRidBatchRequest { requests: Array; } /** * Log Safety: SAFE */ declare interface GetObjectTypeByRidBatchRequestElement { objectTypeRid: ObjectTypeRid_2; } /** * Log Safety: UNSAFE */ declare interface GetObjectTypeByRidBatchResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface GetObjectTypeFullMetadataBatchRequest { requests: Array; includeLinkTypes?: boolean; } /** * Log Safety: UNSAFE */ declare interface GetObjectTypeFullMetadataBatchRequestElement { objectType: ObjectTypeApiName; } /** * Log Safety: UNSAFE */ declare interface GetObjectTypeFullMetadataBatchResponse { data: Array; } /** * Could not yaml the OpenApiDefinition. * * Log Safety: SAFE */ declare interface GetOpenApiDefinitionAsYamlPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetOpenApiDefinitionAsYamlPermissionDenied"; errorDescription: "Could not yaml the OpenApiDefinition."; errorInstanceId: string; parameters: { openApiDefinitionApiVersion: unknown; }; } /* Excluded from this release type: getOperationalVersion */ /** * Could not getOperationalVersion the DocumentType. * * Log Safety: SAFE */ declare interface GetOperationalVersionDocumentTypePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetOperationalVersionDocumentTypePermissionDenied"; errorDescription: "Could not getOperationalVersion the DocumentType."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface GetOperationalVersionDocumentTypeRequest { documentTypeName: DocumentTypeName; ontologyRid: string; } /** * Response containing the operational version for a document type. * * Log Safety: SAFE */ declare interface GetOperationalVersionResponse { operationalVersion?: SchemaVersion; } /* Excluded from this release type: getOutgoingInterfaceLinkType */ /** * Get an outgoing link for an object type. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} */ declare function getOutgoingLinkType($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, linkType: _Ontologies_2.LinkTypeApiName, $queryParams?: { branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.LinkTypeSideV2>; /* Excluded from this release type: getOutgoingLinkTypesByObjectTypeRidBatch */ /** * Log Safety: SAFE */ declare interface GetOutgoingLinkTypesByObjectTypeRidBatchRequest { requests: Array; filterLinkTypeRids: Array; } /** * Log Safety: SAFE */ declare interface GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement { objectTypeRid: ObjectTypeRid_2; } /** * Log Safety: UNSAFE */ declare interface GetOutgoingLinkTypesByObjectTypeRidBatchResponse { data: Record>; } /** * Returns the dimensions of each page in a PDF document as JSON (in points). * * Log Safety: SAFE */ declare interface GetPdfPageDimensionsOperation { } /** * Could not profilePicture the User. * * Log Safety: SAFE */ declare interface GetProfilePictureOfUserPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetProfilePictureOfUserPermissionDenied"; errorDescription: "Could not profilePicture the User."; errorInstanceId: string; parameters: { userId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface GetQueryTypeByRidBatchRequest { requests: Array; } /** * Log Safety: UNSAFE */ declare interface GetQueryTypeByRidBatchRequestElement { queryTypeRid: FunctionRid; functionVersion?: FunctionVersion; } /** * Log Safety: UNSAFE */ declare interface GetQueryTypeByRidBatchResponse { data: Array; } /** * Could not ragContext the Session. * * Log Safety: SAFE */ declare interface GetRagContextForSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetRagContextForSessionPermissionDenied"; errorDescription: "Could not ragContext the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface GetRagContextForSessionRequest { userInput: UserTextInput; parameterInputs: Record; } /* Excluded from this release type: getReadPosition */ /* Excluded from this release type: getRecentlyViewed */ /** * Could not getRecentlyViewed the Resource. * * Log Safety: SAFE */ declare interface GetRecentlyViewedPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetRecentlyViewedPermissionDenied"; errorDescription: "Could not getRecentlyViewed the Resource."; errorInstanceId: string; parameters: {}; } /** * Response containing the resources most recently viewed by the calling user. * * Log Safety: UNSAFE */ declare interface GetRecentlyViewedResponse { data: Array; } /* Excluded from this release type: getRecords */ /** * Log Safety: SAFE */ declare interface GetRecordsBatchRequestElement { recordRid: RecordRid; } /** * Log Safety: UNSAFE */ declare interface GetRecordsBatchResponse { data: Record; } /** * Could not getRecords the Stream. * * Log Safety: UNSAFE */ declare interface GetRecordsFromStreamPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetRecordsFromStreamPermissionDenied"; errorDescription: "Could not getRecords the Stream."; errorInstanceId: string; parameters: { datasetRid: unknown; streamBranchName: unknown; }; } /** * A list of records from a stream with their offsets. * * Log Safety: DO_NOT_LOG */ declare type GetRecordsResponse = Array; /** * Log Safety: UNSAFE */ declare interface GetResourcesBatchRequestElement { resourceRid: ResourceRid; } /** * Log Safety: UNSAFE */ declare interface GetResourcesBatchResponse { data: Record; } /* Excluded from this release type: getResult */ /* Excluded from this release type: getResult_2 */ /** * Could not getResult the Execution. * * Log Safety: SAFE */ declare interface GetResultExecutionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetResultExecutionPermissionDenied"; errorDescription: "Could not getResult the Execution."; errorInstanceId: string; parameters: { executionId: unknown; }; } /** * Log Safety: SAFE */ declare interface GetResultExecutionRequest { timeout?: number; } /** * Gets the results of a query. Results are returned in the `serializationFormat` specified at execute time * (defaulting to [Apache Arrow](https://arrow.apache.org/) if no format is provided). * * This endpoint implements long polling and requests will time out after one minute. They can be safely * retried while the query is still running. * * @public * * Required Scopes: [api:sql-queries-read] * URL: /v2/sqlQueries/{sqlQueryId}/getResults */ declare function getResults($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [sqlQueryId: _SqlQueries.SqlQueryId]): Promise; /** * Could not getResults the SqlQuery. * * Log Safety: SAFE */ declare interface GetResultsSqlQueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetResultsSqlQueryPermissionDenied"; errorDescription: "Could not getResults the SqlQuery."; errorInstanceId: string; parameters: {}; } /* Excluded from this release type: getRidByPath */ /** * Log Safety: SAFE */ declare interface GetRolesBatchRequestElement { roleId: _Core.RoleId; } /** * Log Safety: UNSAFE */ declare interface GetRolesBatchResponse { data: Record<_Core.RoleId, Role_2>; } /** * Getting the root folder as a resource is not supported. * * Log Safety: SAFE */ declare interface GetRootFolderNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "GetRootFolderNotSupported"; errorDescription: "Getting the root folder as a resource is not supported."; errorInstanceId: string; parameters: {}; } /** * Get the RIDs of the Schedules that target the given Dataset. * * Note: It may take up to an hour for recent changes to schedules to be reflected in this response, * especially for schedules managed by Marketplace. This operation will return outdated results in the * meantime. * * @public * * Required Scopes: [api:orchestration-read, api:datasets-read] * URL: /v2/datasets/{datasetRid}/getSchedules */ declare function getSchedules($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, $queryParams?: { branchName?: _Core.BranchName | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Datasets_2.ListSchedulesResponse>; /** * Log Safety: SAFE */ declare interface GetSchedulesBatchRequestElement { scheduleRid: _Core.ScheduleRid; } /** * Log Safety: UNSAFE */ declare interface GetSchedulesBatchResponse { data: Record<_Core.ScheduleRid, Schedule>; } /** * Gets a dataset's schema. If no `endTransactionRid` is provided, the latest committed version will be used. * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/{datasetRid}/getSchema */ declare function getSchema($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, $queryParams?: { branchName?: _Core.BranchName | undefined; endTransactionRid?: _Datasets_2.TransactionRid | undefined; versionId?: _Core.VersionId | undefined; } ]): Promise<_Datasets_2.GetDatasetSchemaResponse>; /** * Fetch schemas for multiple datasets in a single request. Datasets not found * or inaccessible to the user will be omitted from the response. * * The maximum batch size for this endpoint is 1000. * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/getSchemaBatch */ declare function getSchemaBatch($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: Array<_Datasets_2.GetSchemaDatasetsBatchRequestElement>]): Promise<_Datasets_2.GetSchemaDatasetsBatchResponse>; /** * Log Safety: UNSAFE */ declare interface GetSchemaDatasetsBatchRequestElement { endTransactionRid?: TransactionRid; datasetRid: _Core.DatasetRid; versionId?: _Core.VersionId; branchName?: _Core.BranchName; } /** * Log Safety: UNSAFE */ declare interface GetSchemaDatasetsBatchResponse { data: Record<_Core.DatasetRid, GetDatasetSchemaResponse>; } /** * Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could explode the cardinality. Use collectList or collectSet which will return a list of values in that case. * * Log Safety: UNSAFE */ declare interface GetSelectedPropertyOperation { selectedPropertyApiName: PropertyApiName_2; } /** * Getting a space as a resource is not supported. * * Log Safety: SAFE */ declare interface GetSpaceResourceNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "GetSpaceResourceNotSupported"; errorDescription: "Getting a space as a resource is not supported."; errorInstanceId: string; parameters: { spaceRid: unknown; }; } /* Excluded from this release type: getStatus */ /** * Gets the status of a query. * * @public * * Required Scopes: [api:sql-queries-read] * URL: /v2/sqlQueries/{sqlQueryId}/getStatus */ declare function getStatus_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [sqlQueryId: _SqlQueries.SqlQueryId]): Promise<_SqlQueries.QueryStatus>; /** * Could not getStatus the SqlQuery. * * Log Safety: SAFE */ declare interface GetStatusSqlQueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetStatusSqlQueryPermissionDenied"; errorDescription: "Could not getStatus the SqlQuery."; errorInstanceId: string; parameters: {}; } /** * Could not getReadPosition the Subscriber. * * Log Safety: UNSAFE */ declare interface GetSubscriberReadPositionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetSubscriberReadPositionPermissionDenied"; errorDescription: "Could not getReadPosition the Subscriber."; errorInstanceId: string; parameters: { datasetRid: unknown; subscriberSubscriberId: unknown; streamBranchName: unknown; }; } /** * Returns a list of timestamps for scene frames in the video as JSON. * * Log Safety: SAFE */ declare interface GetTimestampsForSceneFramesOperation { sceneScore?: SceneScore; } /** * Response containing the status of a transformation job. * * Log Safety: UNSAFE */ declare interface GetTransformationJobStatusResponse { status: TransformationJobStatus; jobId: TransformationJobId; } /** * Log Safety: UNSAFE */ declare interface GetUserMarkingsResponse { view: Array<_Core.MarkingId>; } /** * The provided token does not have permission to view the provider information for the given user. * * Log Safety: SAFE */ declare interface GetUserProviderInfoPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "GetUserProviderInfoPermissionDenied"; errorDescription: "The provided token does not have permission to view the provider information for the given user."; errorInstanceId: string; parameters: { userId: unknown; }; } /** * Log Safety: SAFE */ declare interface GetUsersBatchRequestElement { userId: _Core.UserId; status?: _Core.UserStatus; } /** * Log Safety: UNSAFE */ declare interface GetUsersBatchResponse { data: Record<_Core.UserId, User>; } /** * Pointer to the table in AWS Glue. * * Log Safety: UNSAFE */ declare interface GlueVirtualTableConfig { database: string; table: string; } /** * GPS location metadata extracted from EXIF data embedded in the image. * * Log Safety: UNSAFE */ declare interface GpsMetadata { latitude?: number; longitude?: number; altitude?: number; } /** * The specific type of GPU hardware to use. * * Log Safety: SAFE */ declare type GpuType = "A100" | "A10G" | "A16" | "H100" | "H200" | "L4" | "L40S" | "T4" | "V100"; /** * The requested GPU type is not available. Use a GPU type that is available in the deployment's resource queue. * * Log Safety: SAFE */ declare interface GpuTypeNotAvailable { errorCode: "INVALID_ARGUMENT"; errorName: "GpuTypeNotAvailable"; errorDescription: "The requested GPU type is not available. Use a GPU type that is available in the deployment's resource queue."; errorInstanceId: string; parameters: { requestedGpuType: unknown; availableGpuTypes: unknown; }; } /** * Converts an image to grayscale. * * Log Safety: SAFE */ declare interface GrayscaleImageOperation { } /** * Finds greatest of two or more numeric, date or timestamp values. * * Log Safety: UNSAFE */ declare interface GreatestPropertyExpression { properties: Array; } /** * A ground control point for geo-referencing. * * Log Safety: UNSAFE */ declare interface GroundControlPoint { pixX?: number; pixY?: number; projX?: number; projY?: number; projZ?: number; } /** * Log Safety: UNSAFE */ declare interface Group { id: _Core.GroupId; name: GroupName_2; description?: string; realm: _Core.Realm; organizations: Array<_Core.OrganizationRid>; attributes: Record; } /** * A named group of mailboxes. * * Log Safety: UNSAFE */ declare interface Group_2 { groupName: string; mailboxes: Array; } /** * A Foundry Group ID. * * Log Safety: SAFE */ declare type GroupId = string; /** * A Foundry Group ID. * * Log Safety: SAFE */ declare type GroupId_2 = string; /** * Log Safety: SAFE */ declare interface GroupMember { principalType: _Core.PrincipalType; principalId: _Core.PrincipalId; expiration?: GroupMembershipExpiration; } /** * The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. * * Log Safety: SAFE */ declare interface GroupMemberConstraint { } export declare namespace GroupMembers { export { list_4 as list, add_2 as add, remove_2 as remove } } /** * Log Safety: SAFE */ declare interface GroupMembership { groupId: _Core.GroupId; } /** * Log Safety: SAFE */ declare type GroupMembershipExpiration = string; export declare namespace GroupMembershipExpirationPolicies { export { } } /** * Log Safety: SAFE */ declare interface GroupMembershipExpirationPolicy { maximumValue?: GroupMembershipExpiration; maximumDuration?: _Core.DurationSeconds; } /** * The given GroupMembershipExpirationPolicy could not be found. * * Log Safety: SAFE */ declare interface GroupMembershipExpirationPolicyNotFound { errorCode: "NOT_FOUND"; errorName: "GroupMembershipExpirationPolicyNotFound"; errorDescription: "The given GroupMembershipExpirationPolicy could not be found."; errorInstanceId: string; parameters: { groupId: unknown; }; } export declare namespace GroupMemberships { export { list_5 as list } } /** * The display name of a multipass group. * * Log Safety: UNSAFE */ declare type GroupName = LooselyBrandedString<"GroupName">; /** * The name of the Group. * * Log Safety: UNSAFE */ declare type GroupName_2 = LooselyBrandedString_3<"GroupName">; /** * A group with this name already exists * * Log Safety: UNSAFE */ declare interface GroupNameAlreadyExists { errorCode: "INVALID_ARGUMENT"; errorName: "GroupNameAlreadyExists"; errorDescription: "A group with this name already exists"; errorInstanceId: string; parameters: { groupName: unknown; }; } /** * The given Group could not be found. * * Log Safety: SAFE */ declare interface GroupNotFound { errorCode: "NOT_FOUND"; errorName: "GroupNotFound"; errorDescription: "The given Group could not be found."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface GroupProviderInfo { providerId: ProviderId; } /** * The given GroupProviderInfo could not be found. * * Log Safety: SAFE */ declare interface GroupProviderInfoNotFound { errorCode: "NOT_FOUND"; errorName: "GroupProviderInfoNotFound"; errorDescription: "The given GroupProviderInfo could not be found."; errorInstanceId: string; parameters: { groupId: unknown; }; } export declare namespace GroupProviderInfos { export { get_7 as get, replace_3 as replace } } /** * The unique resource identifier (RID) of a multipass group. * * Log Safety: UNSAFE */ declare type GroupRid = LooselyBrandedString<"GroupRid">; export declare namespace Groups { export { create, deleteGroup, list_3 as list, get_5 as get, getBatch, replace, search } } /** * Log Safety: UNSAFE */ declare interface GroupSearchFilter { type: PrincipalFilterType; value: string; } /** * A wrapper for a group in the MailboxOrGroup union. * * Log Safety: UNSAFE */ declare interface GroupWrapper { group: Group_2; } /** * Returns objects where the specified field is greater than or equal to a value. * * Log Safety: UNSAFE */ declare interface GteQuery { field: FieldNameV1; value: PropertyValue_2; } /** * @deprecated Use `GteQueryV2` in the `foundry.ontologies` package * * Returns objects where the specified field is greater than or equal to a value. * * Log Safety: UNSAFE */ declare interface GteQueryV2 { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: PropertyValue; } /** * Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface GteQueryV2_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: PropertyValue_2; } /** * Returns objects where the specified field is greater than a value. * * Log Safety: UNSAFE */ declare interface GtQuery { field: FieldNameV1; value: PropertyValue_2; } /** * @deprecated Use `GtQueryV2` in the `foundry.ontologies` package * * Returns objects where the specified field is greater than a value. * * Log Safety: UNSAFE */ declare interface GtQueryV2 { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: PropertyValue; } /** * Returns objects where the specified field is greater than a value. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface GtQueryV2_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: PropertyValue_2; } /** * Returns action types based on whether they have an action log. * * Log Safety: SAFE */ declare interface HasActionLogActionTypesQueryV2 { value: boolean; } /** * Returns action types based on whether they have a notification. * * Log Safety: SAFE */ declare interface HasNotificationActionTypesQueryV2 { value: boolean; } /** * Returns action types based on whether they reference a webhook. * * Log Safety: SAFE */ declare interface HasWebhookActionTypesQueryV2 { value: boolean; } /** * Log Safety: UNSAFE */ declare interface HeaderApiKey { headerName: string; } /** * High-scale compute was required for this Ontology query but is not enabled on this enrollment. * * Log Safety: SAFE */ declare interface HighScaleComputationNotEnabled { errorCode: "TIMEOUT"; errorName: "HighScaleComputationNotEnabled"; errorDescription: "High-scale compute was required for this Ontology query but is not enabled on this enrollment."; errorInstanceId: string; parameters: {}; } /** * Log Safety: SAFE */ declare interface Host { hostName: HostName; } /** * Log Safety: SAFE */ declare type HostName = LooselyBrandedString_3<"HostName">; /** * The hostname should not include a protocol (e.g., https://) or port number (e.g., :443). * * Log Safety: UNSAFE */ declare interface HostNameCannotHaveProtocolOrPort { errorCode: "INVALID_ARGUMENT"; errorName: "HostNameCannotHaveProtocolOrPort"; errorDescription: "The hostname should not include a protocol (e.g., https://) or port number (e.g., :443)."; errorInstanceId: string; parameters: { hostName: unknown; }; } export declare namespace Hosts { export { } } /** * Formats the duration as a human-readable written string. * * Log Safety: SAFE */ declare interface HumanReadableFormat { showFullUnits?: boolean; } /** * Pointer to the Iceberg table. * * Log Safety: UNSAFE */ declare interface IcebergVirtualTableConfig { tableIdentifier: string; warehousePath?: string; } /** * A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). * * Log Safety: UNSAFE */ declare type Icon = { type: "blueprint"; } & BlueprintIcon; /** * Whether empty transactions should be ignored when calculating time since last updated. If true (default), only transactions with actual data changes are considered. * * Log Safety: SAFE */ declare type IgnoreEmptyTransactions = boolean; /** * The domain of an image attribute. * * Log Safety: UNSAFE */ declare type ImageAttributeDomain = LooselyBrandedString_14<"ImageAttributeDomain">; /** * The key of an image attribute within a domain. * * Log Safety: UNSAFE */ declare type ImageAttributeKey = LooselyBrandedString_14<"ImageAttributeKey">; /** * Extracts text from an image with layout information preserved. * * Log Safety: SAFE */ declare interface ImageExtractLayoutAwareContentOperation { parameters: LayoutAwareExtractionParameters; } /** * Performs OCR (Optical Character Recognition) on an image. * * Log Safety: UNSAFE */ declare interface ImageOcrOperation { parameters: OcrParameters; } /** * An operation to perform on an image. * * Log Safety: UNSAFE */ declare type ImageOperation = ({ type: "rotate"; } & RotateImageOperation) | ({ type: "resizeToFitBoundingBox"; } & ResizeToFitBoundingBoxOperation) | ({ type: "encrypt"; } & EncryptImageOperation) | ({ type: "contrast"; } & ContrastImageOperation) | ({ type: "tile"; } & TileImageOperation) | ({ type: "resize"; } & ResizeImageOperation) | ({ type: "annotate"; } & AnnotateImageOperation) | ({ type: "decrypt"; } & DecryptImageOperation) | ({ type: "crop"; } & CropImageOperation) | ({ type: "grayscale"; } & GrayscaleImageOperation); /** * Coordinate of a pixel in an image (x, y). Top left corner of the image is (0, 0). * * Log Safety: SAFE */ declare interface ImagePixelCoordinate { x: number; y: number; } /** * Polygon drawn by connecting adjacent coordinates in the list with straight lines. A line is drawn between the last and first coordinates in the list to create a closed shape. Used to define regions in an image for operations like encryption/decryption. * * Log Safety: SAFE */ declare type ImageRegionPolygon = Array; /** * The format of an imagery media item. * * Log Safety: SAFE */ declare type ImageryDecodeFormat = "BMP" | "TIFF" | "NITF" | "JP2K" | "JPG" | "PNG" | "WEBP"; /** * The output format for encoding imagery. * * Log Safety: UNSAFE */ declare type ImageryEncodeFormat = ({ type: "jpg"; } & JpgFormat) | ({ type: "tiff"; } & TiffFormat) | ({ type: "png"; } & PngFormat) | ({ type: "webp"; } & WebpFormat); /** * Metadata for imagery (image) media items. * * Log Safety: UNSAFE */ declare interface ImageryMediaItemMetadata { format: ImageryDecodeFormat; dimensions?: Dimensions; bands: Array; attributes: Record>; iccProfile?: string; geo?: GeoMetadata; pages?: number; orientation?: Orientation; sizeBytes: number; } /** * Specification for image processing parameters used in vision-based extraction. Controls how document pages are converted to images before being sent to vision models. * * Log Safety: SAFE */ declare interface ImageSpec { resizingMode: ResizingMode; height?: number; width?: number; mimeType: ImageryDecodeFormat; } /** * The operation to perform for image to document conversion. * * Log Safety: UNSAFE */ declare type ImageToDocumentOperation = { type: "createPdf"; } & CreatePdfOperation; /** * Converts images to documents. * * Log Safety: UNSAFE */ declare interface ImageToDocumentTransformation { operation: ImageToDocumentOperation; } /** * The operation to perform for image to embedding conversion. * * Log Safety: UNSAFE */ declare type ImageToEmbeddingOperation = { type: "generateEmbedding"; } & GenerateEmbeddingOperation; /** * Generates embeddings from images. * * Log Safety: UNSAFE */ declare interface ImageToEmbeddingTransformation { operation: ImageToEmbeddingOperation; } /** * The operation to perform for image to text conversion. * * Log Safety: UNSAFE */ declare type ImageToTextOperation = ({ type: "extractLayoutAwareContent"; } & ImageExtractLayoutAwareContentOperation) | ({ type: "ocr"; } & ImageOcrOperation); /** * Extracts text from images. * * Log Safety: UNSAFE */ declare interface ImageToTextTransformation { operation: ImageToTextOperation; } /** * Transforms images with multiple operations applied in sequence. Operations are applied in the order they appear in the list. * * Log Safety: UNSAFE */ declare interface ImageTransformation { encoding: ImageryEncodeFormat; operations: Array; } /** * Indicates whether the response should include compute usage details for the request. This feature is currently only available for OSDK applications. Note: Enabling this flag may slow down query performance and is not recommended for use in production. * * Log Safety: SAFE */ declare type IncludeComputeUsage = boolean; /** * When resolving the latest version, whether prerelease versions are considered. Defaults to false, except when latestVersionResolution is PUBLISH_TIME. Not supported together with version. * * Log Safety: SAFE */ declare type IncludePrerelease = boolean; /** * A wrapper object set type is incompatible with one or more of the nested object set types. For example, an interfaceLinkSearchAround object set wrapping a non-interface object set. * * Log Safety: SAFE */ declare interface IncompatibleNestedObjectSet { errorCode: "INVALID_ARGUMENT"; errorName: "IncompatibleNestedObjectSet"; errorDescription: "A wrapper object set type is incompatible with one or more of the nested object set types. For example, an interfaceLinkSearchAround object set wrapping a non-interface object set."; errorInstanceId: string; parameters: {}; } /** * Array elements have inconsistent dimensions. * * Log Safety: UNSAFE */ declare interface InconsistentArrayDimensionsError { firstElementShape: Array; conflictingElementShape: Array; } /** * The inference request failed due to a model execution error or unexpected internal issue. This typically indicates a problem with the model itself rather than the input data. * * Log Safety: UNSAFE */ declare interface InferenceFailure { errorCode: "INVALID_ARGUMENT"; errorName: "InferenceFailure"; errorDescription: "The inference request failed due to a model execution error or unexpected internal issue. This typically indicates a problem with the model itself rather than the input data."; errorInstanceId: string; parameters: { liveDeploymentRid: unknown; errorMessage: unknown; }; } /** * The specific type and details of an input validation error for inference requests. Each variant carries parameters relevant to that specific error category. * * Log Safety: UNSAFE */ declare type InferenceInputErrorType = ({ type: "invalidArrayShape"; } & InvalidArrayShapeError) | ({ type: "typeMismatch"; } & TypeMismatchError) | ({ type: "unsupportedType"; } & UnsupportedTypeError) | ({ type: "unknownInputName"; } & UnknownInputNameError) | ({ type: "invalidTabularFormat"; } & InvalidTabularFormatError) | ({ type: "inconsistentArrayDimensions"; } & InconsistentArrayDimensionsError) | ({ type: "requiredValueMissing"; } & RequiredValueMissingError) | ({ type: "invalidMapFormat"; } & InvalidMapFormatError); /** * The inference request contains invalid input data that does not match the model's API specification. Check the error type for specific validation failure details. * * Log Safety: UNSAFE */ declare interface InferenceInvalidInput { errorCode: "INVALID_ARGUMENT"; errorName: "InferenceInvalidInput"; errorDescription: "The inference request contains invalid input data that does not match the model's API specification. Check the error type for specific validation failure details."; errorInstanceId: string; parameters: { liveDeploymentRid: unknown; errorType: unknown; }; } /** * The live deployment took longer than 5 minutes to respond to the inference request. This typically indicates the model execution is taking too long or the deployment is under heavy load. * * Log Safety: SAFE */ declare interface InferenceTimeout { errorCode: "TIMEOUT"; errorName: "InferenceTimeout"; errorDescription: "The live deployment took longer than 5 minutes to respond to the inference request. This typically indicates the model execution is taking too long or the deployment is under heavy load."; errorInstanceId: string; parameters: { liveDeploymentRid: unknown; }; } /** * Gets information about the media item. * * @public * * Required Scopes: [api:mediasets-read] * URL: /v2/mediasets/{mediaSetRid}/items/{mediaItemRid} */ declare function info($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ mediaSetRid: _Core.MediaSetRid, mediaItemRid: _Core.MediaItemRid, $headerParams?: { ReadToken?: _Core.MediaItemReadToken | undefined; } ]): Promise<_MediaSets.GetMediaItemInfoResponse>; /** * A string alias used to identify inputs in a Model Studio configuration. * * Log Safety: UNSAFE */ declare type InputAlias = LooselyBrandedString_15<"InputAlias">; /** * One or more backing datasets do not live in the same project as the view. Add the missing datasets as project resource references to the view's project using the Filesystem API, or move them into the view's project, and then retry. * * Log Safety: SAFE */ declare interface InputBackingDatasetNotInOutputViewProject { errorCode: "INVALID_ARGUMENT"; errorName: "InputBackingDatasetNotInOutputViewProject"; errorDescription: "One or more backing datasets do not live in the same project as the view. Add the missing datasets as project resource references to the view's project using the Filesystem API, or move them into the view's project, and then retry."; errorInstanceId: string; parameters: { viewProjectRid: unknown; invalidBackingDatasets: unknown; }; } /** * Custom retrieved context to provide to an Agent for continuing a session. * * Log Safety: UNSAFE */ declare type InputContext = ({ type: "functionRetrievedContext"; } & FunctionRetrievedContext) | ({ type: "objectContext"; } & ObjectContext); /** * Returns action types which reference the object type with the given rid as an input or product. * * Log Safety: SAFE */ declare interface InputObjectTypeRidActionTypesQueryV2 { value: ObjectTypeRid_2; } /** * @deprecated Use `InQuery` in the `foundry.ontologies` package * * Returns objects where the specified field equals any of the provided values. * * Log Safety: UNSAFE */ declare interface InQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: Array; } /** * Returns objects where the specified field equals any of the provided values. Allows you to specify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects in the object set. Either field or propertyIdentifier must be supplied, but not both. For string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager. * * Log Safety: UNSAFE */ declare interface InQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: Array; } /** * The state for an incremental table import using a numeric integer datatype. * * Log Safety: UNSAFE */ declare interface IntegerColumnInitialIncrementalState { columnName: string; currentValue: number; } /** * An integer parameter value. * * Log Safety: UNSAFE */ declare interface IntegerParameter { value: string; } /** * Log Safety: SAFE */ declare interface IntegerType { } /** * Log Safety: SAFE */ declare interface IntegerType_2 { } /** * Log Safety: UNSAFE */ declare interface IntegerValue { value: number; } /** * Log Safety: UNSAFE */ declare type IntegerValue_2 = number; /** * Identifier of the interaction associated with a record. * * Log Safety: SAFE */ declare type InteractionRid = LooselyBrandedString_11<"InteractionRid">; /** * The name in the API of an action defined on an interface that implementing object types provide a concrete action type for. * * Log Safety: UNSAFE */ declare type InterfaceActionTypeConstraintApiName = LooselyBrandedString_5<"InterfaceActionTypeConstraintApiName">; /** * The requested object set type is not supported for interface-based object sets. * * Log Safety: SAFE */ declare interface InterfaceBasedObjectSetNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "InterfaceBasedObjectSetNotSupported"; errorDescription: "The requested object set type is not supported for interface-based object sets."; errorInstanceId: string; parameters: {}; } /** * An interface property type with an additional field to indicate constraints that need to be satisfied by implementing object property types. * * Log Safety: UNSAFE */ declare interface InterfaceDefinedPropertyType { rid: InterfacePropertyTypeRid; apiName: InterfacePropertyApiName; displayName: _Core.DisplayName; description?: string; dataType: ObjectPropertyType; valueTypeApiName?: ValueTypeApiName; requireImplementation: boolean; typeClasses: Array; } /** * A link type constraint defined at the interface level where the implementation of the links is provided by the implementing object types. * * Log Safety: UNSAFE */ declare interface InterfaceLinkType { rid: InterfaceLinkTypeRid; apiName: InterfaceLinkTypeApiName; displayName: _Core.DisplayName; description?: string; linkedEntityApiName: InterfaceLinkTypeLinkedEntityApiName; cardinality: InterfaceLinkTypeCardinality; required: boolean; } /** * The name of the interface link type in the API. To find the API name for your Interface Link Type, check the Ontology Manager. * * Log Safety: UNSAFE */ declare type InterfaceLinkTypeApiName = LooselyBrandedString_5<"InterfaceLinkTypeApiName">; /** * The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects. * * Log Safety: SAFE */ declare type InterfaceLinkTypeCardinality = "ONE" | "MANY"; /** * A reference to the linked entity. This can either be an object or an interface type. * * Log Safety: UNSAFE */ declare type InterfaceLinkTypeLinkedEntityApiName = ({ type: "objectTypeApiName"; } & LinkedObjectTypeApiName) | ({ type: "interfaceTypeApiName"; } & LinkedInterfaceTypeApiName); /** * The requested interface link type is not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface InterfaceLinkTypeNotFound { errorCode: "NOT_FOUND"; errorName: "InterfaceLinkTypeNotFound"; errorDescription: "The requested interface link type is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { interfaceTypeApiName: unknown; interfaceTypeRid: unknown; interfaceLinkTypeApiName: unknown; interfaceLinkTypeRid: unknown; }; } /** * The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type InterfaceLinkTypeRid = LooselyBrandedString_5<"InterfaceLinkTypeRid">; /** * Represents an interface parameter property argument in a logic rule. * * Log Safety: UNSAFE */ declare interface InterfaceParameterPropertyArgument { parameterId: ParameterId_2; sharedPropertyTypeRid: string; } /** * Properties used in ordering must have the same ids. * * Log Safety: UNSAFE */ declare interface InterfacePropertiesHaveDifferentIds { errorCode: "INVALID_ARGUMENT"; errorName: "InterfacePropertiesHaveDifferentIds"; errorDescription: "Properties used in ordering must have the same ids."; errorInstanceId: string; parameters: { properties: unknown; }; } /** * The requested interface property types are not present on every object type. * * Log Safety: UNSAFE */ declare interface InterfacePropertiesNotFound { errorCode: "NOT_FOUND"; errorName: "InterfacePropertiesNotFound"; errorDescription: "The requested interface property types are not present on every object type."; errorInstanceId: string; parameters: { objectType: unknown; missingInterfaceProperties: unknown; }; } /** * The name of the interface property type in the API in lowerCamelCase format. To find the API name for your interface property type, use the List interface types endpoint and check the allPropertiesV2 field or check the Ontology Manager. * * Log Safety: UNSAFE */ declare type InterfacePropertyApiName = LooselyBrandedString_5<"InterfacePropertyApiName">; /** * An implementation of an interface property via a local property. * * Log Safety: UNSAFE */ declare interface InterfacePropertyLocalPropertyImplementation { propertyApiName: PropertyApiName_2; } /** * The requested interface property was not found on the interface type. * * Log Safety: UNSAFE */ declare interface InterfacePropertyNotFound { errorCode: "NOT_FOUND"; errorName: "InterfacePropertyNotFound"; errorDescription: "The requested interface property was not found on the interface type."; errorInstanceId: string; parameters: { interfaceType: unknown; interfaceProperty: unknown; }; } /** * An implementation of an interface property via applying reducers on the nested implementation. * * Log Safety: UNSAFE */ declare interface InterfacePropertyReducedPropertyImplementation { implementation: NestedInterfacePropertyTypeImplementation; } /** * An implementation of an interface property via the field of a local struct property. * * Log Safety: UNSAFE */ declare interface InterfacePropertyStructFieldImplementation { structFieldOfProperty: StructFieldOfPropertyImplementation; } /** * An implementation of a struct interface property via a local struct property. Specifies a mapping of interface struct fields to local struct fields or properties. * * Log Safety: UNSAFE */ declare interface InterfacePropertyStructImplementation { mapping: InterfacePropertyStructImplementationMapping; } /** * An implementation of a struct interface property via a local struct property. Specifies a mapping of interface struct fields to local struct fields or properties. * * Log Safety: UNSAFE */ declare type InterfacePropertyStructImplementationMapping = Record; /** * The definition of an interface property type on an interface. An interface property can either be backed by a shared property type or defined on the interface directly. * * Log Safety: UNSAFE */ declare type InterfacePropertyType = ({ type: "interfaceDefinedPropertyType"; } & InterfaceDefinedPropertyType) | ({ type: "interfaceSharedPropertyType"; } & InterfaceSharedPropertyType); /** * Describes how an object type implements an interface property. * * Log Safety: UNSAFE */ declare type InterfacePropertyTypeImplementation = ({ type: "structFieldImplementation"; } & InterfacePropertyStructFieldImplementation) | ({ type: "structImplementation"; } & InterfacePropertyStructImplementation) | ({ type: "localPropertyImplementation"; } & InterfacePropertyLocalPropertyImplementation) | ({ type: "reducedPropertyImplementation"; } & InterfacePropertyReducedPropertyImplementation); /** * The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type InterfacePropertyTypeRid = LooselyBrandedString_5<"InterfacePropertyTypeRid">; /** * A shared property type with an additional field to indicate whether the property must be included on every object type that implements the interface, or whether it is optional. * * Log Safety: UNSAFE */ declare interface InterfaceSharedPropertyType { rid: SharedPropertyTypeRid; apiName: SharedPropertyTypeApiName; displayName: _Core.DisplayName; description?: string; dataType: ObjectPropertyType; valueTypeApiName?: ValueTypeApiName; valueFormatting?: PropertyValueFormattingRule; required: boolean; typeClasses: Array; } /** * Represents an implementation of an interface (the mapping of interface property to local property). * * Log Safety: UNSAFE */ declare type InterfaceToObjectTypeMapping = Record; /** * Map from object type to the interface-to-object-type mapping for that object type. * * Log Safety: UNSAFE */ declare type InterfaceToObjectTypeMappings = Record; /** * Map from object type to the interface property implementations of that object type. * * Log Safety: UNSAFE */ declare type InterfaceToObjectTypeMappingsV2 = Record; /** * Represents an implementation of an interface (the mapping of interface property to how it is implemented. * * Log Safety: UNSAFE */ declare type InterfaceToObjectTypeMappingV2 = Record; /** * Represents an interface type in the Ontology. * * Log Safety: UNSAFE */ declare interface InterfaceType { rid: InterfaceTypeRid; apiName: InterfaceTypeApiName; displayName: _Core.DisplayName; description?: string; properties: Record; allProperties: Record; propertiesV2: Record; allPropertiesV2: Record; extendsInterfaces: Array; allExtendsInterfaces: Array; implementedByObjectTypes: Array; links: Record; allLinks: Record; } /** * The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface type, use the List interface types endpoint or check the Ontology Manager. * * Log Safety: UNSAFE */ declare type InterfaceTypeApiName = LooselyBrandedString_5<"InterfaceTypeApiName">; /** * The requested interface type is not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface InterfaceTypeNotFound { errorCode: "NOT_FOUND"; errorName: "InterfaceTypeNotFound"; errorDescription: "The requested interface type is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { apiName: unknown; rid: unknown; }; } /** * The unique resource identifier of an interface, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type InterfaceTypeRid = LooselyBrandedString_5<"InterfaceTypeRid">; /** * Identifier for an ontology interface type. * * Log Safety: SAFE */ declare type InterfaceTypeRid_2 = LooselyBrandedString_19<"InterfaceTypeRid">; /** * The requested interface types were not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface InterfaceTypesNotFound { errorCode: "NOT_FOUND"; errorName: "InterfaceTypesNotFound"; errorDescription: "The requested interface types were not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { apiName: unknown; rid: unknown; }; } /** * @deprecated Use `IntersectsBoundingBoxQuery` in the `foundry.ontologies` package * * Returns objects where the specified field intersects the bounding box provided. * * Log Safety: UNSAFE */ declare interface IntersectsBoundingBoxQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: BoundingBoxValue; } /** * Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface IntersectsBoundingBoxQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: BoundingBoxValue_2; } /** * @deprecated Use `IntersectsPolygonQuery` in the `foundry.ontologies` package * * Returns objects where the specified field intersects the polygon provided. * * Log Safety: UNSAFE */ declare interface IntersectsPolygonQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: PolygonValue; } /** * Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface IntersectsPolygonQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: PolygonValue_2; } /** * Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of text fields. Either field or propertyIdentifier can be supplied, but not both. * * Log Safety: UNSAFE */ declare interface IntervalQuery { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; rule: IntervalQueryRule; } /** * Sub-rule used for evaluating an IntervalQuery * * Log Safety: UNSAFE */ declare type IntervalQueryRule = ({ type: "allOf"; } & AllOfRule) | ({ type: "match"; } & MatchRule) | ({ type: "anyOf"; } & AnyOfRule) | ({ type: "prefixOnLastToken"; } & PrefixOnLastTokenRule) | ({ type: "fuzzy"; } & FuzzyRule); /** * The provided version string is not a valid format for an Agent version. * * Log Safety: SAFE */ declare interface InvalidAgentVersion { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAgentVersion"; errorDescription: "The provided version string is not a valid format for an Agent version."; errorInstanceId: string; parameters: { agentRid: unknown; version: unknown; }; } /** * Aggregation ordering can only be applied to metrics with exactly one groupBy clause. * * Log Safety: SAFE */ declare interface InvalidAggregationOrdering { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAggregationOrdering"; errorDescription: "Aggregation ordering can only be applied to metrics with exactly one groupBy clause."; errorInstanceId: string; parameters: {}; } /** * Aggregation ordering cannot be applied for groupBy clauses that allow null values. * * Log Safety: SAFE */ declare interface InvalidAggregationOrderingWithNullValues { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAggregationOrderingWithNullValues"; errorDescription: "Aggregation ordering cannot be applied for groupBy clauses that allow null values."; errorInstanceId: string; parameters: {}; } /** * Aggregation range should include one lt or lte and one gt or gte. * * Log Safety: SAFE */ declare interface InvalidAggregationRange { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAggregationRange"; errorDescription: "Aggregation range should include one lt or lte and one gt or gte."; errorInstanceId: string; parameters: {}; } /** * Range group by is not supported by property type. * * Log Safety: UNSAFE */ declare interface InvalidAggregationRangePropertyType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAggregationRangePropertyType"; errorDescription: "Range group by is not supported by property type."; errorInstanceId: string; parameters: { property: unknown; objectType: unknown; propertyBaseType: unknown; }; } /** * Range group by is not supported by interface property type. * * Log Safety: UNSAFE */ declare interface InvalidAggregationRangePropertyTypeForInterface { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAggregationRangePropertyTypeForInterface"; errorDescription: "Range group by is not supported by interface property type."; errorInstanceId: string; parameters: { interfaceProperty: unknown; interfaceType: unknown; propertyBaseType: unknown; }; } /** * Aggregation value does not conform to the expected underlying type. * * Log Safety: UNSAFE */ declare interface InvalidAggregationRangeValue { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAggregationRangeValue"; errorDescription: "Aggregation value does not conform to the expected underlying type."; errorInstanceId: string; parameters: { property: unknown; objectType: unknown; propertyBaseType: unknown; }; } /** * Aggregation value does not conform to the expected underlying type. * * Log Safety: UNSAFE */ declare interface InvalidAggregationRangeValueForInterface { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAggregationRangeValueForInterface"; errorDescription: "Aggregation value does not conform to the expected underlying type."; errorInstanceId: string; parameters: { interfaceProperty: unknown; interfaceType: unknown; propertyBaseType: unknown; }; } /** * The provided AND filter should have at least one sub-filter. * * Log Safety: SAFE */ declare interface InvalidAndFilter { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAndFilter"; errorDescription: "The provided AND filter should have at least one sub-filter."; errorInstanceId: string; parameters: {}; } /** * The AND trigger should have at least one value. * * Log Safety: SAFE */ declare interface InvalidAndTrigger { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAndTrigger"; errorDescription: "The AND trigger should have at least one value."; errorInstanceId: string; parameters: {}; } /** * The given options are individually valid but cannot be used in the given combination. * * Log Safety: SAFE */ declare interface InvalidApplyActionOptionCombination { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidApplyActionOptionCombination"; errorDescription: "The given options are individually valid but cannot be used in the given combination."; errorInstanceId: string; parameters: { invalidCombination: unknown; }; } /** * Array dimensions do not match expected ndarray shape. * * Log Safety: UNSAFE */ declare interface InvalidArrayShapeError { expectedShape: Array; actualShape?: Array; } /** * The attribution provided in the header could not be parsed to a valid RID, or to a comma separated list of valid RIDs. * * Log Safety: UNSAFE */ declare interface InvalidAttributionHeader { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidAttributionHeader"; errorDescription: "The attribution provided in the header could not be parsed to a valid RID, or to a comma separated list of valid RIDs."; errorInstanceId: string; parameters: { header: unknown; }; } /** * The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs. * * Log Safety: UNSAFE */ declare interface InvalidBranchName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidBranchName"; errorDescription: "The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs."; errorInstanceId: string; parameters: { branchName: unknown; }; } /** * The change data capture configuration is invalid. * * Log Safety: SAFE */ declare interface InvalidChangeDataCaptureConfiguration { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidChangeDataCaptureConfiguration"; errorDescription: "The change data capture configuration is invalid."; errorInstanceId: string; parameters: {}; } /** * A child document's parent must be a folder or another document. * * Log Safety: SAFE */ declare interface InvalidChildDocumentParent { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidChildDocumentParent"; errorDescription: "A child document's parent must be a folder or another document."; errorInstanceId: string; parameters: { parentResourceRid: unknown; }; } /** * Reasons why a connection configuration is invalid. * * Log Safety: SAFE */ declare type InvalidConnectionReason = "CONNECTION_NOT_FOUND" | "INVALID_CREDENTIALS" | "NETWORK_POLICY_VIOLATION" | "CONNECTION_UNAVAILABLE" | "CANNOT_DESERIALIZE" | "CANNOT_SUBSTITUTE_SECRETS" | "CANNOT_USE_USER_HOME_FOLDER" | "INVALID_SOURCE_RUNTIME" | "INVALID_SOURCE_TYPE" | "MISSING_CREDENTIALS" | "MISSING_PROXY_SETTINGS" | "NOT_CLOUD_RUNTIME" | "NO_AGENTS_ASSIGNED" | "SERVICE_UNAVAILABLE" | "TOO_MANY_REQUESTS" | "AZURE_CONTAINER_DOES_NOT_EXIST" | "AZURE_MANAGED_IDENTITY_AUTH_NOT_SUPPORTED" | "AZURE_REFRESH_TOKEN_AUTH_NOT_SUPPORTED" | "AZURE_SHARED_ACCESS_SIGNATURE_AUTH_NOT_SUPPORTED" | "AZURE_SHARED_KEY_AUTH_NOT_SUPPORTED" | "AZURE_TENANT_NOT_FOUND" | "INVALID_ABFS_ROOT_DIRECTORY" | "INVALID_CLIENT_ENDPOINT" | "DATABRICKS_AUTH_UNSUPPORTED" | "DATABRICKS_BASIC_AUTH_NOT_SUPPORTED" | "DATABRICKS_INVALID_CLIENT_CREDENTIALS" | "DATABRICKS_INVALID_HOST" | "DATABRICKS_INVALID_HTTP_PATH" | "DATABRICKS_INVALID_OIDC_CREDENTIALS" | "DATABRICKS_INVALID_TOKEN_URL" | "GCP_INSTANCE_AUTH_NOT_SUPPORTED" | "GCP_INVALID_OIDC_CREDENTIALS" | "INVALID_GCS_CONFIG" | "INVALID_GCS_URL" | "GCS_INVALID_PREFIX_PATH" | "MISSING_GLUE_CATALOG" | "INVALID_HIVE_URL" | "INVALID_KERBEROS_URL" | "MISSING_HIVE_CONFIGURATION" | "ICEBERG_CATALOG_UNSUPPORTED" | "INVALID_ICEBERG_CATALOG_URL" | "INVALID_ICEBERG_TOKEN_URL" | "CONNECTION_FAILED" | "INVALID_JDBC_DRIVER" | "INVALID_JDBC_URL" | "AWS_BUCKET_DOES_NOT_EXIST" | "AWS_SESSION_TOKEN_NOT_SUPPORTED" | "INVALID_S3_ENDPOINT" | "INVALID_S3_URL" | "INVALID_STS_ENDPOINT" | "MISSING_STS_ROLE" | "STS_ASSUME_ROLE_DENIED" | "INVALID_SNOWFLAKE_URL" | "SNOWFLAKE_IAM_AUTH_NOT_SUPPORTED" | "SNOWFLAKE_RSA_AUTH_NOT_SUPPORTED" | "INVALID_UNITY_CATALOG_TOKEN_URL" | "INVALID_UNITY_CATALOG_URL" | "MISSING_UNITY_CATALOG" | "UNITY_CATALOG_EXTERNAL_ACCESS_NOT_ENABLED" | "UNITY_CATALOG_INSUFFICIENT_PERMISSIONS" | "UNITY_CATALOG_TEMPORARY_CREDENTIALS_FAILED"; /** * A Content-Length header is required for all uploads, but was missing or invalid. * * Log Safety: SAFE */ declare interface InvalidContentLength { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidContentLength"; errorDescription: "A Content-Length header is required for all uploads, but was missing or invalid."; errorInstanceId: string; parameters: {}; } /** * The Content-Type cannot be inferred from the request content and filename. Please check your request content and filename to ensure they are compatible. * * Log Safety: SAFE */ declare interface InvalidContentType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidContentType"; errorDescription: "The Content-Type cannot be inferred from the request content and filename. Please check your request content and filename to ensure they are compatible."; errorInstanceId: string; parameters: {}; } /** * Either the user has not passed default roles for a template with suggested default roles, or has passed default roles for a template with fixed default roles. * * Log Safety: SAFE */ declare interface InvalidDefaultRoles { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDefaultRoles"; errorDescription: "Either the user has not passed default roles for a template with suggested default roles, or has passed default roles for a template with fixed default roles."; errorInstanceId: string; parameters: {}; } /** * Derived property definition was invalid due to shape of query or type checking. * * Log Safety: UNSAFE */ declare interface InvalidDerivedPropertyDefinition { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDerivedPropertyDefinition"; errorDescription: "Derived property definition was invalid due to shape of query or type checking."; errorInstanceId: string; parameters: { objectType: unknown; derivedProperty: unknown; }; } /** * Derived property definition on an interface-typed object set was invalid due to shape of query or type checking. * * Log Safety: UNSAFE */ declare interface InvalidDerivedPropertyDefinitionOnInterface { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDerivedPropertyDefinitionOnInterface"; errorDescription: "Derived property definition on an interface-typed object set was invalid due to shape of query or type checking."; errorInstanceId: string; parameters: { interfaceType: unknown; derivedProperty: unknown; }; } /** * Either the user has not passed a value for a template with unset project description, or has passed a value for a template with fixed project description. * * Log Safety: SAFE */ declare interface InvalidDescription { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDescription"; errorDescription: "Either the user has not passed a value for a template with unset project description, or has passed a value for a template with fixed project description."; errorInstanceId: string; parameters: {}; } /** * The base href in the dev mode settings is invalid. It must be a valid localhost URL with an optional port. * * Log Safety: UNSAFE */ declare interface InvalidDevModeBaseHref { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDevModeBaseHref"; errorDescription: "The base href in the dev mode settings is invalid. It must be a valid localhost URL with an optional port."; errorInstanceId: string; parameters: { baseHref: unknown; }; } /** * The dev mode settings contains too many CSS entrypoints. You must limit the number of CSS entrypoints to the maximum allowed. * * Log Safety: SAFE */ declare interface InvalidDevModeEntrypointCssCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDevModeEntrypointCssCount"; errorDescription: "The dev mode settings contains too many CSS entrypoints. You must limit the number of CSS entrypoints to the maximum allowed."; errorInstanceId: string; parameters: { reason: unknown; entrypointCssCount: unknown; }; } /** * The dev mode settings contains too many JavaScript entrypoints. You must limit the number of JavaScript entrypoints to the maximum allowed. * * Log Safety: SAFE */ declare interface InvalidDevModeEntrypointJsCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDevModeEntrypointJsCount"; errorDescription: "The dev mode settings contains too many JavaScript entrypoints. You must limit the number of JavaScript entrypoints to the maximum allowed."; errorInstanceId: string; parameters: { reason: unknown; entrypointJsCount: unknown; }; } /** * The dev mode settings contains an invalid entrypoint file path. The file path must be a valid localhost URL with an optional port and a file path. * * Log Safety: UNSAFE */ declare interface InvalidDevModeFilePath { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDevModeFilePath"; errorDescription: "The dev mode settings contains an invalid entrypoint file path. The file path must be a valid localhost URL with an optional port and a file path."; errorInstanceId: string; parameters: { reason: unknown; filePath: unknown; }; } /** * The dev mode settings contains too many widget settings. You must limit the number of widget settings to the maximum allowed. * * Log Safety: SAFE */ declare interface InvalidDevModeWidgetSettingsCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDevModeWidgetSettingsCount"; errorDescription: "The dev mode settings contains too many widget settings. You must limit the number of widget settings to the maximum allowed."; errorInstanceId: string; parameters: { reason: unknown; widgetSettingsCount: unknown; }; } /** * The display name of a resource should not be exactly . or .., contain a forward slash / and must be less than or equal to 700 characters. * * Log Safety: UNSAFE */ declare interface InvalidDisplayName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDisplayName"; errorDescription: "The display name of a resource should not be exactly . or .., contain a forward slash / and must be less than or equal to 700 characters."; errorInstanceId: string; parameters: { displayName: unknown; }; } /** * The provided Document Type Name is invalid. First-party document type names must follow the format com.palantir.pack... * * Log Safety: UNSAFE */ declare interface InvalidDocumentTypeName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDocumentTypeName"; errorDescription: "The provided Document Type Name is invalid. First-party document type names must follow the format com.palantir.pack..."; errorInstanceId: string; parameters: { documentTypeName: unknown; }; } /** * The provided Document Type Version is invalid. The version must be a positive integer. * * Log Safety: UNSAFE */ declare interface InvalidDocumentTypeVersion { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDocumentTypeVersion"; errorDescription: "The provided Document Type Version is invalid. The version must be a positive integer."; errorInstanceId: string; parameters: { documentTypeName: unknown; version: unknown; }; } /** * Invalid property type for duration groupBy. * * Log Safety: UNSAFE */ declare interface InvalidDurationGroupByPropertyType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDurationGroupByPropertyType"; errorDescription: "Invalid property type for duration groupBy."; errorInstanceId: string; parameters: { property: unknown; objectType: unknown; propertyBaseType: unknown; }; } /** * Invalid interface property type for duration groupBy. * * Log Safety: UNSAFE */ declare interface InvalidDurationGroupByPropertyTypeForInterface { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDurationGroupByPropertyTypeForInterface"; errorDescription: "Invalid interface property type for duration groupBy."; errorInstanceId: string; parameters: { interfaceProperty: unknown; interfaceType: unknown; propertyBaseType: unknown; }; } /** * Duration groupBy value is invalid. Units larger than day must have value 1 and date properties do not support filtering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by every two hours are allowed. * * Log Safety: SAFE */ declare interface InvalidDurationGroupByValue { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidDurationGroupByValue"; errorDescription: "Duration groupBy value is invalid. Units larger than day must have value 1 and date properties do not support filtering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by every two hours are allowed."; errorInstanceId: string; parameters: {}; } /** * The widget declares too many CSS entrypoints. You must limit the number of CSS entrypoints to the maximum allowed. * * Log Safety: SAFE */ declare interface InvalidEntrypointCssCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidEntrypointCssCount"; errorDescription: "The widget declares too many CSS entrypoints. You must limit the number of CSS entrypoints to the maximum allowed."; errorInstanceId: string; parameters: { reason: unknown; entrypointCssCount: unknown; }; } /** * The widget declares too many JavaScript entrypoints. You must limit the number of JavaScript entrypoints to the maximum allowed. * * Log Safety: SAFE */ declare interface InvalidEntrypointJsCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidEntrypointJsCount"; errorDescription: "The widget declares too many JavaScript entrypoints. You must limit the number of JavaScript entrypoints to the maximum allowed."; errorInstanceId: string; parameters: { reason: unknown; entrypointJsCount: unknown; }; } /** * The widget config contains too many events. * * Log Safety: SAFE */ declare interface InvalidEventCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidEventCount"; errorDescription: "The widget config contains too many events."; errorInstanceId: string; parameters: { reason: unknown; eventCount: unknown; }; } /** * The event display name is invalid. * * Log Safety: UNSAFE */ declare interface InvalidEventDisplayName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidEventDisplayName"; errorDescription: "The event display name is invalid."; errorInstanceId: string; parameters: { reason: unknown; eventDisplayName: unknown; }; } /** * The event id is invalid. * * Log Safety: UNSAFE */ declare interface InvalidEventId { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidEventId"; errorDescription: "The event id is invalid."; errorInstanceId: string; parameters: { reason: unknown; eventId: unknown; }; } /** * The event parameter is invalid. * * Log Safety: UNSAFE */ declare interface InvalidEventParameter { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidEventParameter"; errorDescription: "The event parameter is invalid."; errorInstanceId: string; parameters: { reason: unknown; eventParameterId: unknown; }; } /** * The widget config contains an event with too many event parameters. * * Log Safety: SAFE */ declare interface InvalidEventParameterCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidEventParameterCount"; errorDescription: "The widget config contains an event with too many event parameters."; errorInstanceId: string; parameters: { reason: unknown; eventParameterCount: unknown; }; } /** * The event parameter id is invalid. * * Log Safety: UNSAFE */ declare interface InvalidEventParameterId { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidEventParameterId"; errorDescription: "The event parameter id is invalid."; errorInstanceId: string; parameters: { reason: unknown; eventParameterId: unknown; }; } /** * The event references an invalid parameter id. * * Log Safety: UNSAFE */ declare interface InvalidEventParameterUpdateId { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidEventParameterUpdateId"; errorDescription: "The event references an invalid parameter id."; errorInstanceId: string; parameters: { reason: unknown; parameterUpdateId: unknown; }; } /** * The search filter is invalid. This can occur when using an unsupported operator and value type combination in a parameter filter, filtering by an unsupported status, or providing a malformed filter. * * Log Safety: UNSAFE */ declare interface InvalidExperimentSearchFilter { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidExperimentSearchFilter"; errorDescription: "The search filter is invalid. This can occur when using an unsupported operator and value type combination in a parameter filter, filtering by an unsupported status, or providing a malformed filter."; errorInstanceId: string; parameters: { reason: unknown; }; } /** * The provided user locale is not valid. * * Log Safety: SAFE */ declare interface InvalidExportJobUserLocale { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidExportJobUserLocale"; errorDescription: "The provided user locale is not valid."; errorInstanceId: string; parameters: { userLocale: unknown; }; } /** * The value of the given field does not match the expected pattern. For example, an Ontology object property id should be written properties.id. * * Log Safety: UNSAFE */ declare interface InvalidFields { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidFields"; errorDescription: "The value of the given field does not match the expected pattern. For example, an Ontology object property id should be written properties.id."; errorInstanceId: string; parameters: { properties: unknown; }; } /** * The field schema failed validations * * Log Safety: UNSAFE */ declare interface InvalidFieldSchema { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidFieldSchema"; errorDescription: "The field schema failed validations"; errorInstanceId: string; parameters: { fieldName: unknown; message: unknown; }; } /** * The provided file path is invalid. Check that the path does not start with a leading slash. * * Log Safety: UNSAFE */ declare interface InvalidFilePath { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidFilePath"; errorDescription: "The provided file path is invalid. Check that the path does not start with a leading slash."; errorInstanceId: string; parameters: { filePath: unknown; }; } /** * The widget declares an invalid production entrypoint file path. * * Log Safety: UNSAFE */ declare interface InvalidFilePath_2 { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidFilePath"; errorDescription: "The widget declares an invalid production entrypoint file path."; errorInstanceId: string; parameters: { reason: unknown; filePath: unknown; }; } /** * The provided filter value is invalid. * * Log Safety: UNSAFE */ declare interface InvalidFilterValue { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidFilterValue"; errorDescription: "The provided filter value is invalid."; errorInstanceId: string; parameters: { field: unknown; value: unknown; expectedType: unknown; }; } /** * The given resource is not a Folder. * * Log Safety: UNSAFE */ declare interface InvalidFolder { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidFolder"; errorDescription: "The given resource is not a Folder."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * The provided API name for the function is invalid. * * Log Safety: UNSAFE */ declare interface InvalidFunctionApiName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidFunctionApiName"; errorDescription: "The provided API name for the function is invalid."; errorInstanceId: string; parameters: { apiName: unknown; }; } /** * A template parameter value is invalid (for example, is of the wrong type). * * Log Safety: UNSAFE */ declare interface InvalidGenerationJobTemplateParameter { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidGenerationJobTemplateParameter"; errorDescription: "A template parameter value is invalid (for example, is of the wrong type)."; errorInstanceId: string; parameters: { templateParameterName: unknown; reason: unknown; }; } /** * The provided template version doesn't exist or the template has no published versions. * * Log Safety: SAFE */ declare interface InvalidGenerationJobTemplateVersion { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidGenerationJobTemplateVersion"; errorDescription: "The provided template version doesn't exist or the template has no published versions."; errorInstanceId: string; parameters: { templateVersion: unknown; }; } /** * The GPU count is invalid. The GPU count must be between 1 and the maximum allowed for the requested GPU type. * * Log Safety: SAFE */ declare interface InvalidGpuCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidGpuCount"; errorDescription: "The GPU count is invalid. The GPU count must be between 1 and the maximum allowed for the requested GPU type."; errorInstanceId: string; parameters: { providedGpuCount: unknown; maxGpuCount: unknown; }; } /** * The provided value for a group id must be a UUID. * * Log Safety: UNSAFE */ declare interface InvalidGroupId { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidGroupId"; errorDescription: "The provided value for a group id must be a UUID."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * The member expiration you provided does not conform to the Group's requirements for member expirations. * * Log Safety: SAFE */ declare interface InvalidGroupMembershipExpiration { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidGroupMembershipExpiration"; errorDescription: "The member expiration you provided does not conform to the Group's requirements for member expirations."; errorInstanceId: string; parameters: { groupId: unknown; earliestExpiration: unknown; maximumDuration: unknown; maximumValue: unknown; }; } /** * At least one Organization RID must be provided for a group * * Log Safety: SAFE */ declare interface InvalidGroupOrganizations { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidGroupOrganizations"; errorDescription: "At least one Organization RID must be provided for a group"; errorInstanceId: string; parameters: {}; } /** * The provided hostname must be a valid domain name. The only allowed characters are letters, numbers, periods, and hyphens. * * Log Safety: UNSAFE */ declare interface InvalidHostName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidHostName"; errorDescription: "The provided hostname must be a valid domain name. The only allowed characters are letters, numbers, periods, and hyphens."; errorInstanceId: string; parameters: { invalidHostName: unknown; }; } /** * The provided manifest could not be parsed or is not well formed. * * Log Safety: UNSAFE */ declare interface InvalidManifest { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidManifest"; errorDescription: "The provided manifest could not be parsed or is not well formed."; errorInstanceId: string; parameters: { reason: unknown; value: unknown; }; } /** * Map input has incorrect structure or null keys. * * Log Safety: SAFE */ declare interface InvalidMapFormatError { } /** * The provided media item RID is invalid. * * Log Safety: UNSAFE */ declare interface InvalidMediaItemRid { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidMediaItemRid"; errorDescription: "The provided media item RID is invalid."; errorInstanceId: string; parameters: { mediaItemRid: unknown; reason: unknown; invalidFieldName: unknown; expectedFieldValue: unknown; actualFieldValue: unknown; }; } /** * The media item does not match the schema of the media set. * * Log Safety: UNSAFE */ declare interface InvalidMediaItemSchema { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidMediaItemSchema"; errorDescription: "The media item does not match the schema of the media set."; errorInstanceId: string; parameters: { mediaSetRid: unknown; path: unknown; }; } /** * The given MediaSet rid is invalid. * * Log Safety: SAFE */ declare interface InvalidMediaSetTrigger { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidMediaSetTrigger"; errorDescription: "The given MediaSet rid is invalid."; errorInstanceId: string; parameters: { mediaSetRid: unknown; }; } /** * The model api failed validations * * Log Safety: UNSAFE */ declare interface InvalidModelApi { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidModelApi"; errorDescription: "The model api failed validations"; errorInstanceId: string; parameters: { errorType: unknown; message: unknown; }; } /** * The request to create a Model Studio contains invalid arguments. * * Log Safety: SAFE */ declare interface InvalidModelStudioCreateRequest { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidModelStudioCreateRequest"; errorDescription: "The request to create a Model Studio contains invalid arguments."; errorInstanceId: string; parameters: {}; } /** * The NumericColumnCheckConfig is invalid. It must contain at least one of numericBounds or trend. * * Log Safety: SAFE */ declare interface InvalidNumericColumnCheckConfig { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidNumericColumnCheckConfig"; errorDescription: "The NumericColumnCheckConfig is invalid. It must contain at least one of numericBounds or trend."; errorInstanceId: string; parameters: {}; } /** * The object set event parameter type is invalid. * * Log Safety: UNSAFE */ declare interface InvalidObjectSetEventParameterType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidObjectSetEventParameterType"; errorDescription: "The object set event parameter type is invalid."; errorInstanceId: string; parameters: { reason: unknown; eventParameterId: unknown; value: unknown; }; } /** * The object set parameter type is invalid. * * Log Safety: UNSAFE */ declare interface InvalidObjectSetParameterType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidObjectSetParameterType"; errorDescription: "The object set parameter type is invalid."; errorInstanceId: string; parameters: { reason: unknown; parameterId: unknown; value: unknown; }; } /** * This query type does not support the provided order type * * Log Safety: SAFE */ declare interface InvalidOrderType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidOrderType"; errorDescription: "This query type does not support the provided order type"; errorInstanceId: string; parameters: { orderType: unknown; }; } /** * The provided OR filter should have at least one sub-filter. * * Log Safety: SAFE */ declare interface InvalidOrFilter { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidOrFilter"; errorDescription: "The provided OR filter should have at least one sub-filter."; errorInstanceId: string; parameters: {}; } /** * Organizations on a project must also exist on the parent space. This error is thrown if the configuration of a project's organizations (on creation or subsequently) results in the project being marked with either no organizations in a marked space, or with an organization that is not present on the parent space. * * Log Safety: SAFE */ declare interface InvalidOrganizationHierarchy { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidOrganizationHierarchy"; errorDescription: "Organizations on a project must also exist on the parent space. This error is thrown if the configuration of a project's organizations (on creation or subsequently) results in the project being marked with either no organizations in a marked space, or with an organization that is not present on the parent space."; errorInstanceId: string; parameters: { organizationRids: unknown; }; } /** * Either the user has not passed organizations for a template with suggested organizations, or has passed organization for a template with fixed organizations. * * Log Safety: SAFE */ declare interface InvalidOrganizations { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidOrganizations"; errorDescription: "Either the user has not passed organizations for a template with suggested organizations, or has passed organization for a template with fixed organizations."; errorInstanceId: string; parameters: {}; } /** * The OR trigger should have at least one value. * * Log Safety: SAFE */ declare interface InvalidOrTrigger { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidOrTrigger"; errorDescription: "The OR trigger should have at least one value."; errorInstanceId: string; parameters: {}; } /** * The provided page size was zero or negative. Page sizes must be greater than zero. * * Log Safety: SAFE */ declare interface InvalidPageSize { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPageSize"; errorDescription: "The provided page size was zero or negative. Page sizes must be greater than zero."; errorInstanceId: string; parameters: { pageSize: unknown; }; } /** * The provided page token is invalid. * * Log Safety: UNSAFE */ declare interface InvalidPageToken { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPageToken"; errorDescription: "The provided page token is invalid."; errorInstanceId: string; parameters: { pageToken: unknown; }; } /** * The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the parameters property, and version through the API with getAgent, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with getSession. * * Log Safety: UNSAFE */ declare interface InvalidParameter { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParameter"; errorDescription: "The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the parameters property, and version through the API with getAgent, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with getSession."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; parameter: unknown; }; } /** * The given parameters are individually valid but cannot be used in the given combination. * * Log Safety: SAFE */ declare interface InvalidParameterCombination { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParameterCombination"; errorDescription: "The given parameters are individually valid but cannot be used in the given combination."; errorInstanceId: string; parameters: { validCombinations: unknown; providedParameters: unknown; }; } /** * The widget config contains too many parameters. * * Log Safety: SAFE */ declare interface InvalidParameterCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParameterCount"; errorDescription: "The widget config contains too many parameters."; errorInstanceId: string; parameters: { reason: unknown; parameterCount: unknown; }; } /** * The parameter display name is invalid. * * Log Safety: UNSAFE */ declare interface InvalidParameterDisplayName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParameterDisplayName"; errorDescription: "The parameter display name is invalid."; errorInstanceId: string; parameters: { reason: unknown; parameterDisplayName: unknown; }; } /** * The parameter id is invalid. * * Log Safety: UNSAFE */ declare interface InvalidParameterId { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParameterId"; errorDescription: "The parameter id is invalid."; errorInstanceId: string; parameters: { reason: unknown; parameterId: unknown; }; } /** * The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the parameters property, and version through the API with getAgent, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with getSession. * * Log Safety: UNSAFE */ declare interface InvalidParameterType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParameterType"; errorDescription: "The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the parameters property, and version through the API with getAgent, or in AIP Chatbot Studio. The Agent version used for the session can be checked through the API with getSession."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; parameter: unknown; expectedType: unknown; receivedType: unknown; }; } /** * The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented. * * Log Safety: UNSAFE */ declare interface InvalidParameterValue { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParameterValue"; errorDescription: "The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented."; errorInstanceId: string; parameters: { parameterBaseType: unknown; parameterDataType: unknown; parameterId: unknown; parameterValue: unknown; }; } /** * The specified parent folder is not a valid destination for the resource. For example, a project cannot be moved under a regular folder, a folder cannot be moved to a Space, etc. * * Log Safety: SAFE */ declare interface InvalidParentFolder { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidParentFolder"; errorDescription: "The specified parent folder is not a valid destination for the resource. For example, a project cannot be moved under a regular folder, a folder cannot be moved to a Space, etc."; errorInstanceId: string; parameters: { parentFolderRid: unknown; }; } /** * The given path is invalid. A valid path has all components separated by a single /. * * Log Safety: UNSAFE */ declare interface InvalidPath { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPath"; errorDescription: "The given path is invalid. A valid path has all components separated by a single /."; errorInstanceId: string; parameters: { path: unknown; }; } /** * The PercentageCheckConfig is invalid. It must contain at least one of percentageBounds or medianDeviation. * * Log Safety: SAFE */ declare interface InvalidPercentageCheckConfig { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPercentageCheckConfig"; errorDescription: "The PercentageCheckConfig is invalid. It must contain at least one of percentageBounds or medianDeviation."; errorInstanceId: string; parameters: {}; } /** * The template requested for project creation contains principal IDs that do not exist. * * Log Safety: SAFE */ declare interface InvalidPrincipalIdsForGroupTemplate { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPrincipalIdsForGroupTemplate"; errorDescription: "The template requested for project creation contains principal IDs that do not exist."; errorInstanceId: string; parameters: { invalidPrincipalIds: unknown; }; } /** * The user's profile picture is not a valid image * * Log Safety: SAFE */ declare interface InvalidProfilePicture { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidProfilePicture"; errorDescription: "The user's profile picture is not a valid image"; errorInstanceId: string; parameters: { userId: unknown; }; } /** * The provided resource identifier does not refer to a valid project. * * Log Safety: SAFE */ declare interface InvalidProject { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidProject"; errorDescription: "The provided resource identifier does not refer to a valid project."; errorInstanceId: string; parameters: { projectRid: unknown; }; } /** * The provided filters cannot be used together. * * Log Safety: UNSAFE */ declare interface InvalidPropertyFiltersCombination { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPropertyFiltersCombination"; errorDescription: "The provided filters cannot be used together."; errorInstanceId: string; parameters: { propertyFilters: unknown; property: unknown; }; } /** * The value of the given property filter is invalid. For instance, 2 is an invalid value for isNull in properties.address.isNull=2 because the isNull filter expects a value of boolean type. * * Log Safety: UNSAFE */ declare interface InvalidPropertyFilterValue { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPropertyFilterValue"; errorDescription: "The value of the given property filter is invalid. For instance, 2 is an invalid value for isNull in properties.address.isNull=2 because the isNull filter expects a value of boolean type."; errorInstanceId: string; parameters: { expectedType: unknown; propertyFilter: unknown; propertyFilterValue: unknown; property: unknown; }; } /** * The given property type is not of the expected type. * * Log Safety: UNSAFE */ declare interface InvalidPropertyType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPropertyType"; errorDescription: "The given property type is not of the expected type."; errorInstanceId: string; parameters: { propertyBaseType: unknown; property: unknown; }; } /** * The value of the given property is invalid. See the documentation of PropertyValue for details on how properties are represented. * * Log Safety: UNSAFE */ declare interface InvalidPropertyValue { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPropertyValue"; errorDescription: "The value of the given property is invalid. See the documentation of PropertyValue for details on how properties are represented."; errorInstanceId: string; parameters: { propertyBaseType: unknown; property: unknown; propertyValue: unknown; }; } /** * The manifest file targets a widget set that has not linked the repository to publish. * * Log Safety: SAFE */ declare interface InvalidPublishRepository { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidPublishRepository"; errorDescription: "The manifest file targets a widget set that has not linked the repository to publish."; errorInstanceId: string; parameters: {}; } /** * The value of the query's output is invalid. This may be because the return value did not match the specified output type or constraints. * * Log Safety: UNSAFE */ declare interface InvalidQueryOutputValue { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidQueryOutputValue"; errorDescription: "The value of the query's output is invalid. This may be because the return value did not match the specified output type or constraints."; errorInstanceId: string; parameters: { outputDataType: unknown; outputValue: unknown; functionRid: unknown; functionVersion: unknown; }; } /** * The value of the query's output is invalid. This may be because the return value did not match the specified output type or constraints. * * Log Safety: UNSAFE */ declare interface InvalidQueryOutputValue_2 { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidQueryOutputValue"; errorDescription: "The value of the query's output is invalid. This may be because the return value did not match the specified output type or constraints."; errorInstanceId: string; parameters: { outputDataType: unknown; outputValue: unknown; functionRid: unknown; functionVersion: unknown; }; } /** * The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented. * * Log Safety: UNSAFE */ declare interface InvalidQueryParameterValue { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidQueryParameterValue"; errorDescription: "The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented."; errorInstanceId: string; parameters: { parameterDataType: unknown; parameterId: unknown; parameterValue: unknown; }; } /** * The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented. * * Log Safety: UNSAFE */ declare interface InvalidQueryParameterValue_2 { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidQueryParameterValue"; errorDescription: "The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented."; errorInstanceId: string; parameters: { parameterDataType: unknown; parameterId: unknown; parameterValue: unknown; }; } /** * The specified query range filter is invalid. * * Log Safety: UNSAFE */ declare interface InvalidRangeQuery { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidRangeQuery"; errorDescription: "The specified query range filter is invalid."; errorInstanceId: string; parameters: { lt: unknown; gt: unknown; lte: unknown; gte: unknown; field: unknown; }; } /** * The release description is invalid. * * Log Safety: UNSAFE */ declare interface InvalidReleaseDescription { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidReleaseDescription"; errorDescription: "The release description is invalid."; errorInstanceId: string; parameters: { reason: unknown; releaseDescription: unknown; }; } /** * The release contains zero widgets or too many widgets. * * Log Safety: SAFE */ declare interface InvalidReleaseWidgetsCount { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidReleaseWidgetsCount"; errorDescription: "The release contains zero widgets or too many widgets."; errorInstanceId: string; parameters: { reason: unknown; widgetsCount: unknown; }; } /** * The request was unable to be deserialized as a valid request to this endpoint. This may be either due to missing a required field or including a field which is not supported. * * Log Safety: UNSAFE */ declare interface InvalidRequest { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidRequest"; errorDescription: "The request was unable to be deserialized as a valid request to this endpoint. This may be either due to missing a required field or including a field which is not supported."; errorInstanceId: string; parameters: { message: unknown; params: unknown; }; } /** * A resource configuration field has an invalid format. * * Log Safety: UNSAFE */ declare interface InvalidResourceConfigurationError { field: string; message: string; } /** * The resource reference is invalid. This can occur when the resource identifier is malformed, the resource type does not match the reference type, or the resource cannot be added as a reference. * * Log Safety: UNSAFE */ declare interface InvalidResourceReference { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidResourceReference"; errorDescription: "The resource reference is invalid. This can occur when the resource identifier is malformed, the resource type does not match the reference type, or the resource cannot be added as a reference."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * A roleId referenced in either default roles or role grants does not exist in the project role set for the space. * * Log Safety: SAFE */ declare interface InvalidRoleIds { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidRoleIds"; errorDescription: "A roleId referenced in either default roles or role grants does not exist in the project role set for the space."; errorInstanceId: string; parameters: { requestedRoleIds: unknown; }; } /** * The schedule description is too long. * * Log Safety: SAFE */ declare interface InvalidScheduleDescription { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidScheduleDescription"; errorDescription: "The schedule description is too long."; errorInstanceId: string; parameters: {}; } /** * The schedule name is too long. * * Log Safety: SAFE */ declare interface InvalidScheduleName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidScheduleName"; errorDescription: "The schedule name is too long."; errorInstanceId: string; parameters: {}; } /** * The schema failed validations * * Log Safety: UNSAFE */ declare interface InvalidSchema { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidSchema"; errorDescription: "The schema failed validations"; errorInstanceId: string; parameters: { errorType: unknown; message: unknown; }; } /** * The share name is invalid. Share names cannot contain the following characters: \ / : * ? " < > | * * Log Safety: UNSAFE */ declare interface InvalidShareName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidShareName"; errorDescription: "The share name is invalid. Share names cannot contain the following characters: \\ / : * ? \" < > |"; errorInstanceId: string; parameters: { shareName: unknown; }; } /** * The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort order can also be omitted, and defaults to 'asc'. * * Log Safety: UNSAFE */ declare interface InvalidSortOrder { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidSortOrder"; errorDescription: "The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort order can also be omitted, and defaults to 'asc'."; errorInstanceId: string; parameters: { invalidSortOrder: unknown; }; } /** * The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'. * * Log Safety: SAFE */ declare interface InvalidSortType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidSortType"; errorDescription: "The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'."; errorInstanceId: string; parameters: { invalidSortType: unknown; }; } /** * The requested stream exists but is invalid, as it does not have a schema. * * Log Safety: UNSAFE */ declare interface InvalidStreamNoSchema { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidStreamNoSchema"; errorDescription: "The requested stream exists but is invalid, as it does not have a schema."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; viewRid: unknown; }; } /** * The stream type is invalid. * * Log Safety: SAFE */ declare interface InvalidStreamType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidStreamType"; errorDescription: "The stream type is invalid."; errorInstanceId: string; parameters: { streamType: unknown; }; } /** * Describes specific reasons why a connection configuration is invalid. * * Log Safety: SAFE */ declare type InvalidTableReason = "TABLE_NOT_FOUND" | "INVALID_TABLE_NAME" | "SCHEMA_VALIDATION_FAILED" | "TABLE_ACCESS_DENIED"; /** * Tabular input has incorrect JSON structure. * * Log Safety: UNSAFE */ declare interface InvalidTabularFormatError { inputFieldName: string; } /** * The TimeCheckConfig is invalid. It must contain at least one of timeBounds or medianDeviation. * * Log Safety: SAFE */ declare interface InvalidTimeCheckConfig { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidTimeCheckConfig"; errorDescription: "The TimeCheckConfig is invalid. It must contain at least one of timeBounds or medianDeviation."; errorInstanceId: string; parameters: {}; } /** * The schedule trigger cron expression is invalid. * * Log Safety: SAFE */ declare interface InvalidTimeTrigger { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidTimeTrigger"; errorDescription: "The schedule trigger cron expression is invalid."; errorInstanceId: string; parameters: { cronExpression: unknown; }; } /** * The time zone is invalid. * * Log Safety: SAFE */ declare interface InvalidTimeZone { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidTimeZone"; errorDescription: "The time zone is invalid."; errorInstanceId: string; parameters: { timeZone: unknown; }; } /** * The provided timezone is not valid. * * Log Safety: SAFE */ declare interface InvalidTimezone { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidTimezone"; errorDescription: "The provided timezone is not valid."; errorInstanceId: string; parameters: { userTimezone: unknown; }; } /** * The value of the given property is invalid. See the documentation of DataValue for details on how properties are represented for transaction edits. * * Log Safety: UNSAFE */ declare interface InvalidTransactionEditPropertyValue { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidTransactionEditPropertyValue"; errorDescription: "The value of the given property is invalid. See the documentation of DataValue for details on how properties are represented for transaction edits."; errorInstanceId: string; parameters: { propertyApiName: unknown; propertyBaseType: unknown; propertyValue: unknown; }; } /** * The TransactionTimeCheckConfig is invalid. It must contain at least one of timeBounds or medianDeviation. * * Log Safety: SAFE */ declare interface InvalidTransactionTimeCheckConfig { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidTransactionTimeCheckConfig"; errorDescription: "The TransactionTimeCheckConfig is invalid. It must contain at least one of timeBounds or medianDeviation."; errorInstanceId: string; parameters: {}; } /** * The given transaction type is not valid. Valid transaction types are SNAPSHOT, UPDATE, APPEND, and DELETE. * * Log Safety: SAFE */ declare interface InvalidTransactionType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidTransactionType"; errorDescription: "The given transaction type is not valid. Valid transaction types are SNAPSHOT, UPDATE, APPEND, and DELETE."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; transactionType: unknown; }; } /** * The TrendConfig is invalid. It must contain at least one of trendType or differenceBounds. * * Log Safety: SAFE */ declare interface InvalidTrendConfig { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidTrendConfig"; errorDescription: "The TrendConfig is invalid. It must contain at least one of trendType or differenceBounds."; errorInstanceId: string; parameters: {}; } /** * The provided value for a user id must be a UUID. * * Log Safety: UNSAFE */ declare interface InvalidUserId { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidUserId"; errorDescription: "The provided value for a user id must be a UUID."; errorInstanceId: string; parameters: { userId: unknown; }; } /** * A variable referenced in the request to create project from template is not defined on the template. * * Log Safety: UNSAFE */ declare interface InvalidVariable { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidVariable"; errorDescription: "A variable referenced in the request to create project from template is not defined on the template."; errorInstanceId: string; parameters: { templateVariableId: unknown; }; } /** * The value passed in the request to create project from template for an enum type variable is not a valid option. * * Log Safety: UNSAFE */ declare interface InvalidVariableEnumOption { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidVariableEnumOption"; errorDescription: "The value passed in the request to create project from template for an enum type variable is not a valid option."; errorInstanceId: string; parameters: { variableId: unknown; invalidOption: unknown; validOptions: unknown; }; } /** * The dimensions of the provided vector don't match the dimensions of the embedding model being queried. * * Log Safety: SAFE */ declare interface InvalidVectorDimension { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidVectorDimension"; errorDescription: "The dimensions of the provided vector don't match the dimensions of the embedding model being queried."; errorInstanceId: string; parameters: { expectedSize: unknown; providedSize: unknown; }; } /** * The given website version is invalid. Versions must follow semantic versioning with major, minor, and patch versions separate by periods, e.g. 0.1.0 or 1.2.3. * * Log Safety: UNSAFE */ declare interface InvalidVersion { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidVersion"; errorDescription: "The given website version is invalid. Versions must follow semantic versioning with major, minor, and patch versions separate by periods, e.g. 0.1.0 or 1.2.3."; errorInstanceId: string; parameters: { version: unknown; }; } /** * The given version is invalid. Versions must follow semantic versioning with major, minor, and patch versions separate by periods, e.g. 0.1.0 or 1.2.3. * * Log Safety: UNSAFE */ declare interface InvalidVersion_2 { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidVersion"; errorDescription: "The given version is invalid. Versions must follow semantic versioning with major, minor, and patch versions separate by periods, e.g. 0.1.0 or 1.2.3."; errorInstanceId: string; parameters: { version: unknown; }; } /** * The combination of version, latestVersionResolution, and includePrerelease provided is not supported. * * Log Safety: SAFE */ declare interface InvalidVersionResolutionParameters { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidVersionResolutionParameters"; errorDescription: "The combination of version, latestVersionResolution, and includePrerelease provided is not supported."; errorInstanceId: string; parameters: { message: unknown; }; } /** * Either you do not have access to one or more of the backing datasets or it does not exist. * * Log Safety: SAFE */ declare interface InvalidViewBackingDataset { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidViewBackingDataset"; errorDescription: "Either you do not have access to one or more of the backing datasets or it does not exist."; errorInstanceId: string; parameters: {}; } /** * The type of each referenced column in the primary key must be one of the following: BYTE, SHORT, DECIMAL, INTEGER, LONG, STRING, BOOLEAN, TIMESTAMP or DATE. * * Log Safety: UNSAFE */ declare interface InvalidViewPrimaryKeyColumnType { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidViewPrimaryKeyColumnType"; errorDescription: "The type of each referenced column in the primary key must be one of the following: BYTE, SHORT, DECIMAL, INTEGER, LONG, STRING, BOOLEAN, TIMESTAMP or DATE."; errorInstanceId: string; parameters: { primaryKeyColumns: unknown; invalidColumns: unknown; }; } /** * The deletion column must be a boolean. * * Log Safety: UNSAFE */ declare interface InvalidViewPrimaryKeyDeletionColumn { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidViewPrimaryKeyDeletionColumn"; errorDescription: "The deletion column must be a boolean."; errorInstanceId: string; parameters: { deletionColumn: unknown; deletionColumnType: unknown; }; } /** * The specified connection is invalid or inaccessible. * * Log Safety: SAFE */ declare interface InvalidVirtualTableConnection { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidVirtualTableConnection"; errorDescription: "The specified connection is invalid or inaccessible."; errorInstanceId: string; parameters: { connection: unknown; reason: unknown; }; } /** * The widget description is invalid. * * Log Safety: UNSAFE */ declare interface InvalidWidgetDescription { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidWidgetDescription"; errorDescription: "The widget description is invalid."; errorInstanceId: string; parameters: { reason: unknown; widgetDescription: unknown; }; } /** * The widget id is invalid. * * Log Safety: UNSAFE */ declare interface InvalidWidgetId { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidWidgetId"; errorDescription: "The widget id is invalid."; errorInstanceId: string; parameters: { reason: unknown; widgetId: unknown; }; } /** * The widget name is invalid. * * Log Safety: UNSAFE */ declare interface InvalidWidgetName { errorCode: "INVALID_ARGUMENT"; errorName: "InvalidWidgetName"; errorDescription: "The widget name is invalid."; errorInstanceId: string; parameters: { reason: unknown; widgetName: unknown; }; } /** * A worker config input was provided with a type that does not match the expected type. * * Log Safety: UNSAFE */ declare interface InvalidWorkerConfigInputTypeError { inputAlias: InputAlias; expectedType: string; actualType: string; } /** * Log Safety: SAFE */ declare type IrVersion = "v1" | "v2"; /** * Boolean flag to indicate if the marking is directly applied to the resource, or if it's applied to a parent resource and inherited by the current resource. * * Log Safety: SAFE */ declare type IsDirectlyApplied = boolean; /** * Returns objects based on the existence of the specified field. * * Log Safety: UNSAFE */ declare interface IsNullQuery { field: FieldNameV1; value: boolean; } /** * @deprecated Use `IsNullQueryV2` in the `foundry.ontologies` package * * Returns objects based on the existence of the specified field. * * Log Safety: UNSAFE */ declare interface IsNullQueryV2 { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: boolean; } /** * Returns objects based on the existence of the specified field. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface IsNullQueryV2_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: boolean; } /** * The configuration needed to connect to an external system using the JDBC protocol. * * Log Safety: DO_NOT_LOG */ declare interface JdbcConnectionConfiguration { url: string; driverClass: string; uploadedJdbcDrivers: Array; jdbcProperties: JdbcProperties; credentials?: BasicCredentials; } /** * The name of the uploaded JDBC artifact. * * Log Safety: UNSAFE */ declare type JdbcDriverArtifactName = LooselyBrandedString_12<"JdbcDriverArtifactName">; /** * A map of properties passed to the JDBC driver to configure behavior. Refer to the documentation of your specific connection type for additional available JDBC properties to add to your connection configuration. This should only contain unencrypted properties, all values specified here are sent unencrypted to Foundry. * * Log Safety: UNSAFE */ declare type JdbcProperties = Record; /** * The import configuration for a custom JDBC connection. * * Log Safety: UNSAFE */ declare interface JdbcTableImportConfig { query: TableImportQuery; initialIncrementalState?: TableImportInitialIncrementalState; } /** * Log Safety: SAFE */ declare interface Job { rid: _Core.JobRid; buildRid: _Core.BuildRid; startedTime: JobStartedTime; latestAttemptStartTime?: string; finishedTime?: string; jobStatus: JobStatus; outputs: Array; } /* Excluded from this release type: job */ /** * Log Safety: SAFE */ declare interface JobDetails { jobRid: _Core.JobRid; } /** * Checks the total time a job takes to complete. * * Log Safety: UNSAFE */ declare interface JobDurationCheckConfig { subject: DatasetSubject; timeCheckConfig: TimeCheckConfig; } /** * The given Job could not be found. * * Log Safety: SAFE */ declare interface JobNotFound { errorCode: "NOT_FOUND"; errorName: "JobNotFound"; errorDescription: "The given Job could not be found."; errorInstanceId: string; parameters: { jobRid: unknown; }; } /** * Other types of Job Outputs exist in Foundry. Currently, only Dataset and Media Set are supported by the API. * * Log Safety: SAFE */ declare type JobOutput = ({ type: "datasetJobOutput"; } & DatasetJobOutput) | ({ type: "transactionalMediaSetJobOutput"; } & TransactionalMediaSetJobOutput); /** * The RID of a Job. * * Log Safety: SAFE */ declare type JobRid = LooselyBrandedString<"JobRid">; export declare namespace Jobs { export { } } /* Excluded from this release type: jobs */ /** * Get the Jobs in the Build. * * @public * * Required Scopes: [api:orchestration-read] * URL: /v2/orchestration/builds/{buildRid}/jobs */ declare function jobs_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ buildRid: _Core.BuildRid, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Orchestration_2.ListJobsOfBuildResponse>; /** * The time this job started waiting for the dependencies to be resolved. * * Log Safety: SAFE */ declare type JobStartedTime = string; /** * The status of the job. * * Log Safety: SAFE */ declare type JobStatus = "WAITING" | "RUNNING" | "SUCCEEDED" | "FAILED" | "CANCELED" | "DID_NOT_RUN"; /** * Checks the status of the most recent job run on the dataset. * * Log Safety: UNSAFE */ declare interface JobStatusCheckConfig { subject: DatasetSubject; statusCheckConfig: StatusCheckConfig; } /** * Trigger whenever a job succeeds on the dataset and on the target branch. * * Log Safety: UNSAFE */ declare interface JobSucceededTrigger { datasetRid: _Core.DatasetRid; branchName: _Core.BranchName; } /** * Could not job the Transaction. * * Log Safety: SAFE */ declare interface JobTransactionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "JobTransactionPermissionDenied"; errorDescription: "Could not job the Transaction."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; }; } /** * JPEG image format. * * Log Safety: SAFE */ declare interface JpgFormat { } /* Excluded from this release type: json */ /* Excluded from this release type: json_2 */ /** * Could not json the ExperimentArtifactTable. * * Log Safety: UNSAFE */ declare interface JsonExperimentArtifactTablePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "JsonExperimentArtifactTablePermissionDenied"; errorDescription: "Could not json the ExperimentArtifactTable."; errorInstanceId: string; parameters: { experimentRid: unknown; experimentArtifactTableName: unknown; modelRid: unknown; }; } /** * Could not json the ExperimentSeries. * * Log Safety: UNSAFE */ declare interface JsonExperimentSeriesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "JsonExperimentSeriesPermissionDenied"; errorDescription: "Could not json the ExperimentSeries."; errorInstanceId: string; parameters: { experimentSeriesName: unknown; experimentRid: unknown; modelRid: unknown; }; } /** * Log Safety: UNSAFE */ declare type JsonSchema = Record; /** * The custom configuration failed JSON schema validation. * * Log Safety: UNSAFE */ declare interface JsonSchemaValidationError { field: string; message: string; } /** * Justification submitted by the user to pass a checkpoint. * * Log Safety: UNSAFE */ declare type Justification = ({ type: "responseJustification"; } & ResponseJustification) | ({ type: "dropdownJustification"; } & DropdownJustification) | ({ type: "reauthenticationJustification"; } & ReauthenticationJustification) | ({ type: "acknowledgementJustification"; } & AcknowledgementJustification); /** * Determines how free-text justification input should be matched. * * Log Safety: SAFE */ declare type JustificationMatchType = "EXACT" | "CONTAINS"; /** * Known Foundry types for specialized formatting: userOrGroupRid: Format as user or group resourceRid: Format as resource artifactGid: Format as artifact * * Log Safety: SAFE */ declare type KnownType = "USER_OR_GROUP_ID" | "RESOURCE_RID" | "ARTIFACT_GID"; /** * The name of the LanguageModel in the API. * * Log Safety: SAFE */ declare type LanguageModelApiName = LooselyBrandedString_13<"LanguageModelApiName">; /** * An error was thrown by the underlying model provider during inference. * * Log Safety: UNSAFE */ declare interface LanguageModelInferenceError { errorCode: "INVALID_ARGUMENT"; errorName: "LanguageModelInferenceError"; errorDescription: "An error was thrown by the underlying model provider during inference."; errorInstanceId: string; parameters: { code: unknown; message: unknown; }; } /** * Locator for identifying a language model. * * Log Safety: UNSAFE */ declare type LanguageModelLocator = { type: "apiName"; } & ApiNameLocatorWrapper; /** * The language model requested is not available in this environment. * * Log Safety: SAFE */ declare interface LanguageModelNotAvailable { errorCode: "INVALID_ARGUMENT"; errorName: "LanguageModelNotAvailable"; errorDescription: "The language model requested is not available in this environment."; errorInstanceId: string; parameters: {}; } /** * No known language model exists with the specified ID. * * Log Safety: UNSAFE */ declare interface LanguageModelNotFound { errorCode: "NOT_FOUND"; errorName: "LanguageModelNotFound"; errorDescription: "No known language model exists with the specified ID."; errorInstanceId: string; parameters: { modelId: unknown; }; } /** * The token provided does not have permission to use this language model. * * Log Safety: SAFE */ declare interface LanguageModelPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "LanguageModelPermissionDenied"; errorDescription: "The token provided does not have permission to use this language model."; errorInstanceId: string; parameters: { languageModelRid: unknown; }; } /** * The unique Resource Identifier (RID) of a language model. * * Log Safety: SAFE */ declare type LanguageModelRid = LooselyBrandedString_13<"LanguageModelRid">; export declare namespace LanguageModels { export { AnthropicAnyToolChoice, AnthropicAutoToolChoice, AnthropicBase64PdfDocumentSource, AnthropicCacheControl, AnthropicCharacterLocationCitation, AnthropicCompletionCitation, AnthropicCompletionContent, AnthropicCompletionRedactedThinking, AnthropicCompletionText, AnthropicCompletionThinking, AnthropicCompletionToolUse, AnthropicCustomTool, AnthropicDisabledThinking, AnthropicDisableParallelToolUse, AnthropicDocument, AnthropicDocumentCitations, AnthropicDocumentSource, AnthropicEffort, AnthropicEnabledThinking, AnthropicEphemeralCacheControl, AnthropicImage, AnthropicImageBase64Source, AnthropicImageSource, AnthropicJsonSchemaOutputFormat, AnthropicMediaType, AnthropicMessage, AnthropicMessageContent, AnthropicMessageRole, AnthropicMessagesRequest, AnthropicMessagesResponse, AnthropicModel, AnthropicNoneToolChoice, AnthropicOutputConfig, AnthropicOutputFormat, AnthropicRedactedThinking, AnthropicSystemMessage, AnthropicText, AnthropicTextDocumentSource, AnthropicThinking, AnthropicThinkingConfig, AnthropicTokenUsage, AnthropicTool, AnthropicToolChoice, AnthropicToolResult, AnthropicToolResultContent, AnthropicToolToolChoice, AnthropicToolUse, AnthropicUrlDocumentSource, JsonSchema, LanguageModelApiName, LanguageModelRid, OpenAiEmbeddingInput, OpenAiEmbeddingsRequest, OpenAiEmbeddingsResponse, OpenAiEmbeddingTokenUsage, OpenAiEncodingFormat, OpenAiModel, AnthropicMessagesPermissionDenied, InvalidRequest, LanguageModelInferenceError, LanguageModelNotAvailable, LanguageModelNotFound, LanguageModelPermissionDenied, MultipleSystemPromptsNotSupported, MultipleToolResultContentsNotSupported, OpenAiEmbeddingsPermissionDenied, Anthropic, OpenAi } } declare namespace _LanguageModels { export { LooselyBrandedString_13 as LooselyBrandedString, AnthropicAnyToolChoice, AnthropicAutoToolChoice, AnthropicBase64PdfDocumentSource, AnthropicCacheControl, AnthropicCharacterLocationCitation, AnthropicCompletionCitation, AnthropicCompletionContent, AnthropicCompletionRedactedThinking, AnthropicCompletionText, AnthropicCompletionThinking, AnthropicCompletionToolUse, AnthropicCustomTool, AnthropicDisabledThinking, AnthropicDisableParallelToolUse, AnthropicDocument, AnthropicDocumentCitations, AnthropicDocumentSource, AnthropicEffort, AnthropicEnabledThinking, AnthropicEphemeralCacheControl, AnthropicImage, AnthropicImageBase64Source, AnthropicImageSource, AnthropicJsonSchemaOutputFormat, AnthropicMediaType, AnthropicMessage, AnthropicMessageContent, AnthropicMessageRole, AnthropicMessagesRequest, AnthropicMessagesResponse, AnthropicModel, AnthropicNoneToolChoice, AnthropicOutputConfig, AnthropicOutputFormat, AnthropicRedactedThinking, AnthropicSystemMessage, AnthropicText, AnthropicTextDocumentSource, AnthropicThinking, AnthropicThinkingConfig, AnthropicTokenUsage, AnthropicTool, AnthropicToolChoice, AnthropicToolResult, AnthropicToolResultContent, AnthropicToolToolChoice, AnthropicToolUse, AnthropicUrlDocumentSource, JsonSchema, LanguageModelApiName, LanguageModelRid, OpenAiEmbeddingInput, OpenAiEmbeddingsRequest, OpenAiEmbeddingsResponse, OpenAiEmbeddingTokenUsage, OpenAiEncodingFormat, OpenAiModel } } /* Excluded from this release type: latest */ /** * Could not latest the ModelStudioConfigVersion. * * Log Safety: SAFE */ declare interface LatestModelStudioConfigVersionsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "LatestModelStudioConfigVersionsPermissionDenied"; errorDescription: "Could not latest the ModelStudioConfigVersion."; errorInstanceId: string; parameters: { modelStudioRid: unknown; }; } /** * Start reading from the current end of the stream. Sets offsets to the latest available offset for each partition, meaning the subscriber will only receive records published after this point. * * Log Safety: SAFE */ declare interface LatestPosition { } /** * Controls how latest version is resolved when version is omitted. Defaults to SEMANTIC_VERSION. * * Log Safety: SAFE */ declare type LatestVersionResolution = "PUBLISH_TIME" | "SEMANTIC_VERSION"; /* Excluded from this release type: launch */ /** * Permission denied to launch a Model Studio run. * * Log Safety: SAFE */ declare interface LaunchModelStudioPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "LaunchModelStudioPermissionDenied"; errorDescription: "Permission denied to launch a Model Studio run."; errorInstanceId: string; parameters: { studioRid: unknown; }; } /** * Parameters for layout-aware content extraction. * * Log Safety: SAFE */ declare interface LayoutAwareExtractionParameters { languages: Array; } /** * Configuration for layout-aware extraction preprocessing. * * Log Safety: UNSAFE */ declare interface LayoutAwareExtractionPreprocessingConfig { transformationConfig: ExtractDocumentLayoutAwareTextV2Config; cropConfig?: CropConfig; } /** * Wrapper for layout-aware preprocessing. * * Log Safety: UNSAFE */ declare interface LayoutAwarePreprocessingWrapper { layoutAware: LayoutAwareExtractionPreprocessingConfig; } /** * Finds least of two or more numeric, date or timestamp values. * * Log Safety: UNSAFE */ declare interface LeastPropertyExpression { properties: Array; } /** * The unique ID of an object type. This is a legacy identifier and is not recommended for use in new applications. To find the ID for your Object Type, check the Ontology Manager. * * Log Safety: UNSAFE */ declare type LegacyObjectTypeId = LooselyBrandedString_5<"LegacyObjectTypeId">; /** * The unique ID of a property. This is a legacy identifier and is not recommended for use in new applications. To find the ID for your property, check the Ontology Manager. * * Log Safety: UNSAFE */ declare type LegacyPropertyId = LooselyBrandedString_5<"LegacyPropertyId">; /** * Log Safety: SAFE */ declare interface LengthConstraint { minimumLength?: number; maximumLength?: number; } /** * Log Safety: SAFE */ declare interface LengthConstraint_2 { minimumLength?: number; maximumLength?: number; } /** * A linear ring is a closed LineString with four or more positions. The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical. A linear ring is the boundary of a surface or the boundary of a hole in a surface. A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise. * * Log Safety: UNSAFE */ declare type LinearRing = Array; /** * Log Safety: UNSAFE */ declare interface LineString { coordinates?: LineStringCoordinates; bbox?: BBox; } /** * GeoJSon fundamental geometry construct, array of two or more positions. * * Log Safety: UNSAFE */ declare type LineStringCoordinates = Array; /** * The link the user is attempting to create already exists. * * Log Safety: SAFE */ declare interface LinkAlreadyExists { errorCode: "CONFLICT"; errorName: "LinkAlreadyExists"; errorDescription: "The link the user is attempting to create already exists."; errorInstanceId: string; parameters: {}; } /** * A reference to the linked interface type. * * Log Safety: UNSAFE */ declare interface LinkedInterfaceTypeApiName { apiName: InterfaceTypeApiName; } /** * Does not contain information about the source object. Should be used in a nested type that provides information about source objects. The targetObject Ontology Object in this response will only ever have the __primaryKey and __apiName fields present, thus functioning as object locators rather than full objects. * * Log Safety: UNSAFE */ declare interface LinkedObjectLocator { targetObject?: OntologyObjectV2; linkType?: LinkTypeApiName_2; } /** * The linked object with the given primary key is not found, or the user does not have access to it. * * Log Safety: UNSAFE */ declare interface LinkedObjectNotFound { errorCode: "NOT_FOUND"; errorName: "LinkedObjectNotFound"; errorDescription: "The linked object with the given primary key is not found, or the user does not have access to it."; errorInstanceId: string; parameters: { linkType: unknown; linkedObjectType: unknown; linkedObjectPrimaryKey: unknown; }; } export declare namespace LinkedObjectsV2 { export { listLinkedObjects, getLinkedObject } } /** * A reference to the linked object type. * * Log Safety: UNSAFE */ declare interface LinkedObjectTypeApiName { apiName: ObjectTypeApiName; } /** * Log Safety: UNSAFE */ declare type LinkedObjectV2 = LooselyBrandedString_5<"LinkedObjectV2">; /** * The Ontology Objects in this response will only ever have the __primaryKey and __apiName fields present, thus functioning as object locators rather than full objects. * * Log Safety: UNSAFE */ declare interface LinksFromObject { sourceObject?: OntologyObjectV2; linkedObjects: Array; } /** * Log Safety: UNSAFE */ declare interface LinkSideObject { primaryKey: PropertyValue_2; objectType: ObjectTypeApiName; } /** * Messages sent over the link type subscription WebSocket. * * Log Safety: UNSAFE */ declare type LinksMessage = ({ type: "subscriptionClosed"; } & SubscriptionClosed) | ({ type: "subscribeResponses"; } & ObjectSetSubscribeResponses) | ({ type: "refresh"; } & RefreshLinks) | ({ type: "updates"; } & LinkUpdates); /** * Represents the state of a link change. ADDED indicates the link was created. REMOVED indicates the link was deleted. Updates are represented as a REMOVED followed by an ADDED LinkState in a single LinkUpdates message. * * Log Safety: SAFE */ declare type LinkState = "ADDED" | "REMOVED"; /** * Identifies an object by its object type and primary key. Used in link subscription requests and responses to identify objects on either side of a link. * * Log Safety: UNSAFE */ declare interface LinkSubscriptionObjectLocator { objectType: ObjectTypeApiName; primaryKey: ObjectPrimaryKey; } /** * A list of object locators to report link changes on. * * Log Safety: UNSAFE */ declare type LinkSubscriptionObjectLocators = Array; /** * @deprecated Use `LinkTypeApiName` in the `foundry.ontologies` package * * The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager. * * Log Safety: UNSAFE */ declare type LinkTypeApiName = LooselyBrandedString<"LinkTypeApiName">; /** * The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager application. * * Log Safety: UNSAFE */ declare type LinkTypeApiName_2 = LooselyBrandedString_5<"LinkTypeApiName">; /** * A list of directed link type API names. * * Log Safety: UNSAFE */ declare type LinkTypeApiNames = Array; /** * The unique ID of a link type. To find the ID for your link type, check the Ontology Manager application. * * Log Safety: UNSAFE */ declare type LinkTypeId = LooselyBrandedString_5<"LinkTypeId">; /** * The link type is not found, or the user does not have access to it. * * Log Safety: UNSAFE */ declare interface LinkTypeNotFound { errorCode: "NOT_FOUND"; errorName: "LinkTypeNotFound"; errorDescription: "The link type is not found, or the user does not have access to it."; errorInstanceId: string; parameters: { objectType: unknown; linkType: unknown; linkTypeId: unknown; }; } /** * Log Safety: SAFE */ declare type LinkTypeRid = LooselyBrandedString_5<"LinkTypeRid">; /** * Log Safety: UNSAFE */ declare interface LinkTypeSide { apiName: LinkTypeApiName_2; displayName: _Core.DisplayName; status: _Core.ReleaseStatus; objectTypeApiName: ObjectTypeApiName; cardinality: LinkTypeSideCardinality; foreignKeyPropertyApiName?: PropertyApiName_2; } /** * Log Safety: SAFE */ declare type LinkTypeSideCardinality = "ONE" | "MANY"; /** * foreignKeyPropertyApiName is the API name of the foreign key on this object type. If absent, the link is either a m2m link or the linked object has the foreign key and this object type has the primary key. * * Log Safety: UNSAFE */ declare interface LinkTypeSideV2 { apiName: LinkTypeApiName_2; displayName: _Core.DisplayName; status: _Core.ReleaseStatus; objectTypeApiName: ObjectTypeApiName; cardinality: LinkTypeSideCardinality; foreignKeyPropertyApiName?: PropertyApiName_2; linkTypeRid: LinkTypeRid; } /** * A request to subscribe to link changes from a selected side of a set of objects over a set of link types. * * Log Safety: UNSAFE */ declare interface LinkTypeSubscribeRequest { selectedObjects: LinkSubscriptionObjectLocators; linkTypes: LinkTypeApiNames; } /** * The list of link subscriptions that should be established. A client can stop subscribing to links by removing the request from subsequent LinkTypeSubscribeRequests. * * Log Safety: UNSAFE */ declare interface LinkTypeSubscribeRequests { id: RequestId; requests: Array; } /** * Represents a single link change between two objects. * * Log Safety: UNSAFE */ declare interface LinkUpdate { selectedSide: LinkSubscriptionObjectLocator; linkType: LinkTypeApiName_2; linkedSide: LinkSubscriptionObjectLocator; state: LinkState; } /** * A message containing link updates for a subscription. * * Log Safety: UNSAFE */ declare interface LinkUpdates { id: SubscriptionId; updates: Array; } /* Excluded from this release type: list */ /** * List all principals who are assigned a role for the given Marking. Ignores the `pageSize` parameter. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/markings/{markingId}/roleAssignments */ declare function list_10($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ markingId: _Core.MarkingId, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Admin.ListMarkingRoleAssignmentsResponse>; /* Excluded from this release type: list_11 */ /** * List all principals who are assigned a role for the given Organization. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/organizations/{organizationRid}/roleAssignments */ declare function list_12($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [organizationRid: _Core.OrganizationRid]): Promise<_Admin.ListOrganizationRoleAssignmentsResponse>; /** * Lists all Users. * * This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/users */ declare function list_13($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ $queryParams?: { include?: _Core.UserStatus | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Admin.ListUsersResponse>; /** * List all references in the given project * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/projects/{projectRid}/references */ declare function list_14($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ projectRid: _Filesystem_2.ProjectRid, $queryParams?: { referenceType?: _Filesystem_2.ProjectResourceReferenceType | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Filesystem_2.ListProjectResourceReferencesResponse>; /** * List the roles on a resource. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/resources/{resourceRid}/roles */ declare function list_15($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ resourceRid: _Filesystem_2.ResourceRid, $queryParams?: { includeInherited?: boolean | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Filesystem_2.ListResourceRolesResponse>; /* Excluded from this release type: list_16 */ /** * Lists all Spaces. * * This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. * * @public * * Required Scopes: [api:filesystem-read] * URL: /v2/filesystem/spaces */ declare function list_17($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Filesystem_2.ListSpacesResponse>; /** * Lists the Branches of a Dataset. * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/{datasetRid}/branches */ declare function list_18($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Datasets_2.ListBranchesResponse>; /** * Lists Files contained in a Dataset. By default files are listed on the latest view of the default * branch - `master` for most enrollments. * * #### Advanced Usage * * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. * To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most * recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the * branch if there are no snapshot transactions. * To **list files on the resolved view of a transaction** specify the Transaction's resource identifier * as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot * transaction, or the earliest ancestor transaction if there are no snapshot transactions. * To **list files on the resolved view of a range of transactions** specify the the start transaction's resource * identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This * will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. * Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when * the start and end transactions do not belong to the same root-to-leaf path. * To **list files on a specific transaction** specify the Transaction's resource identifier as both the * `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that * Transaction. * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/{datasetRid}/files */ declare function list_19($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, $queryParams?: { branchName?: _Core.BranchName | undefined; pathPrefix?: _Core.FilePath | undefined; startTransactionRid?: _Datasets_2.TransactionRid | undefined; endTransactionRid?: _Datasets_2.TransactionRid | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Datasets_2.ListFilesResponse>; /* Excluded from this release type: list_2 */ /* Excluded from this release type: list_20 */ /** * Lists the action types for the given Ontology. * * 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. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/actionTypes */ declare function list_21($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, $queryParams?: { branch?: _Core.FoundryBranch | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Ontologies_2.ListActionTypesResponseV2>; /** * Lists the object types for the given Ontology. * * Each page may be smaller or larger 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. * * Note: the `aliases` field is not populated on this endpoint and will always be empty. To retrieve object type * aliases, use the get-by-RID read paths (e.g. `getObjectTypeV2`). * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectTypes */ declare function list_22($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, $queryParams?: { branch?: _Core.FoundryBranch | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; includeDatasources?: boolean | undefined; } ]): Promise<_Ontologies_2.ListObjectTypesV2Response>; /* Excluded from this release type: list_23 */ /** * Lists the objects for the given Ontology and object type. * * Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or * repeated objects in the response pages. * * 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. * * Each page may be smaller or larger 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. * * Note that null value properties will not be returned. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType} */ declare function list_24($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, $queryParams: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; select: Array<_Ontologies_2.SelectedPropertyApiName>; orderBy?: _Ontologies_2.OrderBy | undefined; sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; excludeRid?: boolean | undefined; snapshot?: boolean | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.ListObjectsResponseV2>; /** * Lists the Ontologies visible to the current user. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies */ declare function list_25($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: []): Promise<_Ontologies_2.ListOntologiesV2Response>; /* Excluded from this release type: list_26 */ /** * Lists the query types for the given Ontology. * * Each query type is returned at its latest version. The latest version is the one that was most recently * published, which may be a pre-release version. * * 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. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/queryTypes */ declare function list_27($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, $queryParams?: { branch?: _Core.FoundryBranch | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Ontologies_2.ListQueryTypesResponseV2>; /* Excluded from this release type: list_28 */ /* Excluded from this release type: list_29 */ /** * Lists all Groups. * * This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/groups */ declare function list_3($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Admin.ListGroupsResponse>; /** * Lists all LogFiles. * * This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. * * @public * * Required Scopes: [api:audit-read] * URL: /v2/audit/organizations/{organizationRid}/logFiles */ declare function list_30($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ organizationRid: _Core.OrganizationRid, $queryParams?: { startDate?: string | undefined; endDate?: string | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Audit.ListLogFilesResponse>; /** * Lists all file imports defined for this connection. * Only file imports that the user has permissions to view will be returned. * * @public * * Required Scopes: [api:connectivity-file-import-read] * URL: /v2/connectivity/connections/{connectionRid}/fileImports */ declare function list_31($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Connectivity.ListFileImportsResponse>; /** * Lists all table imports defined for this connection. * Only table imports that the user has permissions to view will be returned. * * @public * * Required Scopes: [api:connectivity-table-import-read] * URL: /v2/connectivity/connections/{connectionRid}/tableImports */ declare function list_32($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Connectivity.ListTableImportsResponse>; /* Excluded from this release type: list_33 */ /* Excluded from this release type: list_34 */ /* Excluded from this release type: list_35 */ /* Excluded from this release type: list_36 */ /* Excluded from this release type: list_37 */ /** * Lists all Versions. * * This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. * * @public * * Required Scopes: [third-party-application:deploy-application-website] * URL: /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions */ declare function list_38($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ thirdPartyApplicationRid: _ThirdPartyApplications.ThirdPartyApplicationRid, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_ThirdPartyApplications.ListVersionsResponse>; /* Excluded from this release type: list_39 */ /** * Lists all members (which can be a User or a Group) of a given Group. * * This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, * it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. * To get the next page, make the same request again, but set the value of the `pageToken` query parameter * to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field * in the response, you are on the last page. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/groups/{groupId}/groupMembers */ declare function list_4($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ groupId: _Core.GroupId, $queryParams?: { transitive?: boolean | undefined; includeExpirations?: boolean | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Admin.ListGroupMembersResponse>; /** * Lists all Groups a given User is a member of. * * This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, * it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. * To get the next page, make the same request again, but set the value of the `pageToken` query parameter * to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field * in the response, you are on the last page. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/users/{userId}/groupMemberships */ declare function list_5($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ userId: _Core.UserId, $queryParams?: { transitive?: boolean | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Admin.ListGroupMembershipsResponse>; /* Excluded from this release type: list_6 */ /** * Maximum page size 100. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/markings */ declare function list_7($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Admin.ListMarkingsResponse>; /** * Maximum page size 100. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/markingCategories */ declare function list_8($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Admin.ListMarkingCategoriesResponse>; /** * Lists all principals who can view resources protected by the given Marking. Ignores the `pageSize` parameter. * Requires `api:admin-write` because only marking administrators can view marking members. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/markings/{markingId}/markingMembers */ declare function list_9($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ markingId: _Core.MarkingId, $queryParams?: { transitive?: boolean | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Admin.ListMarkingMembersResponse>; /** * Log Safety: UNSAFE */ declare interface ListActionTypesFullMetadataResponse { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListActionTypesResponse { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListActionTypesResponseV2 { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListAgentVersionsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListAttachmentsResponseV2 { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListAuthenticationProvidersResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface ListAvailableOrganizationRolesResponse { data: Array<_Core.Role>; } /** * List all roles that can be assigned to a principal for the given Organization. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/organizations/{organizationRid}/listAvailableRoles */ declare function listAvailableRoles($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [organizationRid: _Core.OrganizationRid]): Promise<_Admin.ListAvailableOrganizationRolesResponse>; /** * Could not listAvailableRoles the Organization. * * Log Safety: SAFE */ declare interface ListAvailableRolesOrganizationPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListAvailableRolesOrganizationPermissionDenied"; errorDescription: "Could not listAvailableRoles the Organization."; errorInstanceId: string; parameters: { organizationRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ListBranchesResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListChildrenOfFolderResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListColumnType { elementType: ColumnType; } /* Excluded from this release type: listCurrent */ /** * Could not listCurrent the Group. * * Log Safety: SAFE */ declare interface ListCurrentGroupsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListCurrentGroupsPermissionDenied"; errorDescription: "Could not listCurrent the Group."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface ListCurrentGroupsResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface ListDeletedUsersResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * The provided token does not have permission to list assigned roles for this enrollment. * * Log Safety: SAFE */ declare interface ListEnrollmentRoleAssignmentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListEnrollmentRoleAssignmentsPermissionDenied"; errorDescription: "The provided token does not have permission to list assigned roles for this enrollment."; errorInstanceId: string; parameters: { enrollmentRid: unknown; }; } /** * Log Safety: SAFE */ declare interface ListEnrollmentRoleAssignmentsResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface ListFileImportsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListFilesResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListGroupMembershipsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * The provided token does not have permission to view the members of the given group. * * Log Safety: SAFE */ declare interface ListGroupMembersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListGroupMembersPermissionDenied"; errorDescription: "The provided token does not have permission to view the members of the given group."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ListGroupMembersResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListGroupsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: SAFE */ declare interface ListHealthChecksResponse { data: Array<_Core.CheckRid>; } /** * You do not have permission to list hosts for this enrollment * * Log Safety: SAFE */ declare interface ListHostsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListHostsPermissionDenied"; errorDescription: "You do not have permission to list hosts for this enrollment"; errorInstanceId: string; parameters: { enrollmentRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ListHostsResponse { data: Array; nextPageToken?: _Core.PageToken; } /* Excluded from this release type: listInterfaceLinkedObjects */ /** * Log Safety: UNSAFE */ declare interface ListInterfaceLinkedObjectsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListInterfaceTypesResponse { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListJobsOfBuildResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Lists the linked objects for a specific object and the given link type. * * Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or * repeated objects in the response pages. * * 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. * * Each page may be smaller or larger 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. * * Note that null value properties will not be returned. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} */ declare function listLinkedObjects($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, linkType: _Ontologies_2.LinkTypeApiName, $queryParams: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; select: Array<_Ontologies_2.SelectedPropertyApiName>; orderBy?: _Ontologies_2.OrderBy | undefined; sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; excludeRid?: boolean | undefined; snapshot?: boolean | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise<_Ontologies_2.ListLinkedObjectsResponseV2>; /** * Log Safety: UNSAFE */ declare interface ListLinkedObjectsResponse { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListLinkedObjectsResponseV2 { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListLiveDeploymentsResponse { data: Array; } /** * The provided token does not have permission to list audit log files. * * Log Safety: SAFE */ declare interface ListLogFilesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListLogFilesPermissionDenied"; errorDescription: "The provided token does not have permission to list audit log files."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface ListLogFilesResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListMarkingCategoriesResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * The provided token does not have permission to list the members of this marking. * * Log Safety: UNSAFE */ declare interface ListMarkingMembersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListMarkingMembersPermissionDenied"; errorDescription: "The provided token does not have permission to list the members of this marking."; errorInstanceId: string; parameters: { markingId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ListMarkingMembersResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * The provided token does not have permission to list assigned roles for this marking. * * Log Safety: UNSAFE */ declare interface ListMarkingRoleAssignmentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListMarkingRoleAssignmentsPermissionDenied"; errorDescription: "The provided token does not have permission to list assigned roles for this marking."; errorInstanceId: string; parameters: { markingId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ListMarkingRoleAssignmentsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListMarkingsOfResourceResponse { data: Array<_Core.MarkingId>; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListMarkingsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListModelStudioConfigVersionsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListModelStudioRunsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListModelStudioTrainersResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface ListModelVersionsResponse { data: Array; nextPageToken?: _Core.PageToken; } /* Excluded from this release type: listObjectsForInterface */ /** * Log Safety: UNSAFE */ declare interface ListObjectsForInterfaceResponse { nextPageToken?: _Core.PageToken; data: Array; totalCount: _Core.TotalCount; } /** * Log Safety: UNSAFE */ declare interface ListObjectsResponse { nextPageToken?: _Core.PageToken; data: Array; totalCount: _Core.TotalCount; } /** * Log Safety: UNSAFE */ declare interface ListObjectsResponseV2 { nextPageToken?: _Core.PageToken; data: Array; totalCount: _Core.TotalCount; } /** * Log Safety: UNSAFE */ declare interface ListObjectTypesResponse { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListObjectTypesV2Response { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListOntologiesResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface ListOntologiesV2Response { data: Array; } /** * Log Safety: UNSAFE */ declare interface ListOntologyValueTypesResponse { data: Array; } /** * The provided token does not have permission to list guest members for this organization. * * Log Safety: SAFE */ declare interface ListOrganizationGuestMembersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListOrganizationGuestMembersPermissionDenied"; errorDescription: "The provided token does not have permission to list guest members for this organization."; errorInstanceId: string; parameters: { organizationRid: unknown; }; } /** * Log Safety: SAFE */ declare interface ListOrganizationGuestMembersResponse { data: Array; } /** * The provided token does not have permission to list assigned roles for this organization. * * Log Safety: SAFE */ declare interface ListOrganizationRoleAssignmentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListOrganizationRoleAssignmentsPermissionDenied"; errorDescription: "The provided token does not have permission to list assigned roles for this organization."; errorInstanceId: string; parameters: { organizationRid: unknown; }; } /** * Log Safety: SAFE */ declare interface ListOrganizationRoleAssignmentsResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface ListOrganizationsOfProjectResponse { data: Array<_Core.OrganizationRid>; nextPageToken?: _Core.PageToken; } /* Excluded from this release type: listOutgoingInterfaceLinkTypes */ /** * Log Safety: UNSAFE */ declare interface ListOutgoingInterfaceLinkTypesResponse { nextPageToken?: _Core.PageToken; data: Array; } /** * List the outgoing links for an object type. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes */ declare function listOutgoingLinkTypes($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, $queryParams?: { branch?: _Core.FoundryBranch | undefined; pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Ontologies_2.ListOutgoingLinkTypesResponseV2>; /** * Log Safety: UNSAFE */ declare interface ListOutgoingLinkTypesResponse { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListOutgoingLinkTypesResponseV2 { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListProjectResourceReferencesResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListQueryTypesResponse { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListQueryTypesResponseV2 { nextPageToken?: _Core.PageToken; data: Array; } /** * Log Safety: UNSAFE */ declare interface ListReleasesResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListResourceRolesResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListResourceTagsResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface ListRunsOfScheduleResponse { data: Array; nextPageToken?: _Core.PageToken; } /* Excluded from this release type: listScenarioConflictingObjects */ /** * The objects that have a conflicting edit within a scenario for a given object type. * * Log Safety: UNSAFE */ declare interface ListScenarioConflictingObjectsResponse { data: Array; nextPageToken?: _Core.PageToken; } /* Excluded from this release type: listScenarioEditedEntityTypes */ /** * The object types and link types that have been modified within a scenario. * * Log Safety: UNSAFE */ declare interface ListScenarioEditedEntityTypesResponse { objectTypes: Array; linkTypes: Array; } /* Excluded from this release type: listScenarioEditedLinks */ /** * The linked objects that have been edited within a scenario for a given link type, grouped by source object. * * Log Safety: UNSAFE */ declare interface ListScenarioEditedLinksResponse { data: Array; nextPageToken?: _Core.PageToken; } /* Excluded from this release type: listScenarioEditedLinkTypes */ /** * The link types that have been modified within a scenario. * * Log Safety: UNSAFE */ declare interface ListScenarioEditedLinkTypesResponse { data: Array; } /* Excluded from this release type: listScenarioEditedObjects */ /** * The objects that have been edited within a scenario for a given object type. The Ontology Objects in this response will only ever have the __primaryKey and __apiName fields present, thus functioning as object locators rather than full objects. * * Log Safety: UNSAFE */ declare interface ListScenarioEditedObjectsResponse { data: Array; nextPageToken?: _Core.PageToken; } /* Excluded from this release type: listScenarioEditedObjectTypes */ /** * The object types that have been modified within a scenario. * * Log Safety: UNSAFE */ declare interface ListScenarioEditedObjectTypesResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface ListSchedulesResponse { data: Array<_Core.ScheduleRid>; nextPageToken?: _Core.PageToken; } /** * Could not allSessions the Agent. * * Log Safety: SAFE */ declare interface ListSessionsForAgentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ListSessionsForAgentsPermissionDenied"; errorDescription: "Could not allSessions the Agent."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface ListSessionsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListSpacesResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListTableImportsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListTransactionsOfDatasetResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListTransactionsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListUsersResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface ListVersionsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface LiveDeployment { rid: LiveDeploymentRid; modelVersion: LiveDeploymentModelVersion; branch?: _Core.BranchName; runtimeConfiguration: LiveDeploymentRuntimeConfiguration; status: LiveDeploymentStatus; } /** * GPU resource configuration for a live deployment. * * Log Safety: SAFE */ declare interface LiveDeploymentGpu { count: number; type?: GpuType; } /** * Identifies the model and model version associated with a live deployment. * * Log Safety: SAFE */ declare interface LiveDeploymentModelVersion { modelRid: ModelRid; modelVersionRid: ModelVersionRid; } /** * The specified live deployment was not found. * * Log Safety: SAFE */ declare interface LiveDeploymentNotFound { errorCode: "NOT_FOUND"; errorName: "LiveDeploymentNotFound"; errorDescription: "The specified live deployment was not found."; errorInstanceId: string; parameters: { liveDeploymentRid: unknown; }; } /** * The Resource Identifier (RID) of a Live Deployment. * * Log Safety: SAFE */ declare type LiveDeploymentRid = LooselyBrandedString_15<"LiveDeploymentRid">; /** * The compute resource configuration for a live deployment, controlling replica scaling, CPU, memory, and GPU resources. * * Log Safety: UNSAFE */ declare interface LiveDeploymentRuntimeConfiguration { minReplicas: number; maxReplicas: number; cpu?: number; memory?: string; gpu?: LiveDeploymentGpu; threadCount?: number; scalingConfiguration?: LiveDeploymentScalingConfiguration; environmentVariables: Record; } export declare namespace LiveDeployments { export { } } /** * Autoscaling configuration that controls how the deployment scales replicas based on load thresholds and cooldown delays. * * Log Safety: SAFE */ declare interface LiveDeploymentScalingConfiguration { scaleUpLoadThreshold: number; scaleUpDelay: _Core.Duration; scaleDownDelay: _Core.Duration; } /** * The operational state of a live deployment. | Value | Description | | --- | --- | | ACTIVE | The deployment is active. It may have zero replicas due to autoscaling and still not be ready. | | STARTING | The deployment is starting up. | | DEGRADED | At least one replica is ready, but not all replicas are healthy. | | DISABLED | The deployment is disabled. | | FAILED | The deployment has failed. No healthy replicas are available. | * * Log Safety: SAFE */ declare type LiveDeploymentState = "ACTIVE" | "STARTING" | "DEGRADED" | "DISABLED" | "FAILED"; /** * The current operational status of a live deployment. * * Log Safety: SAFE */ declare interface LiveDeploymentStatus { state: LiveDeploymentState; isReady: boolean; } /** * Specification for language model requests. * * Log Safety: UNSAFE */ declare type LlmSpec = { type: "chat"; } & ChatLlmSpecWrapper; /** * A model provided by Language Model Service. * * Log Safety: SAFE */ declare interface LmsEmbeddingModel { value: LmsEmbeddingModelValue; } /** * Log Safety: SAFE */ declare type LmsEmbeddingModelValue = "OPENAI_TEXT_EMBEDDING_ADA_002" | "TEXT_EMBEDDING_3_LARGE" | "TEXT_EMBEDDING_3_SMALL" | "SNOWFLAKE_ARCTIC_EMBED_M" | "INSTRUCTOR_LARGE" | "BGE_BASE_EN_V1_5"; /** * 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 */ declare function load($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, $body: _Ontologies_2.LoadObjectSetRequestV2, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; transactionId?: _Ontologies_2.OntologyTransactionId | undefined; scenarioRid?: _Ontologies_2.OntologyScenarioRid | undefined; executeInMemoryOnly?: boolean | undefined; }, $headerParams?: { traceParent?: _Core.TraceParent | undefined; traceState?: _Core.TraceState | undefined; } ]): Promise<_Ontologies_2.LoadObjectSetResponseV2>; /* Excluded from this release type: loadByName */ /** * Could not loadByName the DocumentType. * * Log Safety: SAFE */ declare interface LoadByNameDocumentTypesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "LoadByNameDocumentTypesPermissionDenied"; errorDescription: "Could not loadByName the DocumentType."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface LoadByNameDocumentTypesRequest { documentTypeName: DocumentTypeName; ontologyRid: string; } /* Excluded from this release type: loadGeotemporalSeriesEntries */ /** * The request body for loading entries from a geotemporal series reference property. A geotemporal series represents time-indexed geographic observations for an object, such as the location history of a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same structure as OntologyObjectV2. The range field is required and restricts results to a specific time window. Both startTime and endTime are required on range. The additionalProperties field controls which additional properties appear in each returned entry. Results are paginated; use pageToken from a previous response to retrieve additional pages. * * Log Safety: UNSAFE */ declare interface LoadGeotemporalSeriesRequest { range: AbsoluteTimeRange; additionalProperties: Array; pageToken?: _Core.PageToken; pageSize?: _Core.PageSize; } /** * The response when loading entries from a geotemporal series reference property. Each entry in data is a map of property names to values containing the fields requested via additionalProperties in the corresponding LoadGeotemporalSeriesRequest. If nextPageToken is present, additional entries are available and can be retrieved by passing the token in a subsequent request. * * Log Safety: UNSAFE */ declare interface LoadGeotemporalSeriesResponse { data: Array; nextPageToken?: _Core.PageToken; } /* Excluded from this release type: loadLinks */ /* Excluded from this release type: loadMetadata */ /* Excluded from this release type: loadMultipleObjectTypes */ /** * Bulk loading object set links is not supported by Object Storage v1. * * Log Safety: SAFE */ declare interface LoadObjectSetLinksNotSupported { errorCode: "FAILED_PRECONDITION"; errorName: "LoadObjectSetLinksNotSupported"; errorDescription: "Bulk loading object set links is not supported by Object Storage v1."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface LoadObjectSetLinksRequestV2 { objectSet: ObjectSet_2; links: Array; pageToken?: _Core.PageToken; includeComputeUsage?: _Core.IncludeComputeUsage; } /** * Log Safety: UNSAFE */ declare interface LoadObjectSetLinksResponseV2 { data: Array; nextPageToken?: _Core.PageToken; computeUsage?: _Core.ComputeSeconds; } /** * Represents the API POST body when loading an ObjectSet. * * Log Safety: UNSAFE */ declare interface LoadObjectSetRequestV2 { objectSet: ObjectSet_2; orderBy?: SearchOrderByV2; select: Array; selectV2: Array; defaultLoadLevel?: PropertyLoadLevel; loadOntologyDefinedDerivedProperties?: boolean; pageToken?: _Core.PageToken; pageSize?: _Core.PageSize; excludeRid?: boolean; loadPropertySecurities?: boolean; snapshot?: boolean; includeComputeUsage?: _Core.IncludeComputeUsage; referenceSigningOptions?: ReferenceSigningOptions; } /** * Represents the API response when loading an ObjectSet. * * Log Safety: UNSAFE */ declare interface LoadObjectSetResponseV2 { data: Array; nextPageToken?: _Core.PageToken; totalCount: _Core.TotalCount; computeUsage?: _Core.ComputeSeconds; propertySecurities: Array; } /** * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsMultipleObjectTypes endpoint only. * * Log Safety: UNSAFE */ declare interface LoadObjectSetV2MultipleObjectTypesRequest { objectSet: ObjectSet_2; orderBy?: SearchOrderByV2; select: Array; selectV2: Array; defaultLoadLevel?: PropertyLoadLevel; loadOntologyDefinedDerivedProperties?: boolean; pageToken?: _Core.PageToken; pageSize?: _Core.PageSize; excludeRid?: boolean; loadPropertySecurities?: boolean; snapshot?: boolean; includeComputeUsage?: _Core.IncludeComputeUsage; referenceSigningOptions?: ReferenceSigningOptions; } /** * Represents the API response when loading an ObjectSet. An interfaceToObjectTypeMappings field is optionally returned if the type scope of the returned object set includes any interfaces. The "type scope" of an object set refers to whether objects contain all their properties (object-type type scope) or just the properties that implement interface properties (interface type scope). There can be multiple type scopes in a single object set- some objects may have all their properties and some may only have interface properties. The interfaceToObjectTypeMappings field contains mappings from SharedPropertyTypeApiNames on the interface(s) to PropertyApiName for properties on the object(s). The interfaceToObjectTypeMappingsV2 field contains mappings from InterfacePropertyApiNames on the interface(s) to InterfacePropertyTypeImplementation for properties on the object(s). This therefore includes implementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface. * * Log Safety: UNSAFE */ declare interface LoadObjectSetV2MultipleObjectTypesResponse { data: Array; nextPageToken?: _Core.PageToken; totalCount: _Core.TotalCount; interfaceToObjectTypeMappings: Record; interfaceToObjectTypeMappingsV2: Record; computeUsage?: _Core.ComputeSeconds; propertySecurities: Array; } /** * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsOrInterfaces endpoint only. * * Log Safety: UNSAFE */ declare interface LoadObjectSetV2ObjectsOrInterfacesRequest { objectSet: ObjectSet_2; orderBy?: SearchOrderByV2; select: Array; selectV2: Array; defaultLoadLevel?: PropertyLoadLevel; loadOntologyDefinedDerivedProperties?: boolean; pageToken?: _Core.PageToken; pageSize?: _Core.PageSize; excludeRid?: boolean; snapshot?: boolean; referenceSigningOptions?: ReferenceSigningOptions; } /** * Represents the API response when loading an ObjectSet. Objects in the returned set can either have properties defined by an interface that the objects belong to or properties defined by the object type of the object. * * Log Safety: UNSAFE */ declare interface LoadObjectSetV2ObjectsOrInterfacesResponse { data: Array; nextPageToken?: _Core.PageToken; totalCount: _Core.TotalCount; transactionId?: OntologyTransactionId; } /* Excluded from this release type: loadObjectsOrInterfaces */ /** * The Ontology metadata (i.e., object, link, action, query, and interface types) to load. * * Log Safety: UNSAFE */ declare interface LoadOntologyMetadataRequest { objectTypes: Array; linkTypes: Array; actionTypes: Array; queryTypes: Array; interfaceTypes: Array; } /** * A string representation of a BCP 47 language tag (java.util.Locale.toLanguageTag) * * Log Safety: SAFE */ declare type Locale = LooselyBrandedString<"Locale">; /** * Log Safety: SAFE */ declare interface LocalFilePath { } /** * Log Safety: SAFE */ declare interface LogFile { id: FileId; } export declare namespace LogFiles { export { list_30 as list, content_2 as content } } /** * A number representing a logical ordering to be used for transactions, etc. This can be interpreted as a timestamp in microseconds, but may differ slightly from system clock time due to clock drift and slight adjustments for the sake of ordering. Only positive timestamps (representing times after epoch) are supported. * * Log Safety: SAFE */ declare type LogicalTimestamp = string; /** * Log Safety: UNSAFE */ declare type LogicRule = ({ type: "deleteInterfaceObject"; } & DeleteInterfaceObjectRule) | ({ type: "modifyInterfaceObject"; } & ModifyInterfaceObjectRule) | ({ type: "modifyObject"; } & ModifyObjectRule) | ({ type: "deleteObject"; } & DeleteObjectRule) | ({ type: "createInterfaceObject"; } & CreateInterfaceObjectRule) | ({ type: "deleteLink"; } & DeleteLinkRule) | ({ type: "createObject"; } & CreateObjectRule) | ({ type: "createLink"; } & CreateLinkRule) | ({ type: "applyScenario"; } & ApplyScenarioRule); /** * Returns action types which contain a logic rule of the given type. * * Log Safety: SAFE */ declare interface LogicRuleActionTypesQueryV2 { value: ActionTypeLogicRuleTypeFilter; } /** * Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value. * * Log Safety: UNSAFE */ declare type LogicRuleArgument = ({ type: "currentTime"; } & CurrentTimeArgument) | ({ type: "staticValue"; } & StaticArgument) | ({ type: "currentUser"; } & CurrentUserArgument) | ({ type: "parameterId"; } & ParameterIdArgument) | ({ type: "interfaceParameterPropertyValue"; } & InterfaceParameterPropertyArgument) | ({ type: "synchronousWebhookOutput"; } & SynchronousWebhookOutputArgument) | ({ type: "objectParameterPropertyValue"; } & ObjectParameterPropertyArgument) | ({ type: "uniqueIdentifier"; } & UniqueIdentifierArgument); /** * The state for an incremental table import using a column with a numeric long datatype. * * Log Safety: UNSAFE */ declare interface LongColumnInitialIncrementalState { columnName: string; currentValue: string; } /** * Log Safety: SAFE */ declare interface LongType { } /** * Log Safety: SAFE */ declare interface LongType_2 { } /** * Log Safety: UNSAFE */ declare interface LongValue { value: string; } declare type LooselyBrandedString = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_10 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_11 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_12 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_13 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_14 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_15 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_16 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_17 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_18 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_19 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_2 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_20 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_21 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_22 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_23 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_24 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_3 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_4 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_5 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_6 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_7 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_8 = string & { __LOOSE_BRAND?: T; }; declare type LooselyBrandedString_9 = string & { __LOOSE_BRAND?: T; }; /** * Returns objects where the specified field is less than or equal to a value. * * Log Safety: UNSAFE */ declare interface LteQuery { field: FieldNameV1; value: PropertyValue_2; } /** * @deprecated Use `LteQueryV2` in the `foundry.ontologies` package * * Returns objects where the specified field is less than or equal to a value. * * Log Safety: UNSAFE */ declare interface LteQueryV2 { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: PropertyValue; } /** * Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface LteQueryV2_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: PropertyValue_2; } /** * Returns objects where the specified field is less than a value. * * Log Safety: UNSAFE */ declare interface LtQuery { field: FieldNameV1; value: PropertyValue_2; } /** * @deprecated Use `LtQueryV2` in the `foundry.ontologies` package * * Returns objects where the specified field is less than a value. * * Log Safety: UNSAFE */ declare interface LtQueryV2 { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: PropertyValue; } /** * Returns objects where the specified field is less than a value. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface LtQueryV2_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: PropertyValue_2; } /** * An email mailbox with an optional display name and email address. * * Log Safety: UNSAFE */ declare interface Mailbox { displayName?: string; emailAddress: string; } /** * Either a mailbox or a group of mailboxes. * * Log Safety: UNSAFE */ declare type MailboxOrGroup = ({ type: "mailbox"; } & MailboxWrapper) | ({ type: "group"; } & GroupWrapper); /** * A wrapper for a mailbox in the MailboxOrGroup union. * * Log Safety: UNSAFE */ declare interface MailboxWrapper { mailbox: Mailbox; } /** * At least one of requested filters are malformed. Please look at the documentation of PropertyFilter. * * Log Safety: UNSAFE */ declare interface MalformedPropertyFilters { errorCode: "INVALID_ARGUMENT"; errorName: "MalformedPropertyFilters"; errorDescription: "At least one of requested filters are malformed. Please look at the documentation of PropertyFilter."; errorInstanceId: string; parameters: { malformedPropertyFilter: unknown; }; } /** * Manually specify all datasets to build. * * Log Safety: SAFE */ declare interface ManualTarget { targetRids: Array; } /** * Only trigger the Schedule manually. If placed in an AND or OR condition, this Trigger will be ignored. * * Log Safety: SAFE */ declare interface ManualTrigger { } /** * Log Safety: UNSAFE */ declare interface MapColumnType { keyType: ColumnType; valueType: ColumnType; } /** * Log Safety: UNSAFE */ declare interface MapConstraint { keyConstraints: Array; valueConstraints: Array; uniqueValues: boolean; } /** * Log Safety: UNSAFE */ declare interface MapFieldType { keySchema: FieldSchema; valueSchema: FieldSchema; } /** * A key for a map parameter value. * * Log Safety: UNSAFE */ declare type MapParameterKey = LooselyBrandedString_21<"MapParameterKey">; /** * The parameter value (a markdown-formatted string) must satisfy the configured length bounds. * * Log Safety: SAFE */ declare interface MarkdownAllowedValues { gte?: number; lte?: number; } /** * The given action could not be mapped to a Marketplace installation. * * Log Safety: UNSAFE */ declare interface MarketplaceActionMappingNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceActionMappingNotFound"; errorDescription: "The given action could not be mapped to a Marketplace installation."; errorInstanceId: string; parameters: { actionType: unknown; artifactRepository: unknown; packageName: unknown; }; } /** * The given marketplace installation could not be found or the user does not have access to it. * * Log Safety: UNSAFE */ declare interface MarketplaceInstallationNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceInstallationNotFound"; errorDescription: "The given marketplace installation could not be found or the user does not have access to it."; errorInstanceId: string; parameters: { artifactRepository: unknown; packageName: unknown; }; } /** * The given link could not be mapped to a Marketplace installation. * * Log Safety: UNSAFE */ declare interface MarketplaceLinkMappingNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceLinkMappingNotFound"; errorDescription: "The given link could not be mapped to a Marketplace installation."; errorInstanceId: string; parameters: { linkType: unknown; artifactRepository: unknown; packageName: unknown; }; } /** * The given object could not be mapped to a Marketplace installation. * * Log Safety: UNSAFE */ declare interface MarketplaceObjectMappingNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceObjectMappingNotFound"; errorDescription: "The given object could not be mapped to a Marketplace installation."; errorInstanceId: string; parameters: { objectType: unknown; artifactRepository: unknown; packageName: unknown; }; } /** * The given query could not be mapped to a Marketplace installation. * * Log Safety: UNSAFE */ declare interface MarketplaceQueryMappingNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceQueryMappingNotFound"; errorDescription: "The given query could not be mapped to a Marketplace installation."; errorInstanceId: string; parameters: { queryType: unknown; artifactRepository: unknown; packageName: unknown; }; } /** * The given action could not be mapped to a Marketplace installation. * * Log Safety: UNSAFE */ declare interface MarketplaceSdkActionMappingNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceSdkActionMappingNotFound"; errorDescription: "The given action could not be mapped to a Marketplace installation."; errorInstanceId: string; parameters: { actionType: unknown; sdkPackageRid: unknown; sdkVersion: unknown; }; } /** * The given marketplace installation could not be found or the user does not have access to it. * * Log Safety: SAFE */ declare interface MarketplaceSdkInstallationNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceSdkInstallationNotFound"; errorDescription: "The given marketplace installation could not be found or the user does not have access to it."; errorInstanceId: string; parameters: { sdkPackageRid: unknown; sdkVersion: unknown; }; } /** * The given link could not be mapped to a Marketplace installation. * * Log Safety: UNSAFE */ declare interface MarketplaceSdkLinkMappingNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceSdkLinkMappingNotFound"; errorDescription: "The given link could not be mapped to a Marketplace installation."; errorInstanceId: string; parameters: { linkType: unknown; sdkPackageRid: unknown; sdkVersion: unknown; }; } /** * The given object could not be mapped to a Marketplace installation. * * Log Safety: UNSAFE */ declare interface MarketplaceSdkObjectMappingNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceSdkObjectMappingNotFound"; errorDescription: "The given object could not be mapped to a Marketplace installation."; errorInstanceId: string; parameters: { localObjectType: unknown; objectType: unknown; sdkPackageRid: unknown; sdkVersion: unknown; }; } /** * The given property could not be mapped to a Marketplace installation. * * Log Safety: UNSAFE */ declare interface MarketplaceSdkPropertyMappingNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceSdkPropertyMappingNotFound"; errorDescription: "The given property could not be mapped to a Marketplace installation."; errorInstanceId: string; parameters: { propertyType: unknown; objectType: unknown; sdkPackageRid: unknown; sdkVersion: unknown; }; } /** * The given query could not be mapped to a Marketplace installation. * * Log Safety: UNSAFE */ declare interface MarketplaceSdkQueryMappingNotFound { errorCode: "NOT_FOUND"; errorName: "MarketplaceSdkQueryMappingNotFound"; errorDescription: "The given query could not be mapped to a Marketplace installation."; errorInstanceId: string; parameters: { queryType: unknown; sdkPackageRid: unknown; sdkVersion: unknown; }; } /** * Log Safety: UNSAFE */ declare interface Marking { id: _Core.MarkingId; categoryId: MarkingCategoryId; name: MarkingName; description?: string; organization?: _Core.OrganizationRid; createdTime: _Core.CreatedTime; createdBy?: _Core.CreatedBy; } /** * Markings provide an additional level of access control for files, folders, and Projects within Foundry. Markings define eligibility criteria that restrict visibility and actions to users who meet those criteria. To access a resource, a user must be a member of all Markings applied to a resource to access it. * * Log Safety: UNSAFE */ declare interface Marking_2 { markingId: _Core.MarkingId; isDirectlyApplied: IsDirectlyApplied; } export declare namespace MarkingCategories { export { list_8 as list, get_9 as get } } /** * Log Safety: UNSAFE */ declare interface MarkingCategory { id: MarkingCategoryId; name: MarkingCategoryName; description: MarkingCategoryDescription; categoryType: MarkingCategoryType; markingType: MarkingType_2; markings: Array<_Core.MarkingId>; createdTime: _Core.CreatedTime; createdBy?: _Core.CreatedBy; } /** * Log Safety: UNSAFE */ declare type MarkingCategoryDescription = LooselyBrandedString_3<"MarkingCategoryDescription">; /** * The ID of a marking category. For user-created categories, this will be a UUID. Markings associated with Organizations are placed in a category with ID "Organization". * * Log Safety: UNSAFE */ declare type MarkingCategoryId = LooselyBrandedString_3<"MarkingCategoryId">; /** * Log Safety: UNSAFE */ declare type MarkingCategoryName = LooselyBrandedString_3<"MarkingCategoryName">; /** * The given MarkingCategory could not be found. * * Log Safety: UNSAFE */ declare interface MarkingCategoryNotFound { errorCode: "NOT_FOUND"; errorName: "MarkingCategoryNotFound"; errorDescription: "The given MarkingCategory could not be found."; errorInstanceId: string; parameters: { markingCategoryId: unknown; }; } /** * Log Safety: SAFE */ declare interface MarkingCategoryPermissions { organizationRids: Array<_Core.OrganizationRid>; roles: Array; isPublic: MarkingCategoryPermissionsIsPublic; } /** * If true, all users who are members of at least one of the Organizations from organizationRids can view the Markings in the category. If false, only users who are explicitly granted the VIEW role can view the Markings in the category. * * Log Safety: SAFE */ declare type MarkingCategoryPermissionsIsPublic = boolean; /** * Represents the operations that a user can perform with regards to a Marking Category. ADMINISTER: The user can update a Marking Category's metadata and permissions VIEW: The user can view the Marking Category and the Markings within it. NOTE: Permissions to administer or view a Marking Category do not confer any permissions to administer or view data protected by the Markings within that category. * * Log Safety: SAFE */ declare type MarkingCategoryRole = "ADMINISTER" | "VIEW"; /** * Log Safety: SAFE */ declare interface MarkingCategoryRoleAssignment { role: MarkingCategoryRole; principalId: _Core.PrincipalId; } /** * Log Safety: SAFE */ declare type MarkingCategoryType = "CONJUNCTIVE" | "DISJUNCTIVE"; /** * The ID of a security marking. * * Log Safety: UNSAFE */ declare type MarkingId = LooselyBrandedString<"MarkingId">; /** * The id of a classification or mandatory marking. * * Log Safety: UNSAFE */ declare type MarkingId_2 = LooselyBrandedString_5<"MarkingId">; /** * The ID of a security marking. * * Log Safety: UNSAFE */ declare type MarkingId_3 = LooselyBrandedString_6<"MarkingId">; /** * The ID of a security marking. * * Log Safety: UNSAFE */ declare type MarkingId_4 = LooselyBrandedString_12<"MarkingId">; /** * A UUID representing a Mandatory Marking. * * Log Safety: SAFE */ declare type MarkingId_5 = string; /** * Log Safety: SAFE */ declare interface MarkingMember { principalType: _Core.PrincipalType; principalId: _Core.PrincipalId; } export declare namespace MarkingMembers { export { list_9 as list, add_3 as add, remove_3 as remove } } /** * Log Safety: UNSAFE */ declare type MarkingName = LooselyBrandedString_3<"MarkingName">; /** * A marking with the same name already exists in the category. * * Log Safety: UNSAFE */ declare interface MarkingNameInCategoryAlreadyExists { errorCode: "INVALID_ARGUMENT"; errorName: "MarkingNameInCategoryAlreadyExists"; errorDescription: "A marking with the same name already exists in the category."; errorInstanceId: string; parameters: { displayName: unknown; categoryId: unknown; }; } /** * The marking name is empty. * * Log Safety: SAFE */ declare interface MarkingNameIsEmpty { errorCode: "INVALID_ARGUMENT"; errorName: "MarkingNameIsEmpty"; errorDescription: "The marking name is empty."; errorInstanceId: string; parameters: {}; } /** * The given Marking could not be found. * * Log Safety: UNSAFE */ declare interface MarkingNotFound { errorCode: "NOT_FOUND"; errorName: "MarkingNotFound"; errorDescription: "The given Marking could not be found."; errorInstanceId: string; parameters: { markingId: unknown; }; } /** * A provided marking ID cannot be found. * * Log Safety: UNSAFE */ declare interface MarkingNotFound_2 { errorCode: "NOT_FOUND"; errorName: "MarkingNotFound"; errorDescription: "A provided marking ID cannot be found."; errorInstanceId: string; parameters: { markingIds: unknown; }; } /** * A portion marking used by CBAC (Classification based access control). * * Log Safety: UNSAFE */ declare type MarkingPrincipal = LooselyBrandedString_19<"MarkingPrincipal">; /** * Represents the operations that a user can perform with regards to a Marking. ADMINISTER: The user can add and remove members from the Marking, update Marking Role Assignments, and change Marking metadata. DECLASSIFY: The user can remove the Marking from resources in the platform and stop the propagation of the Marking during a transform. USE: The user can apply the marking to resources in the platform. * * Log Safety: SAFE */ declare type MarkingRole = "ADMINISTER" | "DECLASSIFY" | "USE"; /** * Log Safety: SAFE */ declare interface MarkingRoleAssignment { principalType: _Core.PrincipalType; principalId: _Core.PrincipalId; role: MarkingRole; } export declare namespace MarkingRoleAssignments { export { list_10 as list, add_4 as add, remove_4 as remove } } /** * Log Safety: SAFE */ declare interface MarkingRoleUpdate { role: MarkingRole; principalId: _Core.PrincipalId; } export declare namespace Markings { export { create_2 as create, list_7 as list, get_8 as get, getBatch_2 as getBatch, replace_4 as replace } } /** * List of Markings directly applied to a resource. The number of Markings on a resource is typically small * so the `pageSize` and `pageToken` parameters are not required. * * @public * * Required Scopes: [] * URL: /v2/filesystem/resources/{resourceRid}/markings */ declare function markings($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ resourceRid: _Filesystem_2.ResourceRid, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Filesystem_2.ListMarkingsOfResourceResponse>; /** * Log Safety: SAFE */ declare interface MarkingType { markingType?: MarkingTypeValue; } /** * Log Safety: SAFE */ declare type MarkingType_2 = "MANDATORY" | "CBAC"; /** * The kind of marking applied by a marking property type. CBAC: Classification-based access control markings. MANDATORY: Standard non-classification markings. Example - Organizations. * * Log Safety: SAFE */ declare type MarkingTypeValue = "CBAC" | "MANDATORY"; /** * Matches intervals containing the terms in the query * * Log Safety: UNSAFE */ declare interface MatchRule { query: string; maxGaps?: number; ordered: boolean; } /** * Computes the maximum value for the provided field. * * Log Safety: UNSAFE */ declare interface MaxAggregation { field: FieldNameV1; name?: AggregationMetricName; } /** * Computes the maximum value for the provided field. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface MaxAggregationV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; name?: AggregationMetricName; direction?: OrderByDirection_2; } /** * Log Safety: SAFE */ declare interface MediaAttribution { creatorId: _Core.UserId; creationTimestamp: string; } /** * The file cannot be read because it contains unsupported security settings (for example, public-key security handlers in a PDF). * * Log Safety: UNSAFE */ declare interface MediaItemHasUnsupportedSecuritySettings { errorCode: "INVALID_ARGUMENT"; errorName: "MediaItemHasUnsupportedSecuritySettings"; errorDescription: "The file cannot be read because it contains unsupported security settings (for example, public-key security handlers in a PDF)."; errorInstanceId: string; parameters: { mediaSetRid: unknown; path: unknown; }; } /** * The file cannot be parsed as an image. * * Log Safety: UNSAFE */ declare interface MediaItemImageUnparsable { errorCode: "INVALID_ARGUMENT"; errorName: "MediaItemImageUnparsable"; errorDescription: "The file cannot be parsed as an image."; errorInstanceId: string; parameters: { mediaSetRid: unknown; path: unknown; }; } /** * The file cannot be read because it is password protected. * * Log Safety: UNSAFE */ declare interface MediaItemIsPasswordProtected { errorCode: "INVALID_ARGUMENT"; errorName: "MediaItemIsPasswordProtected"; errorDescription: "The file cannot be read because it is password protected."; errorInstanceId: string; parameters: { mediaSetRid: unknown; path: unknown; }; } /** * Detailed metadata about a media item, including type-specific information such as dimensions for images, duration for audio/video, page count for documents, etc. * * Log Safety: UNSAFE */ declare type MediaItemMetadata = ({ type: "cad"; } & CadMediaItemMetadata) | ({ type: "document"; } & DocumentMediaItemMetadata) | ({ type: "imagery"; } & ImageryMediaItemMetadata) | ({ type: "spreadsheet"; } & SpreadsheetMediaItemMetadata) | ({ type: "untyped"; } & UntypedMediaItemMetadata) | ({ type: "audio"; } & AudioMediaItemMetadata) | ({ type: "model3d"; } & Model3dMediaItemMetadata) | ({ type: "video"; } & VideoMediaItemMetadata) | ({ type: "dicom"; } & DicomMediaItemMetadata) | ({ type: "email"; } & EmailMediaItemMetadata); /** * The requested media item could not be found, or the client token does not have access to it. * * Log Safety: SAFE */ declare interface MediaItemNotFound { errorCode: "NOT_FOUND"; errorName: "MediaItemNotFound"; errorDescription: "The requested media item could not be found, or the client token does not have access to it."; errorInstanceId: string; parameters: { mediaSetRid: unknown; mediaItemRid: unknown; }; } /** * A user-specified identifier for a media item within a media set. Paths must be less than 256 characters long. If multiple items are written to the same media set at the same path, then when retrieving by path the media item which was written last is returned. * * Log Safety: UNSAFE */ declare type MediaItemPath = LooselyBrandedString<"MediaItemPath">; /** * A token that grants access to read specific media items. * * Log Safety: UNSAFE */ declare type MediaItemReadToken = LooselyBrandedString<"MediaItemReadToken">; /** * The Resource Identifier (RID) of an individual Media Item within a Media Set in Foundry. * * Log Safety: SAFE */ declare type MediaItemRid = LooselyBrandedString<"MediaItemRid">; /** * A media item with the specified RID already exists. * * Log Safety: SAFE */ declare interface MediaItemRidAlreadyExists { errorCode: "CONFLICT"; errorName: "MediaItemRidAlreadyExists"; errorDescription: "A media item with the specified RID already exists."; errorInstanceId: string; parameters: { mediaItemRid: unknown; }; } /** * Format of the media item attempted to be decoded based on the XML structure. * * Log Safety: SAFE */ declare type MediaItemXmlFormat = "DOCX" | "XLSX" | "PPTX"; /** * The document cannot be parsed due to an unrecognized XML structure. * * Log Safety: UNSAFE */ declare interface MediaItemXmlUnparsable { errorCode: "INVALID_ARGUMENT"; errorName: "MediaItemXmlUnparsable"; errorDescription: "The document cannot be parsed due to an unrecognized XML structure."; errorInstanceId: string; parameters: { mediaItemXmlFormat: unknown; mediaSetRid: unknown; path: unknown; }; } /** * Log Safety: UNSAFE */ declare interface MediaMetadata_2 { path?: _Core.MediaItemPath; sizeBytes: _Core.SizeBytes; mediaType: _Core.MediaType; } /** * The number of thresholds the build's duration differs from the median. * * Log Safety: SAFE */ declare interface MedianDeviation { boundsType?: MedianDeviationBoundsType; dataPoints: number; deviationThreshold: number; } /** * The three types of median deviations a bounds type can have: - LOWER_BOUND – Tests for significant deviations below the median value, - UPPER_BOUND – Tests for significant deviations above the median value, - TWO_TAILED – Tests for significant deviations in either direction from the median value. * * Log Safety: SAFE */ declare type MedianDeviationBoundsType = "LOWER_BOUND" | "UPPER_BOUND" | "TWO_TAILED"; /** * Configuration for median deviation check with severity settings. * * Log Safety: SAFE */ declare interface MedianDeviationConfig { medianDeviation: MedianDeviation; severity: SeverityLevel; } /** * The representation of a media reference. * * Log Safety: UNSAFE */ declare interface MediaReference { mimeType: MediaType; reference: Reference; } export declare namespace MediaReferenceProperties { export { } } /** * Log Safety: UNSAFE */ declare type MediaReferenceProperty = LooselyBrandedString_5<"MediaReferenceProperty">; /** * Log Safety: SAFE */ declare interface MediaReferenceType { } /** * The schema type of a media set, indicating what type of media items it can contain. * * Log Safety: SAFE */ declare type MediaSchema = "AUDIO" | "CAD" | "DICOM" | "DOCUMENT" | "IMAGERY" | "MODEL_3D" | "MULTIMODAL" | "SPREADSHEET" | "STREAMING_VIDEO" | "VIDEO" | "EMAIL"; /** * Log Safety: UNSAFE */ declare interface MediaSet { rid: _Core.MediaSetRid; name: MediaSetName; parentFolderRid: _Core.FolderRid; } /** * Log Safety: UNSAFE */ declare type MediaSetName = LooselyBrandedString_14<"MediaSetName">; /** * The requested media set could not be found, or the client token does not have access to it. * * Log Safety: SAFE */ declare interface MediaSetNotFound { errorCode: "NOT_FOUND"; errorName: "MediaSetNotFound"; errorDescription: "The requested media set could not be found, or the client token does not have access to it."; errorInstanceId: string; parameters: { mediaSetRid: unknown; }; } /** * A transaction is already open on this media set and branch. A branch of a media set can only have one open transaction at a time. * * Log Safety: SAFE */ declare interface MediaSetOpenTransactionAlreadyExists { errorCode: "CONFLICT"; errorName: "MediaSetOpenTransactionAlreadyExists"; errorDescription: "A transaction is already open on this media set and branch. A branch of a media set can only have one open transaction at a time."; errorInstanceId: string; parameters: { mediaSetRid: unknown; }; } /** * The Resource Identifier (RID) of a Media Set in Foundry. * * Log Safety: SAFE */ declare type MediaSetRid = LooselyBrandedString<"MediaSetRid">; export declare namespace MediaSets { export { AffineTransform, AnnotateGeometry, AnnotateImageOperation, Annotation, ApiNameLocatorWrapper, ArchiveEncodeFormat, AudioChannelLayout, AudioChannelOperation, AudioChunkOperation, AudioDecodeFormat, AudioEncodeFormat, AudioMediaItemMetadata, AudioOperation, AudioSpecification, AudioToTextOperation, AudioToTextTransformation, AudioTransformation, AvailableEmbeddingModelIds, BandInfo, BatchTransactionsTransactionPolicy, BoundingBox, BoundingBoxGeometry, BranchName_4 as BranchName, BranchRid, CadDecodeFormat, CadMediaItemMetadata, CadUnits, ChatLlmSpec, ChatLlmSpecWrapper, Color_2 as Color, ColorInterpretation, CommonDicomDataElements, ContrastBinarize, ContrastEqualize, ContrastImageOperation, ContrastRayleigh, ContrastType, ConvertAudioOperation, ConvertDocumentOperation, ConvertSheetToJsonOperation, CoordinateReferenceSystem, CreatePdfOperation, CropConfig, CropImageOperation, DataType, DecryptImageOperation, DicomDataElementKey, DicomMediaItemMetadata, DicomMediaType, DicomMetaInformation, DicomMetaInformationV1, DicomToImageOperation, DicomToImageTransformation, Dimensions, DocumentDecodeFormat, DocumentEncodeFormat, DocumentExtractLayoutAwareContentOperation, DocumentMediaItemMetadata, DocumentToDocumentOperation, DocumentToDocumentTransformation, DocumentToImageOperation, DocumentToImageTransformation, DocumentToTextOperation, DocumentToTextTransformation, EmailAttachment, EmailDecodeFormat, EmailMediaItemMetadata, EmailToAttachmentOperation, EmailToAttachmentTransformation, EmailToTextEncodeFormat, EmailToTextOperation, EmailToTextTransformation, EncryptImageOperation, ExtractAllTextOperation, ExtractAudioOperation, ExtractDocumentLayoutAwareTextV2Config, ExtractDocumentLayoutAwareTextV2Operation, ExtractDocumentTextV2Config, ExtractDocumentTextV2Operation, ExtractFirstFrameOperation, ExtractFormFieldsOperation, ExtractFramesAtTimestampsOperation, ExtractSceneFramesOperation, ExtractTableOfContentsOperation, ExtractTextFromPagesToArrayOperation, ExtractTextPreprocessingWrapper, ExtractUnstructuredTextFromPageOperation, ExtractVlmTextOperation, FlipAxis, GcpList, GenerateEmbeddingOperation, GeoMetadata, GetEmailAttachmentOperation, GetEmailBodyOperation, GetMediaItemInfoResponse, GetMediaItemRidByPathResponse, GetMediaSetResponse, GetPdfPageDimensionsOperation, GetTimestampsForSceneFramesOperation, GetTransformationJobStatusResponse, GpsMetadata, GrayscaleImageOperation, GroundControlPoint, Group_2 as Group, GroupWrapper, ImageAttributeDomain, ImageAttributeKey, ImageExtractLayoutAwareContentOperation, ImageOcrOperation, ImageOperation, ImagePixelCoordinate, ImageRegionPolygon, ImageryDecodeFormat, ImageryEncodeFormat, ImageryMediaItemMetadata, ImageSpec, ImageToDocumentOperation, ImageToDocumentTransformation, ImageToEmbeddingOperation, ImageToEmbeddingTransformation, ImageToTextOperation, ImageToTextTransformation, ImageTransformation, JpgFormat, LanguageModelLocator, LayoutAwareExtractionParameters, LayoutAwareExtractionPreprocessingConfig, LayoutAwarePreprocessingWrapper, LlmSpec, LogicalTimestamp, Mailbox, MailboxOrGroup, MailboxWrapper, MediaAttribution, MediaItemMetadata, MediaItemXmlFormat, MediaSchema, MediaSet, MediaSetName, MkvVideoContainerFormat, Modality, Model3dDecodeFormat, Model3dMediaItemMetadata, Model3dType, MovVideoContainerFormat, Mp3Format, Mp4VideoContainerFormat, NoTransactionsTransactionPolicy, NumberOfChannels, OcrHocrOutputFormat, OcrLanguage, OcrLanguageOrScript, OcrLanguageWrapper, OcrMode, OcrOnPageOperation, OcrOnPagesOperation, OcrOutputFormat, OcrParameters, OcrScript, OcrScriptWrapper, OcrTextOutputFormat, Orientation, PageRange, PaletteInterpretation, PdfFormat, PerformanceMode, PlainTextNoSegmentData, PngFormat, Pttml, PutMediaItemResponse, RegisterMediaItemRequest, RegisterMediaItemResponse, RenderImageLayerOperation, RenderPageOperation, RenderPageToFitBoundingBoxOperation, ResizeImageOperation, ResizeToFitBoundingBoxOperation, ResizingMode, RotateImageOperation, RotationAngle, SceneScore, SlicePdfRangeOperation, SpreadsheetDecodeFormat, SpreadsheetMediaItemMetadata, SpreadsheetToTextOperation, SpreadsheetToTextTransformation, TarFormat, TextOutputFormat, TiffFormat, TileImageOperation, TrackedTransformationFailedResponse, TrackedTransformationPendingResponse, TrackedTransformationResponse, TrackedTransformationSuccessfulResponse, TransactionId_2 as TransactionId, TransactionPolicy, TranscodeOperation, TranscribeJson, TranscribeOperation, TranscribeTextEncodeFormat, TranscriptionLanguage, Transformation, TransformationJobId, TransformationJobStatus, TransformMediaItemRequest, TransformMediaItemResponse, TsAudioContainerFormat, TsVideoContainerFormat, UnitInterpretation, UntypedMediaItemMetadata, VideoChunkOperation, VideoDecodeFormat, VideoEncodeFormat, VideoMediaItemMetadata, VideoOperation, VideoSpecification, VideoToArchiveOperation, VideoToArchiveTransformation, VideoToAudioOperation, VideoToAudioTransformation, VideoToImageOperation, VideoToImageTransformation, VideoToTextOperation, VideoToTextTransformation, VideoTransformation, VlmOutputFormat, VlmPreprocessingConfig, WaveformOperation, WavEncodeFormat, WebpFormat, ConflictingMediaSetIdentifiers, GetMediaItemRidByPathPermissionDenied, InvalidMediaItemRid, InvalidMediaItemSchema, MediaItemHasUnsupportedSecuritySettings, MediaItemImageUnparsable, MediaItemIsPasswordProtected, MediaItemNotFound, MediaItemRidAlreadyExists, MediaItemXmlUnparsable, MediaSetNotFound, MediaSetOpenTransactionAlreadyExists, MissingMediaItemContent, MissingMediaItemPath, TemporaryMediaUploadInsufficientPermissions, TemporaryMediaUploadUnknownFailure, TransformationDocumentExtractError, TransformationImageTooLargeForOcr, TransformationInputTooLarge, TransformationInvalidPageRange, TransformationMediaSizeExceeded, TransformationModelContextWindowExceeded, TransformationModelNotAvailable, TransformationModelNotSupported, TransformationNotFound, TransformationPermissionDenied, TransformationUnavailable, TransformationVlmError, TransformationVlmLayoutModelFailure, TransformationVlmMultiPageRequestUnsupported, TransformationVlmPageRangeRequired, TransformationVlmResponseParseError, TransformedMediaItemNotFound, UnexpectedMetadataType, UnsupportedMetadata, MediaSets_2 as MediaSets } } declare namespace _MediaSets { export { LooselyBrandedString_14 as LooselyBrandedString, AffineTransform, AnnotateGeometry, AnnotateImageOperation, Annotation, ApiNameLocatorWrapper, ArchiveEncodeFormat, AudioChannelLayout, AudioChannelOperation, AudioChunkOperation, AudioDecodeFormat, AudioEncodeFormat, AudioMediaItemMetadata, AudioOperation, AudioSpecification, AudioToTextOperation, AudioToTextTransformation, AudioTransformation, AvailableEmbeddingModelIds, BandInfo, BatchTransactionsTransactionPolicy, BoundingBox, BoundingBoxGeometry, BranchName_4 as BranchName, BranchRid, CadDecodeFormat, CadMediaItemMetadata, CadUnits, ChatLlmSpec, ChatLlmSpecWrapper, Color_2 as Color, ColorInterpretation, CommonDicomDataElements, ContrastBinarize, ContrastEqualize, ContrastImageOperation, ContrastRayleigh, ContrastType, ConvertAudioOperation, ConvertDocumentOperation, ConvertSheetToJsonOperation, CoordinateReferenceSystem, CreatePdfOperation, CropConfig, CropImageOperation, DataType, DecryptImageOperation, DicomDataElementKey, DicomMediaItemMetadata, DicomMediaType, DicomMetaInformation, DicomMetaInformationV1, DicomToImageOperation, DicomToImageTransformation, Dimensions, DocumentDecodeFormat, DocumentEncodeFormat, DocumentExtractLayoutAwareContentOperation, DocumentMediaItemMetadata, DocumentToDocumentOperation, DocumentToDocumentTransformation, DocumentToImageOperation, DocumentToImageTransformation, DocumentToTextOperation, DocumentToTextTransformation, EmailAttachment, EmailDecodeFormat, EmailMediaItemMetadata, EmailToAttachmentOperation, EmailToAttachmentTransformation, EmailToTextEncodeFormat, EmailToTextOperation, EmailToTextTransformation, EncryptImageOperation, ExtractAllTextOperation, ExtractAudioOperation, ExtractDocumentLayoutAwareTextV2Config, ExtractDocumentLayoutAwareTextV2Operation, ExtractDocumentTextV2Config, ExtractDocumentTextV2Operation, ExtractFirstFrameOperation, ExtractFormFieldsOperation, ExtractFramesAtTimestampsOperation, ExtractSceneFramesOperation, ExtractTableOfContentsOperation, ExtractTextFromPagesToArrayOperation, ExtractTextPreprocessingWrapper, ExtractUnstructuredTextFromPageOperation, ExtractVlmTextOperation, FlipAxis, GcpList, GenerateEmbeddingOperation, GeoMetadata, GetEmailAttachmentOperation, GetEmailBodyOperation, GetMediaItemInfoResponse, GetMediaItemRidByPathResponse, GetMediaSetResponse, GetPdfPageDimensionsOperation, GetTimestampsForSceneFramesOperation, GetTransformationJobStatusResponse, GpsMetadata, GrayscaleImageOperation, GroundControlPoint, Group_2 as Group, GroupWrapper, ImageAttributeDomain, ImageAttributeKey, ImageExtractLayoutAwareContentOperation, ImageOcrOperation, ImageOperation, ImagePixelCoordinate, ImageRegionPolygon, ImageryDecodeFormat, ImageryEncodeFormat, ImageryMediaItemMetadata, ImageSpec, ImageToDocumentOperation, ImageToDocumentTransformation, ImageToEmbeddingOperation, ImageToEmbeddingTransformation, ImageToTextOperation, ImageToTextTransformation, ImageTransformation, JpgFormat, LanguageModelLocator, LayoutAwareExtractionParameters, LayoutAwareExtractionPreprocessingConfig, LayoutAwarePreprocessingWrapper, LlmSpec, LogicalTimestamp, Mailbox, MailboxOrGroup, MailboxWrapper, MediaAttribution, MediaItemMetadata, MediaItemXmlFormat, MediaSchema, MediaSet, MediaSetName, MkvVideoContainerFormat, Modality, Model3dDecodeFormat, Model3dMediaItemMetadata, Model3dType, MovVideoContainerFormat, Mp3Format, Mp4VideoContainerFormat, NoTransactionsTransactionPolicy, NumberOfChannels, OcrHocrOutputFormat, OcrLanguage, OcrLanguageOrScript, OcrLanguageWrapper, OcrMode, OcrOnPageOperation, OcrOnPagesOperation, OcrOutputFormat, OcrParameters, OcrScript, OcrScriptWrapper, OcrTextOutputFormat, Orientation, PageRange, PaletteInterpretation, PdfFormat, PerformanceMode, PlainTextNoSegmentData, PngFormat, Pttml, PutMediaItemResponse, RegisterMediaItemRequest, RegisterMediaItemResponse, RenderImageLayerOperation, RenderPageOperation, RenderPageToFitBoundingBoxOperation, ResizeImageOperation, ResizeToFitBoundingBoxOperation, ResizingMode, RotateImageOperation, RotationAngle, SceneScore, SlicePdfRangeOperation, SpreadsheetDecodeFormat, SpreadsheetMediaItemMetadata, SpreadsheetToTextOperation, SpreadsheetToTextTransformation, TarFormat, TextOutputFormat, TiffFormat, TileImageOperation, TrackedTransformationFailedResponse, TrackedTransformationPendingResponse, TrackedTransformationResponse, TrackedTransformationSuccessfulResponse, TransactionId_2 as TransactionId, TransactionPolicy, TranscodeOperation, TranscribeJson, TranscribeOperation, TranscribeTextEncodeFormat, TranscriptionLanguage, Transformation, TransformationJobId, TransformationJobStatus, TransformMediaItemRequest, TransformMediaItemResponse, TsAudioContainerFormat, TsVideoContainerFormat, UnitInterpretation, UntypedMediaItemMetadata, VideoChunkOperation, VideoDecodeFormat, VideoEncodeFormat, VideoMediaItemMetadata, VideoOperation, VideoSpecification, VideoToArchiveOperation, VideoToArchiveTransformation, VideoToAudioOperation, VideoToAudioTransformation, VideoToImageOperation, VideoToImageTransformation, VideoToTextOperation, VideoToTextTransformation, VideoTransformation, VlmOutputFormat, VlmPreprocessingConfig, WaveformOperation, WavEncodeFormat, WebpFormat } } export declare namespace MediaSets_2 { export { info, metadata, read_2 as read, readOriginal, uploadMedia } } /** * Trigger whenever an update is made to a media set on the target branch. For transactional media sets, this happens when a transaction is committed. For non-transactional media sets, this event happens eventually (but not necessary immediately) after an update. * * Log Safety: UNSAFE */ declare interface MediaSetUpdatedTrigger { mediaSetRid: _Core.MediaSetRid; branchName: _Core.BranchName; } /** * Log Safety: UNSAFE */ declare interface MediaSetViewItem { mediaSetRid: MediaSetRid; mediaSetViewRid: MediaSetViewRid; mediaItemRid: MediaItemRid; token?: MediaItemReadToken; } /** * Log Safety: UNSAFE */ declare interface MediaSetViewItemWrapper { mediaSetViewItem: MediaSetViewItem; } /** * The Resource Identifier (RID) of a single View of a Media Set. A Media Set View is an independent collection of Media Items. * * Log Safety: SAFE */ declare type MediaSetViewRid = LooselyBrandedString<"MediaSetViewRid">; /** * The media type of the file or attachment. Examples: application/json, application/pdf, application/octet-stream, image/jpeg * * Log Safety: SAFE */ declare type MediaType = LooselyBrandedString<"MediaType">; /** * The media reference property is backed by multiple media set views, and none of them are marked as the upload destination for this property. Set an upload destination on exactly one of the backing media set views for this property in Ontology Manager. * * Log Safety: UNSAFE */ declare interface MediaUploadDestinationNotConfigured { errorCode: "INVALID_ARGUMENT"; errorName: "MediaUploadDestinationNotConfigured"; errorDescription: "The media reference property is backed by multiple media set views, and none of them are marked as the upload destination for this property. Set an upload destination on exactly one of the backing media set views for this property in Ontology Manager."; errorInstanceId: string; parameters: { objectType: unknown; property: unknown; }; } /** * The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set view datasource that includes this property in Ontology Manager. * * Log Safety: UNSAFE */ declare interface MediaUploadPropertyNotBackedByMediaSetView { errorCode: "INVALID_ARGUMENT"; errorName: "MediaUploadPropertyNotBackedByMediaSetView"; errorDescription: "The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set view datasource that includes this property in Ontology Manager."; errorInstanceId: string; parameters: { objectType: unknown; property: unknown; }; } /** * An ephemeral client-generated Universally Unique Identifier (UUID) to identify a message for streamed session responses. This can be used by clients to cancel a streamed exchange. * * Log Safety: SAFE */ declare type MessageId = string; /* Excluded from this release type: messages */ /** * Gets detailed metadata about the media item, including type-specific information * such as dimensions for images, duration for audio/video, page count for documents, etc. * * @public * * Required Scopes: [api:mediasets-read] * URL: /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata */ declare function metadata($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ mediaSetRid: _Core.MediaSetRid, mediaItemRid: _Core.MediaItemRid, $headerParams?: { ReadToken?: _Core.MediaItemReadToken | undefined; } ]): Promise<_MediaSets.MediaItemMetadata>; /** * Log Safety: UNSAFE */ declare type MethodObjectSet = ObjectSet_2; /** * The import configuration for a Microsoft Access connection. * * Log Safety: UNSAFE */ declare interface MicrosoftAccessTableImportConfig { query: TableImportQuery; initialIncrementalState?: TableImportInitialIncrementalState; } /** * The import configuration for a Microsoft SQL Server connection. * * Log Safety: UNSAFE */ declare interface MicrosoftSqlServerTableImportConfig { query: TableImportQuery; initialIncrementalState?: TableImportInitialIncrementalState; } /** * Computes the minimum value for the provided field. * * Log Safety: UNSAFE */ declare interface MinAggregation { field: FieldNameV1; name?: AggregationMetricName; } /** * Computes the minimum value for the provided field. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface MinAggregationV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; name?: AggregationMetricName; direction?: OrderByDirection_2; } /** * Batch requests must contain at least one element. * * Log Safety: SAFE */ declare interface MissingBatchRequest { errorCode: "INVALID_ARGUMENT"; errorName: "MissingBatchRequest"; errorDescription: "Batch requests must contain at least one element."; errorInstanceId: string; parameters: {}; } /** * The build target must contains at least one dataset target. * * Log Safety: SAFE */ declare interface MissingBuildTargets { errorCode: "INVALID_ARGUMENT"; errorName: "MissingBuildTargets"; errorDescription: "The build target must contains at least one dataset target."; errorInstanceId: string; parameters: {}; } /** * The connecting build target must contains at least one input dataset target. * * Log Safety: SAFE */ declare interface MissingConnectingBuildInputs { errorCode: "INVALID_ARGUMENT"; errorName: "MissingConnectingBuildInputs"; errorDescription: "The connecting build target must contains at least one input dataset target."; errorInstanceId: string; parameters: {}; } /** * A Display Name must be provided. * * Log Safety: SAFE */ declare interface MissingDisplayName { errorCode: "INVALID_ARGUMENT"; errorName: "MissingDisplayName"; errorDescription: "A Display Name must be provided."; errorInstanceId: string; parameters: {}; } /** * One or more template parameters are missing. * * Log Safety: UNSAFE */ declare interface MissingGenerationJobTemplateParameters { errorCode: "INVALID_ARGUMENT"; errorName: "MissingGenerationJobTemplateParameters"; errorDescription: "One or more template parameters are missing."; errorInstanceId: string; parameters: { templateParameterNames: unknown; }; } /** * The file has no bytes. * * Log Safety: UNSAFE */ declare interface MissingMediaItemContent { errorCode: "INVALID_ARGUMENT"; errorName: "MissingMediaItemContent"; errorDescription: "The file has no bytes."; errorInstanceId: string; parameters: { mediaSetRid: unknown; path: unknown; }; } /** * The given media set requires paths but no path was provided. * * Log Safety: SAFE */ declare interface MissingMediaItemPath { errorCode: "INVALID_ARGUMENT"; errorName: "MissingMediaItemPath"; errorDescription: "The given media set requires paths but no path was provided."; errorInstanceId: string; parameters: { mediaSetRid: unknown; }; } /** * Required parameters are missing. Please look at the parameters field to see which required parameters are missing from the request. * * Log Safety: UNSAFE */ declare interface MissingParameter { errorCode: "INVALID_ARGUMENT"; errorName: "MissingParameter"; errorDescription: "Required parameters are missing. Please look at the parameters field to see which required parameters are missing from the request."; errorInstanceId: string; parameters: { parameters: unknown; }; } /** * Required parameters are missing. Please look at the parameters field to see which required parameters are missing from the request. * * Log Safety: UNSAFE */ declare interface MissingParameter_2 { errorCode: "INVALID_ARGUMENT"; errorName: "MissingParameter"; errorDescription: "Required parameters are missing. Please look at the parameters field to see which required parameters are missing from the request."; errorInstanceId: string; parameters: { parameters: unknown; }; } /** * A post body is required for this endpoint, but was not found in the request. * * Log Safety: SAFE */ declare interface MissingPostBody { errorCode: "INVALID_ARGUMENT"; errorName: "MissingPostBody"; errorDescription: "A post body is required for this endpoint, but was not found in the request."; errorInstanceId: string; parameters: {}; } /** * The user-provided dataset is missing a column required by the trainer. * * Log Safety: UNSAFE */ declare interface MissingRequiredDatasetColumnError { datasetRid: _Core.DatasetRid; columnTypeSpecId: ColumnTypeSpecId; columnNames: Array<_Core.ColumnName>; } /** * Start date is required to list audit log files. * * Log Safety: SAFE */ declare interface MissingStartDate { errorCode: "INVALID_ARGUMENT"; errorName: "MissingStartDate"; errorDescription: "Start date is required to list audit log files."; errorInstanceId: string; parameters: {}; } /** * You must pass in a trigger when creating or updating a schedule. * * Log Safety: SAFE */ declare interface MissingTrigger { errorCode: "INVALID_ARGUMENT"; errorName: "MissingTrigger"; errorDescription: "You must pass in a trigger when creating or updating a schedule."; errorInstanceId: string; parameters: {}; } /** * This struct value type references another value type which either doesn't exist, or the user doesn't have access to. * * Log Safety: SAFE */ declare interface MissingValueTypeReference { errorCode: "INVALID_ARGUMENT"; errorName: "MissingValueTypeReference"; errorDescription: "This struct value type references another value type which either doesn't exist, or the user doesn't have access to."; errorInstanceId: string; parameters: { referencedRid: unknown; rid: unknown; }; } /** * A variable defined on the template requested for project creation does not have a value set in the request. * * Log Safety: UNSAFE */ declare interface MissingVariableValue { errorCode: "INVALID_ARGUMENT"; errorName: "MissingVariableValue"; errorDescription: "A variable defined on the template requested for project creation does not have a value set in the request."; errorInstanceId: string; parameters: { templateVariableId: unknown; }; } /** * The provided worker config input dataset is missing a column mapping required by the trainer. * * Log Safety: UNSAFE */ declare interface MissingWorkerConfigInputDatasetColumnMappingError { datasetRid: _Core.DatasetRid; columnTypeSpecId: ColumnTypeSpecId; } /** * The worker configuration is missing an input required by the trainer. * * Log Safety: UNSAFE */ declare interface MissingWorkerConfigInputError { inputAlias: InputAlias; } /** * The provided worker config input object set is missing a property mapping required by the trainer. * * Log Safety: UNSAFE */ declare interface MissingWorkerConfigInputObjectSetPropertyMappingError { objectSetRid: string; propertyTypeSpecId: string; } /** * The worker configuration is missing an output required by the trainer. * * Log Safety: UNSAFE */ declare interface MissingWorkerConfigOutputError { outputAlias: OutputAlias; } /** * MKV (Matroska) video container format. * * Log Safety: SAFE */ declare interface MkvVideoContainerFormat { } /** * DICOM modality code. A list of modalities and their meanings can be found in the DICOM specification. https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html#sect_C.7.3.1.1.1 * * Log Safety: SAFE */ declare type Modality = "AR" | "ASMT" | "AU" | "BDUS" | "BI" | "BMD" | "CR" | "CT" | "CTPROTOCOL" | "DG" | "DOC" | "DX" | "ECG" | "EPS" | "ES" | "FID" | "GM" | "HC" | "HD" | "IO" | "IOL" | "IVOCT" | "IVUS" | "KER" | "KO" | "LEN" | "LS" | "MG" | "MR" | "M3D" | "NM" | "OAM" | "OCT" | "OP" | "OPM" | "OPT" | "OPTBSV" | "OPTENF" | "OPV" | "OSS" | "OT" | "PLAN" | "PR" | "PT" | "PX" | "REG" | "RESP" | "RF" | "RG" | "RTDOSE" | "RTIMAGE" | "RTINTENT" | "RTPLAN" | "RTRAD" | "RTRECORD" | "RTSEGANN" | "RTSTRUCT" | "RWV" | "SEG" | "SM" | "SMR" | "SR" | "SRF" | "STAIN" | "TEXTUREMAP" | "TG" | "US" | "VA" | "XA" | "XC" | "AS" | "CD" | "CF" | "CP" | "CS" | "DD" | "DF" | "DM" | "DS" | "EC" | "FA" | "FS" | "LP" | "MA" | "MS" | "OPR" | "ST" | "VF"; /** * Log Safety: SAFE */ declare interface Model { rid: ModelRid; } /** * The format of a 3D model media item. * * Log Safety: SAFE */ declare type Model3dDecodeFormat = "LAS" | "PLY" | "OBJ"; /** * Metadata for 3D model media items. * * Log Safety: SAFE */ declare interface Model3dMediaItemMetadata { format: Model3dDecodeFormat; modelType: Model3dType; sizeBytes: number; } /** * The type of 3D model representation. * * Log Safety: SAFE */ declare type Model3dType = "POINT_CLOUD" | "MESH"; /** * The Model API is a specification that describes the inputs and outputs of a machine learning model. It is used to define the interface for the model, including the types of data that can be passed to it and the types of data that it will return. * * Log Safety: UNSAFE */ declare interface ModelApi { inputs: Array; outputs: Array; } /** * Log Safety: SAFE */ declare interface ModelApiAnyType { } /** * Log Safety: UNSAFE */ declare interface ModelApiArrayType { itemType: ModelApiDataType; } /** * Log Safety: UNSAFE */ declare interface ModelApiColumn { name: string; required?: boolean; dataType: ModelApiDataType; } /** * Log Safety: UNSAFE */ declare type ModelApiDataType = ({ type: "date"; } & _Core.DateType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "unsupported"; } & _Core.UnsupportedType) | ({ type: "string"; } & _Core.StringType) | ({ type: "array"; } & ModelApiArrayType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "float"; } & _Core.FloatType) | ({ type: "any"; } & ModelApiAnyType) | ({ type: "map"; } & ModelApiMapType) | ({ type: "long"; } & _Core.LongType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * Log Safety: UNSAFE */ declare type ModelApiInput = ({ type: "unsupported"; } & _Core.UnsupportedType) | ({ type: "parameter"; } & ModelApiParameterType) | ({ type: "tabular"; } & ModelApiTabularType); /** * Log Safety: UNSAFE */ declare interface ModelApiMapType { keyType: ModelApiDataType; valueType: ModelApiDataType; } /** * Log Safety: UNSAFE */ declare type ModelApiOutput = ({ type: "unsupported"; } & _Core.UnsupportedType) | ({ type: "parameter"; } & ModelApiParameterType) | ({ type: "tabular"; } & ModelApiTabularType); /** * Log Safety: UNSAFE */ declare interface ModelApiParameterType { name: string; required?: boolean; dataType: ModelApiDataType; } /** * Log Safety: SAFE */ declare type ModelApiTabularFormat = "PANDAS" | "SPARK"; /** * Log Safety: UNSAFE */ declare interface ModelApiTabularType { name: string; required?: boolean; columns: Array; format?: ModelApiTabularFormat; } /** * The model API contains a data type that is not supported for Ontology function creation. * * Log Safety: UNSAFE */ declare interface ModelApiTypeUnsupportedForFunction { errorCode: "INVALID_ARGUMENT"; errorName: "ModelApiTypeUnsupportedForFunction"; errorDescription: "The model API contains a data type that is not supported for Ontology function creation."; errorInstanceId: string; parameters: { fieldName: unknown; unsupportedType: unknown; }; } /** * A model definition, either a record or a union. * * Log Safety: UNSAFE */ declare type ModelDef = ({ type: "record"; } & RecordDef) | ({ type: "union"; } & UnionDef); /** * The requested experiment was not found or the user lacks permission to access it. * * Log Safety: SAFE */ declare interface ModelExperimentNotFound { errorCode: "NOT_FOUND"; errorName: "ModelExperimentNotFound"; errorDescription: "The requested experiment was not found or the user lacks permission to access it."; errorInstanceId: string; parameters: { modelRid: unknown; experimentRid: unknown; }; } /** * The serialized data of a machine learning model. This can include the model's parameters, architecture, and any other relevant information needed to reconstruct the model. Must be a base64-encoded string of a dill-serialized model function. * * Log Safety: UNSAFE */ declare type ModelFiles = { type: "dill"; } & DillModelFiles; /** * Log Safety: UNSAFE */ declare interface ModelFunction { functionRid: ModelFunctionFunctionRid; functionVersion: ModelFunctionFunctionVersion; displayName: ModelFunctionDisplayName; apiName: ModelFunctionApiName; isRowWise: ModelFunctionIsRowWise; ontologyBinding?: _Ontologies.OntologyRid; } /** * Log Safety: UNSAFE */ declare type ModelFunctionApiName = LooselyBrandedString_15<"ModelFunctionApiName">; /** * Log Safety: UNSAFE */ declare type ModelFunctionDisplayName = LooselyBrandedString_15<"ModelFunctionDisplayName">; /** * Log Safety: SAFE */ declare type ModelFunctionFunctionRid = LooselyBrandedString_15<"ModelFunctionFunctionRid">; /** * Log Safety: UNSAFE */ declare type ModelFunctionFunctionVersion = LooselyBrandedString_15<"ModelFunctionFunctionVersion">; /** * Log Safety: SAFE */ declare type ModelFunctionIsRowWise = boolean; /** * The given ModelFunction could not be found. * * Log Safety: SAFE */ declare interface ModelFunctionNotFound { errorCode: "NOT_FOUND"; errorName: "ModelFunctionNotFound"; errorDescription: "The given ModelFunction could not be found."; errorInstanceId: string; parameters: { modelRid: unknown; }; } export declare namespace ModelFunctions { export { } } /** * Log Safety: UNSAFE */ declare type ModelName = LooselyBrandedString_15<"ModelName">; /** * The given Model could not be found. * * Log Safety: SAFE */ declare interface ModelNotFound { errorCode: "NOT_FOUND"; errorName: "ModelNotFound"; errorDescription: "The given Model could not be found."; errorInstanceId: string; parameters: { modelRid: unknown; }; } /** * Model output configuration. * * Log Safety: SAFE */ declare interface ModelOutput { modelRid: ModelRid; } /** * The purpose for which a language model is configured on an Agent. * * Log Safety: SAFE */ declare type ModelPurpose = "PRIMARY_AGENT" | "QUESTION_SUGGESTER"; /** * The Resource Identifier (RID) of a Model. * * Log Safety: SAFE */ declare type ModelRid = LooselyBrandedString_15<"ModelRid">; export declare namespace Models { export { BooleanParameter, BooleanType_2 as BooleanType, ChangelogTooLongError, ColumnName_4 as ColumnName, ColumnTypeSpecId, CreateConfigValidationFailureReason, CreateLiveDeploymentRequest, CreateLiveDeploymentTarget, CreateModelFunctionRequest, CreateModelRequest, CreateModelStudioConfigVersionRequest, CreateModelStudioRequest, CreateModelVersionRequest, DatasetInput, DatasetRid_4 as DatasetRid, DatasetSchemaNotFoundError, DatetimeParameter, DateType_2 as DateType, DillModelFiles, DirectCreateLiveDeploymentTarget, DoubleParameter, DoubleSeriesAggregations, DoubleSeriesV1, DoubleSeriesValueV1, DoubleType_2 as DoubleType, Duration_3 as Duration, EpochMillis, Experiment, ExperimentArtifactDetails, ExperimentArtifactMetadata, ExperimentArtifactName, ExperimentArtifactTable, ExperimentAuthoringSource, ExperimentCodeWorkspaceSource, ExperimentRid, ExperimentSdkSource, ExperimentSeries, ExperimentSource, ExperimentStatus, ExperimentTagText, FieldValidationError, FloatType_2 as FloatType, GpuType, InconsistentArrayDimensionsError, InferenceInputErrorType, InputAlias, IntegerParameter, IntegerType_2 as IntegerType, InvalidArrayShapeError, InvalidMapFormatError, InvalidResourceConfigurationError, InvalidTabularFormatError, InvalidWorkerConfigInputTypeError, JsonSchemaValidationError, ListLiveDeploymentsResponse, ListModelStudioConfigVersionsResponse, ListModelStudioRunsResponse, ListModelStudioTrainersResponse, ListModelVersionsResponse, LiveDeployment, LiveDeploymentGpu, LiveDeploymentModelVersion, LiveDeploymentRid, LiveDeploymentRuntimeConfiguration, LiveDeploymentScalingConfiguration, LiveDeploymentState, LiveDeploymentStatus, LongType_2 as LongType, MissingRequiredDatasetColumnError, MissingWorkerConfigInputDatasetColumnMappingError, MissingWorkerConfigInputError, MissingWorkerConfigInputObjectSetPropertyMappingError, MissingWorkerConfigOutputError, Model, ModelApi, ModelApiAnyType, ModelApiArrayType, ModelApiColumn, ModelApiDataType, ModelApiInput, ModelApiMapType, ModelApiOutput, ModelApiParameterType, ModelApiTabularFormat, ModelApiTabularType, ModelFiles, ModelFunction, ModelFunctionApiName, ModelFunctionDisplayName, ModelFunctionFunctionRid, ModelFunctionFunctionVersion, ModelFunctionIsRowWise, ModelName, ModelOutput, ModelRid, ModelStudio, ModelStudioConfigRid, ModelStudioConfigVersion, ModelStudioConfigVersionName, ModelStudioConfigVersionNumber, ModelStudioInput, ModelStudioOutput, ModelStudioRid, ModelStudioRun, ModelStudioRunBuildRid, ModelStudioRunJobRid, ModelStudioRunModelOutput, ModelStudioRunOutput, ModelStudioTrainer, ModelStudioTrainerExperimental, ModelStudioWorkerConfig, ModelVersion, ModelVersionCodeRepositorySource, ModelVersionCodeWorkspaceSource, ModelVersionContainerizedSource, ModelVersionExternalSource, ModelVersionModelStudioSource, ModelVersionPromotedSource, ModelVersionRid, ModelVersionSdkSource, ModelVersionSource, MultipleColumnsNotAllowedForTrainerError, MultiplePropertiesNotAllowedForTrainerError, OntologyRid_2 as OntologyRid, OtherValidationError, OutputAlias, OutputResourceInDifferentProjectError, OutputResourceNotFoundError, Parameter_4 as Parameter, ParameterName, ParameterValue_2 as ParameterValue, PromoteVersionModelRequest, ReplaceLiveDeploymentRequest, ReplaceModelFunctionRequest, RequiredValueMissingError, ResourceConfiguration, RunId, SearchExperimentsAndFilter, SearchExperimentsContainsFilter, SearchExperimentsContainsFilterField, SearchExperimentsEqualsFilter, SearchExperimentsEqualsFilterField, SearchExperimentsFilter, SearchExperimentsNotFilter, SearchExperimentsNumericFilterOperator, SearchExperimentsOrderBy, SearchExperimentsOrderByField, SearchExperimentsOrFilter, SearchExperimentsParameterFilter, SearchExperimentsParameterFilterOperator, SearchExperimentsRequest, SearchExperimentsResponse, SearchExperimentsSeriesFilter, SearchExperimentsSeriesFilterField, SearchExperimentsStartsWithFilter, SearchExperimentsStartsWithFilterField, SearchExperimentsSummaryMetricFilter, Series, SeriesAggregations, SeriesAggregationsValue, SeriesName, StringParameter_2 as StringParameter, StringType_2 as StringType, SummaryMetric, SummaryMetricAggregation, TableArtifactDetails, TimestampType_2 as TimestampType, TrainerDescription, TrainerId, TrainerInputsSpecification, TrainerName, TrainerOutputsSpecification, TrainerSchemaDefinition, TrainerType, TrainerVersion, TrainerVersionLocator, TransformJsonLiveDeploymentRequest, TransformLiveDeploymentResponse, TypeMismatchError, UnknownColumnSpecIdInConfigColumnMappingError, UnknownInputNameError, UnsupportedDatasetFieldTypeError, UnsupportedType_2 as UnsupportedType, UnsupportedTypeError, UnsupportedTypeParamValue_2 as UnsupportedTypeParamValue, CondaSolveFailureForProvidedPackages, CreateConfigValidationError, CreateLiveDeploymentPermissionDenied, CreateModelFunctionPermissionDenied, CreateModelPermissionDenied, CreateModelStudioConfigVersionPermissionDenied, CreateModelStudioPermissionDenied, CreateModelVersionPermissionDenied, ExperimentArtifactNotFound, ExperimentNotFound, ExperimentSeriesNotFound, FunctionAlreadyExists, GpuTypeNotAvailable, InferenceFailure, InferenceInvalidInput, InferenceTimeout, InvalidExperimentSearchFilter, InvalidFunctionApiName, InvalidGpuCount, InvalidModelApi, InvalidModelStudioCreateRequest, JsonExperimentArtifactTablePermissionDenied, JsonExperimentSeriesPermissionDenied, LatestModelStudioConfigVersionsPermissionDenied, LaunchModelStudioPermissionDenied, LiveDeploymentNotFound, ModelApiTypeUnsupportedForFunction, ModelExperimentNotFound, ModelFunctionNotFound, ModelNotFound, ModelStudioConfigVersionNotFound, ModelStudioNotFound, ModelStudioTrainerNotFound, ModelVersionNotFound, OntologyBindingRequired, OntologyNotFound_2 as OntologyNotFound, ParquetExperimentArtifactTablePermissionDenied, ParquetExperimentSeriesPermissionDenied, PromoteVersionModelPermissionDenied, ReplaceLiveDeploymentPermissionDenied, ReplaceModelFunctionPermissionDenied, SearchExperimentsPermissionDenied, ThreadCountTooHigh, TrainerNotFound, TransformJsonLiveDeploymentPermissionDenied, UnsupportedLiveDeployment, UnsupportedModelSource, Experiments, ArtifactTables, ExperimentSeriesList, LiveDeployments, Models_2 as Models, ModelFunctions, ModelStudios, ModelStudioConfigVersions, ModelStudioRuns, ModelStudioTrainers, ModelVersions } } declare namespace _Models { export { LooselyBrandedString_15 as LooselyBrandedString, BooleanParameter, BooleanType_2 as BooleanType, ChangelogTooLongError, ColumnName_4 as ColumnName, ColumnTypeSpecId, CreateConfigValidationFailureReason, CreateLiveDeploymentRequest, CreateLiveDeploymentTarget, CreateModelFunctionRequest, CreateModelRequest, CreateModelStudioConfigVersionRequest, CreateModelStudioRequest, CreateModelVersionRequest, DatasetInput, DatasetRid_4 as DatasetRid, DatasetSchemaNotFoundError, DatetimeParameter, DateType_2 as DateType, DillModelFiles, DirectCreateLiveDeploymentTarget, DoubleParameter, DoubleSeriesAggregations, DoubleSeriesV1, DoubleSeriesValueV1, DoubleType_2 as DoubleType, Duration_3 as Duration, EpochMillis, Experiment, ExperimentArtifactDetails, ExperimentArtifactMetadata, ExperimentArtifactName, ExperimentArtifactTable, ExperimentAuthoringSource, ExperimentCodeWorkspaceSource, ExperimentRid, ExperimentSdkSource, ExperimentSeries, ExperimentSource, ExperimentStatus, ExperimentTagText, FieldValidationError, FloatType_2 as FloatType, GpuType, InconsistentArrayDimensionsError, InferenceInputErrorType, InputAlias, IntegerParameter, IntegerType_2 as IntegerType, InvalidArrayShapeError, InvalidMapFormatError, InvalidResourceConfigurationError, InvalidTabularFormatError, InvalidWorkerConfigInputTypeError, JsonSchemaValidationError, ListLiveDeploymentsResponse, ListModelStudioConfigVersionsResponse, ListModelStudioRunsResponse, ListModelStudioTrainersResponse, ListModelVersionsResponse, LiveDeployment, LiveDeploymentGpu, LiveDeploymentModelVersion, LiveDeploymentRid, LiveDeploymentRuntimeConfiguration, LiveDeploymentScalingConfiguration, LiveDeploymentState, LiveDeploymentStatus, LongType_2 as LongType, MissingRequiredDatasetColumnError, MissingWorkerConfigInputDatasetColumnMappingError, MissingWorkerConfigInputError, MissingWorkerConfigInputObjectSetPropertyMappingError, MissingWorkerConfigOutputError, Model, ModelApi, ModelApiAnyType, ModelApiArrayType, ModelApiColumn, ModelApiDataType, ModelApiInput, ModelApiMapType, ModelApiOutput, ModelApiParameterType, ModelApiTabularFormat, ModelApiTabularType, ModelFiles, ModelFunction, ModelFunctionApiName, ModelFunctionDisplayName, ModelFunctionFunctionRid, ModelFunctionFunctionVersion, ModelFunctionIsRowWise, ModelName, ModelOutput, ModelRid, ModelStudio, ModelStudioConfigRid, ModelStudioConfigVersion, ModelStudioConfigVersionName, ModelStudioConfigVersionNumber, ModelStudioInput, ModelStudioOutput, ModelStudioRid, ModelStudioRun, ModelStudioRunBuildRid, ModelStudioRunJobRid, ModelStudioRunModelOutput, ModelStudioRunOutput, ModelStudioTrainer, ModelStudioTrainerExperimental, ModelStudioWorkerConfig, ModelVersion, ModelVersionCodeRepositorySource, ModelVersionCodeWorkspaceSource, ModelVersionContainerizedSource, ModelVersionExternalSource, ModelVersionModelStudioSource, ModelVersionPromotedSource, ModelVersionRid, ModelVersionSdkSource, ModelVersionSource, MultipleColumnsNotAllowedForTrainerError, MultiplePropertiesNotAllowedForTrainerError, OntologyRid_2 as OntologyRid, OtherValidationError, OutputAlias, OutputResourceInDifferentProjectError, OutputResourceNotFoundError, Parameter_4 as Parameter, ParameterName, ParameterValue_2 as ParameterValue, PromoteVersionModelRequest, ReplaceLiveDeploymentRequest, ReplaceModelFunctionRequest, RequiredValueMissingError, ResourceConfiguration, RunId, SearchExperimentsAndFilter, SearchExperimentsContainsFilter, SearchExperimentsContainsFilterField, SearchExperimentsEqualsFilter, SearchExperimentsEqualsFilterField, SearchExperimentsFilter, SearchExperimentsNotFilter, SearchExperimentsNumericFilterOperator, SearchExperimentsOrderBy, SearchExperimentsOrderByField, SearchExperimentsOrFilter, SearchExperimentsParameterFilter, SearchExperimentsParameterFilterOperator, SearchExperimentsRequest, SearchExperimentsResponse, SearchExperimentsSeriesFilter, SearchExperimentsSeriesFilterField, SearchExperimentsStartsWithFilter, SearchExperimentsStartsWithFilterField, SearchExperimentsSummaryMetricFilter, Series, SeriesAggregations, SeriesAggregationsValue, SeriesName, StringParameter_2 as StringParameter, StringType_2 as StringType, SummaryMetric, SummaryMetricAggregation, TableArtifactDetails, TimestampType_2 as TimestampType, TrainerDescription, TrainerId, TrainerInputsSpecification, TrainerName, TrainerOutputsSpecification, TrainerSchemaDefinition, TrainerType, TrainerVersion, TrainerVersionLocator, TransformJsonLiveDeploymentRequest, TransformLiveDeploymentResponse, TypeMismatchError, UnknownColumnSpecIdInConfigColumnMappingError, UnknownInputNameError, UnsupportedDatasetFieldTypeError, UnsupportedType_2 as UnsupportedType, UnsupportedTypeError, UnsupportedTypeParamValue_2 as UnsupportedTypeParamValue } } export declare namespace Models_2 { export { } } /** * Log Safety: SAFE */ declare interface ModelStudio { rid: ModelStudioRid; folderRid: _Filesystem.FolderRid; createdTime: _Core.CreatedTime; } /** * The Resource Identifier (RID) of a Model Studio Configuration. * * Log Safety: SAFE */ declare type ModelStudioConfigRid = LooselyBrandedString_15<"ModelStudioConfigRid">; /** * Log Safety: UNSAFE */ declare interface ModelStudioConfigVersion { name: ModelStudioConfigVersionName; version: ModelStudioConfigVersionNumber; trainerId: TrainerId; trainer: TrainerVersionLocator; workerConfig: ModelStudioWorkerConfig; resources: ResourceConfiguration; changelog?: string; createdBy: _Core.CreatedBy; createdTime: _Core.CreatedTime; } /** * Human readable name of the configuration version and experiment. * * Log Safety: UNSAFE */ declare type ModelStudioConfigVersionName = LooselyBrandedString_15<"ModelStudioConfigVersionName">; /** * The requested Model Studio configuration version was not found. * * Log Safety: SAFE */ declare interface ModelStudioConfigVersionNotFound { errorCode: "NOT_FOUND"; errorName: "ModelStudioConfigVersionNotFound"; errorDescription: "The requested Model Studio configuration version was not found."; errorInstanceId: string; parameters: { studioRid: unknown; configVersion: unknown; }; } /** * The version number of a Model Studio Configuration. * * Log Safety: SAFE */ declare type ModelStudioConfigVersionNumber = number; export declare namespace ModelStudioConfigVersions { export { } } /** * Input specification for a Model Studio configuration. * * Log Safety: UNSAFE */ declare type ModelStudioInput = { type: "dataset"; } & DatasetInput; /** * The requested Model Studio was not found. * * Log Safety: SAFE */ declare interface ModelStudioNotFound { errorCode: "NOT_FOUND"; errorName: "ModelStudioNotFound"; errorDescription: "The requested Model Studio was not found."; errorInstanceId: string; parameters: { studioRid: unknown; }; } /** * Output specification for a Model Studio configuration. * * Log Safety: SAFE */ declare type ModelStudioOutput = { type: "model"; } & ModelOutput; /** * The Resource Identifier (RID) of a Model Studio. * * Log Safety: SAFE */ declare type ModelStudioRid = LooselyBrandedString_15<"ModelStudioRid">; /** * Log Safety: UNSAFE */ declare interface ModelStudioRun { runId: RunId; buildRid: ModelStudioRunBuildRid; jobRid: ModelStudioRunJobRid; configVersion: ModelStudioConfigVersionNumber; startedBy: _Core.CreatedBy; startedTime: _Core.CreatedTime; buildStatus?: _Orchestration.BuildStatus; resolvedOutputs: Record; } /** * The RID of the build associated with this run. * * Log Safety: SAFE */ declare type ModelStudioRunBuildRid = LooselyBrandedString_15<"ModelStudioRunBuildRid">; /** * The RID of the job associated with this run. * * Log Safety: SAFE */ declare type ModelStudioRunJobRid = LooselyBrandedString_15<"ModelStudioRunJobRid">; /** * Resolved model output details for a Model Studio run. * * Log Safety: SAFE */ declare interface ModelStudioRunModelOutput { modelRid: ModelRid; modelVersionRid: ModelVersionRid; experimentRid?: ExperimentRid; } /** * Resolved output details for a Model Studio run. * * Log Safety: SAFE */ declare type ModelStudioRunOutput = { type: "model"; } & ModelStudioRunModelOutput; export declare namespace ModelStudioRuns { export { } } export declare namespace ModelStudios { export { } } /** * Log Safety: UNSAFE */ declare interface ModelStudioTrainer { trainerId: TrainerId; version: TrainerVersion; name: TrainerName; type: TrainerType; description: TrainerDescription; customConfigSchema: TrainerSchemaDefinition; inputs: TrainerInputsSpecification; outputs: TrainerOutputsSpecification; experimental: ModelStudioTrainerExperimental; } /** * Whether this trainer is experimental and may have breaking changes. * * Log Safety: SAFE */ declare type ModelStudioTrainerExperimental = boolean; /** * The given ModelStudioTrainer could not be found. * * Log Safety: SAFE */ declare interface ModelStudioTrainerNotFound { errorCode: "NOT_FOUND"; errorName: "ModelStudioTrainerNotFound"; errorDescription: "The given ModelStudioTrainer could not be found."; errorInstanceId: string; parameters: { modelStudioTrainerTrainerId: unknown; }; } export declare namespace ModelStudioTrainers { export { } } /** * Configuration for the Model Studio worker. * * Log Safety: UNSAFE */ declare interface ModelStudioWorkerConfig { customConfig?: Record; inputs: Record; outputs: Record; } /** * A key identifying a model type within the schema. * * Log Safety: UNSAFE */ declare type ModelTypeKey = LooselyBrandedString_19<"ModelTypeKey">; /** * Log Safety: UNSAFE */ declare interface ModelVersion { rid: ModelVersionRid; modelApi: ModelApi; condaRequirements: Array; backingRepositories: Array; createdTime: _Core.CreatedTime; source?: ModelVersionSource; linkedExperiment?: ExperimentRid; } /** * Model version created from a code repository. * * Log Safety: UNSAFE */ declare interface ModelVersionCodeRepositorySource { repositoryRid: string; branch: string; } /** * Model version created from a code workspace. * * Log Safety: UNSAFE */ declare interface ModelVersionCodeWorkspaceSource { codeWorkspaceRid: string; branch: string; } /** * Model version imported from a containerized model. * * Log Safety: SAFE */ declare interface ModelVersionContainerizedSource { } /** * Model version backed by an external model. * * Log Safety: SAFE */ declare interface ModelVersionExternalSource { } /** * Model version created from Model Studio. * * Log Safety: SAFE */ declare interface ModelVersionModelStudioSource { modelStudioRid: string; } /** * The given ModelVersion could not be found. * * Log Safety: SAFE */ declare interface ModelVersionNotFound { errorCode: "NOT_FOUND"; errorName: "ModelVersionNotFound"; errorDescription: "The given ModelVersion could not be found."; errorInstanceId: string; parameters: { modelRid: unknown; modelVersionRid: unknown; }; } /** * Model version promoted from another model version. * * Log Safety: SAFE */ declare interface ModelVersionPromotedSource { previousModelRid: ModelRid; previousModelVersionRid: ModelVersionRid; } /** * The Resource Identifier (RID) of a Model Version. * * Log Safety: SAFE */ declare type ModelVersionRid = LooselyBrandedString_15<"ModelVersionRid">; export declare namespace ModelVersions { export { } } /** * Model version created via the SDK. * * Log Safety: SAFE */ declare interface ModelVersionSdkSource { } /** * The source from which this model version was created. * * Log Safety: UNSAFE */ declare type ModelVersionSource = ({ type: "importedContainerizedModel"; } & ModelVersionContainerizedSource) | ({ type: "external"; } & ModelVersionExternalSource) | ({ type: "codeWorkspace"; } & ModelVersionCodeWorkspaceSource) | ({ type: "modelStudio"; } & ModelVersionModelStudioSource) | ({ type: "codeRepository"; } & ModelVersionCodeRepositorySource) | ({ type: "sdk"; } & ModelVersionSdkSource) | ({ type: "promoted"; } & ModelVersionPromotedSource); /** * Log Safety: UNSAFE */ declare interface ModifyEdit { includesAllPreviousValues?: boolean; previousProperties: Record; properties: Record; } /** * Changing the type of a check after it has been created is not supported. * * Log Safety: SAFE */ declare interface ModifyingCheckTypeNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "ModifyingCheckTypeNotSupported"; errorDescription: "Changing the type of a check after it has been created is not supported."; errorInstanceId: string; parameters: { originalCheckType: unknown; newCheckType: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ModifyInterfaceLogicRule { interfaceObjectToModify: ParameterId_2; sharedPropertyArguments: Record; structPropertyArguments: Record>; } /** * Log Safety: UNSAFE */ declare interface ModifyInterfaceObjectRule { interfaceTypeApiName: InterfaceTypeApiName; } /** * Log Safety: UNSAFE */ declare interface ModifyObject { primaryKey: PropertyValue_2; objectType: ObjectTypeApiName; } /** * Log Safety: UNSAFE */ declare interface ModifyObjectEdit { objectType: ObjectTypeApiName; primaryKey: PropertyValue_2; properties: Record; } /** * Log Safety: UNSAFE */ declare interface ModifyObjectLogicRule { objectToModify: ParameterId_2; propertyArguments: Record; structPropertyArguments: Record>; } /** * Log Safety: UNSAFE */ declare interface ModifyObjectRule { objectTypeApiName: ObjectTypeApiName; } /** * MOV (QuickTime) video container format. * * Log Safety: SAFE */ declare interface MovVideoContainerFormat { } /** * MP3 audio format. * * Log Safety: SAFE */ declare interface Mp3Format { } /** * MP4 video container format. * * Log Safety: SAFE */ declare interface Mp4VideoContainerFormat { } /** * Log Safety: UNSAFE */ declare interface MultiLineString { coordinates: Array; bbox?: BBox; } /** * Multiple columns were mapped but the trainer only allows a single column for this spec. * * Log Safety: UNSAFE */ declare interface MultipleColumnsNotAllowedForTrainerError { datasetRid: _Core.DatasetRid; columnTypeSpecId: ColumnTypeSpecId; } /** * Aggregation cannot group by on the same field multiple times. * * Log Safety: UNSAFE */ declare interface MultipleGroupByOnFieldNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "MultipleGroupByOnFieldNotSupported"; errorDescription: "Aggregation cannot group by on the same field multiple times."; errorInstanceId: string; parameters: { duplicateFields: unknown; }; } /** * The media reference property has multiple media set views marked as upload destinations. At most one media source per property should be configured as the upload destination. This typically indicates an inconsistent object type configuration; review the backing media sources for this property in Ontology Manager. * * Log Safety: UNSAFE */ declare interface MultipleMediaUploadDestinations { errorCode: "INVALID_ARGUMENT"; errorName: "MultipleMediaUploadDestinations"; errorDescription: "The media reference property has multiple media set views marked as upload destinations. At most one media source per property should be configured as the upload destination. This typically indicates an inconsistent object type configuration; review the backing media sources for this property in Ontology Manager."; errorInstanceId: string; parameters: { objectType: unknown; property: unknown; }; } /** * Multiple properties were mapped but the trainer only allows a single property for this spec. * * Log Safety: UNSAFE */ declare interface MultiplePropertiesNotAllowedForTrainerError { objectSetRid: string; propertyTypeSpecId: string; } /** * One of the requested property filters does not support multiple values. Please include only a single value for it. * * Log Safety: UNSAFE */ declare interface MultiplePropertyValuesNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "MultiplePropertyValuesNotSupported"; errorDescription: "One of the requested property filters does not support multiple values. Please include only a single value for it."; errorInstanceId: string; parameters: { propertyFilter: unknown; property: unknown; }; } /** * Multiple system prompts are not currently supported, but will be in the future. * * Log Safety: SAFE */ declare interface MultipleSystemPromptsNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "MultipleSystemPromptsNotSupported"; errorDescription: "Multiple system prompts are not currently supported, but will be in the future."; errorInstanceId: string; parameters: { systemPromptSize: unknown; }; } /** * Multiple tool result contents are not currently supported, but will be in the future. * * Log Safety: SAFE */ declare interface MultipleToolResultContentsNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "MultipleToolResultContentsNotSupported"; errorDescription: "Multiple tool result contents are not currently supported, but will be in the future."; errorInstanceId: string; parameters: { toolResultContentsSize: unknown; }; } /** * Multiplies two or more numeric values. * * Log Safety: UNSAFE */ declare interface MultiplyPropertyExpression { properties: Array; } /** * Log Safety: UNSAFE */ declare interface MultiPoint { coordinates: Array; bbox?: BBox; } /** * Log Safety: UNSAFE */ declare interface MultiPolygon { coordinates: Array>; bbox?: BBox; } /** * The parameter must be omitted or empty. * * Log Safety: SAFE */ declare interface MustBeEmptyAllowedValues { } /** * A named mapping of parameter names to values. * * Log Safety: UNSAFE */ declare interface NamedParameterMapping { mapping: ParameterMapping; } /** * Identifier of the namespace associated with a checkpoint. * * Log Safety: SAFE */ declare type NamespaceRid = LooselyBrandedString_11<"NamespaceRid">; /** * Identifier for a namespace. * * Log Safety: SAFE */ declare type NamespaceRid_2 = LooselyBrandedString_19<"NamespaceRid">; /** * Queries support either a vector matching the embedding model defined on the property, or text that is automatically embedded. * * Log Safety: UNSAFE */ declare type NearestNeighborsQuery = ({ type: "vector"; } & DoubleVector) | ({ type: "text"; } & NearestNeighborsQueryText); /** * Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier. * * Log Safety: UNSAFE */ declare interface NearestNeighborsQueryText { value: string; } /** * Negates a numeric value. * * Log Safety: UNSAFE */ declare interface NegatePropertyExpression { property: DerivedPropertyDefinition; } /** * Describes how an object type implements an interface property when a reducer is applied to it. Is missing a reduced property implementation to prevent arbitrarily nested implementations. * * Log Safety: UNSAFE */ declare type NestedInterfacePropertyTypeImplementation = ({ type: "structFieldImplementation"; } & InterfacePropertyStructFieldImplementation) | ({ type: "structImplementation"; } & InterfacePropertyStructImplementation) | ({ type: "localPropertyImplementation"; } & InterfacePropertyLocalPropertyImplementation); /** * Log Safety: UNSAFE */ declare interface NestedQueryAggregation { key: any; groups: Array; } /** * The Resource Identifier (RID) of a Network Egress Policy. * * Log Safety: SAFE */ declare type NetworkEgressPolicyRid = LooselyBrandedString<"NetworkEgressPolicyRid">; /** * Trigger whenever a new JobSpec is put on the dataset and on that branch. * * Log Safety: UNSAFE */ declare interface NewLogicTrigger { branchName: _Core.BranchName; datasetRid: _Core.DatasetRid; } /** * Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an explicit per-property load level (via PropertyWithLoadLevelSelector) to opt a property out of a defaultLoadLevel. * * Log Safety: SAFE */ declare interface NoLoadLevel { } /** * Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use. * * Log Safety: SAFE */ declare interface NoPublishedAgentVersion { errorCode: "INVALID_ARGUMENT"; errorName: "NoPublishedAgentVersion"; errorDescription: "Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Chatbot Studio to use the latest published version, or specify the version of the Agent to use."; errorInstanceId: string; parameters: { agentRid: unknown; }; } /** * Not all columns in the View's primary key are present in the dataset(s). * * Log Safety: UNSAFE */ declare interface NotAllColumnsInPrimaryKeyArePresent { errorCode: "INVALID_ARGUMENT"; errorName: "NotAllColumnsInPrimaryKeyArePresent"; errorDescription: "Not all columns in the View's primary key are present in the dataset(s)."; errorInstanceId: string; parameters: { primaryKeyColumns: unknown; missingColumns: unknown; }; } /** * The user is not authorized to apply at least one of the organization markings required to create the project from template. * * Log Safety: SAFE */ declare interface NotAuthorizedToApplyOrganization { errorCode: "INVALID_ARGUMENT"; errorName: "NotAuthorizedToApplyOrganization"; errorDescription: "The user is not authorized to apply at least one of the organization markings required to create the project from template."; errorInstanceId: string; parameters: { organizationRids: unknown; }; } /** * The caller does not have DECLASSIFY permission on these markings or the markings do not exist. * * Log Safety: UNSAFE */ declare interface NotAuthorizedToDeclassifyMarkings { errorCode: "PERMISSION_DENIED"; errorName: "NotAuthorizedToDeclassifyMarkings"; errorDescription: "The caller does not have DECLASSIFY permission on these markings or the markings do not exist."; errorInstanceId: string; parameters: { markingIds: unknown; }; } /** * The value intended for decryption with Cipher is not formatted correctly. It may already be a plaintext value and not require decryption. Ensure it is correctly formatted (CIPHERCIPHER). * * Log Safety: UNSAFE */ declare interface NotCipherFormatted { errorCode: "INVALID_ARGUMENT"; errorName: "NotCipherFormatted"; errorDescription: "The value intended for decryption with Cipher is not formatted correctly. It may already be a plaintext value and not require decryption. Ensure it is correctly formatted (CIPHERCIPHER)."; errorInstanceId: string; parameters: { value: unknown; }; } export declare namespace Notepad { export { CreateExportJobRequest, Document_2 as Document, DocumentRid, ExportJob, ExportJobDocumentSource, ExportJobFailed, ExportJobGenerationJobSource, ExportJobPdfTarget, ExportJobRid, ExportJobRunning, ExportJobSource, ExportJobStatus, ExportJobSucceeded, ExportJobTarget, File_3 as File, FileRid, GenerateTemplateRequest, GenerationJob, GenerationJobFailed, GenerationJobRid, GenerationJobRunning, GenerationJobStatus, GenerationJobSucceeded, SaveDocumentGenerationJobRequest, SaveDocumentResponse, Template, TemplateParameterDateTimeValue, TemplateParameterDateValue, TemplateParameterDoubleValue, TemplateParameterName, TemplateParameterObjectRidValue, TemplateParameterObjectSetRidValue, TemplateParameterStringValue, TemplateParameterValue, TemplateRid, TemplateVersion, ContentFilePermissionDenied, CreateDocumentPermissionDenied, CreateExportJobPermissionDenied, DocumentNotFound, ExportDocumentPermissionDenied, ExportGenerationJobPermissionDenied, ExportJobNotFound, FileNotFound_2 as FileNotFound, GenerateTemplatePermissionDenied, GenerationJobNotFound, GenerationJobStatusFailed, GenerationJobStatusRunning, InvalidExportJobUserLocale, InvalidGenerationJobTemplateParameter, InvalidGenerationJobTemplateVersion, InvalidTimezone, MissingGenerationJobTemplateParameters, SaveDocumentGenerationJobPermissionDenied, TemplateNotFound, ExportJobs, Files_2 as Files, GenerationJobs, Templates } } declare namespace _Notepad { export { LooselyBrandedString_17 as LooselyBrandedString, CreateExportJobRequest, Document_2 as Document, DocumentRid, ExportJob, ExportJobDocumentSource, ExportJobFailed, ExportJobGenerationJobSource, ExportJobPdfTarget, ExportJobRid, ExportJobRunning, ExportJobSource, ExportJobStatus, ExportJobSucceeded, ExportJobTarget, File_3 as File, FileRid, GenerateTemplateRequest, GenerationJob, GenerationJobFailed, GenerationJobRid, GenerationJobRunning, GenerationJobStatus, GenerationJobSucceeded, SaveDocumentGenerationJobRequest, SaveDocumentResponse, Template, TemplateParameterDateTimeValue, TemplateParameterDateValue, TemplateParameterDoubleValue, TemplateParameterName, TemplateParameterObjectRidValue, TemplateParameterObjectSetRidValue, TemplateParameterStringValue, TemplateParameterValue, TemplateRid, TemplateVersion } } /** * Whether to receive a notification at the end of the build. The notification will be sent to the user that has most recently edited the schedule. No notification will be sent if the schedule has scopeMode set to ProjectScope. * * Log Safety: SAFE */ declare type NotificationsEnabled = boolean; /** * Returns objects where the query is not satisfied. * * Log Safety: UNSAFE */ declare interface NotQuery { value: SearchJsonQuery; } /** * @deprecated Use `NotQueryV2` in the `foundry.ontologies` package * * Returns objects where the query is not satisfied. * * Log Safety: UNSAFE */ declare interface NotQueryV2 { value: SearchJsonQueryV2; } /** * Returns objects where the query is not satisfied. * * Log Safety: UNSAFE */ declare interface NotQueryV2_2 { value: SearchJsonQueryV2_2; } /** * Writes are not part of a transaction and are immediately visible. Calls to create transaction or commit transaction will error. * * Log Safety: SAFE */ declare interface NoTransactionsTransactionPolicy { } /** * The current evaluation time itself. Carries no fields. * * Log Safety: SAFE */ declare interface NowDatetimeValue { } /** * Log Safety: SAFE */ declare interface NullableConstraint { value: NullableConstraintValue; } /** * Log Safety: SAFE */ declare type NullableConstraintValue = "NULLABLE" | "NOT_NULLABLE"; /** * Checks the percentage of null values in a specific column. * * Log Safety: UNSAFE */ declare interface NullPercentageCheckConfig { subject: DatasetSubject; percentageCheckConfig: PercentageCheckConfig; } /** * Log Safety: SAFE */ declare interface NullType { } /** * Attach arbitrary text before and/or after the formatted number. Example: prefix "USD " and postfix " total" displays as "USD 1,234.56 total" * * Log Safety: UNSAFE */ declare interface NumberFormatAffix { baseFormatOptions: NumberFormatOptions; affix: Affix; } /** * Display the value as basis points. Multiplies by 10,000 and appends "bps" suffix. Used in finance where 1 basis point = 0.01%. Example: 0.0025 displays as "25 bps", 0.01 displays as "100 bps" * * Log Safety: SAFE */ declare interface NumberFormatBasisPoints { baseFormatOptions: NumberFormatOptions; } /** * Format numbers as currency values with proper symbols and styling. Example: 1234.56 with currency "USD" displays as "USD 1,234.56" (standard) or "USD 1.2K" (compact) * * Log Safety: UNSAFE */ declare interface NumberFormatCurrency { baseFormatOptions: NumberFormatOptions; style: NumberFormatCurrencyStyle; currencyCode: PropertyTypeReferenceOrStringConstant; } /** * Currency rendering style options: STANDARD: Full currency formatting (e.g., "USD 1,234.56") COMPACT: Abbreviated currency formatting (e.g., "USD 1.2K") * * Log Safety: SAFE */ declare type NumberFormatCurrencyStyle = "STANDARD" | "COMPACT"; /** * Format numbers with custom units not supported by standard formatting. Use this for domain-specific units like "requests/sec", "widgets", etc. Example: 1500 with unit "widgets" displays as "1,500 widgets" * * Log Safety: UNSAFE */ declare interface NumberFormatCustomUnit { baseFormatOptions: NumberFormatOptions; unit: PropertyTypeReferenceOrStringConstant; } /** * Format numeric values representing time durations. Human readable: 3661 seconds displays as "1h 1m 1s" Timecode: 3661 seconds displays as "01:01:01" * * Log Safety: UNSAFE */ declare interface NumberFormatDuration { formatStyle: DurationFormatStyle; precision?: DurationPrecision; baseValue: DurationBaseValue; } /** * Map integer values to custom human-readable strings. Example: {1: "First", 2: "Second", 3: "Third"} would display 2 as "Second". * * Log Safety: UNSAFE */ declare interface NumberFormatFixedValues { values: Record; } /** * Number notation style options: STANDARD: Regular number display ("1,234") SCIENTIFIC: Scientific notation ("1.234E3") ENGINEERING: Engineering notation ("1.234E3") COMPACT: Compact notation ("1.2K") * * Log Safety: SAFE */ declare type NumberFormatNotation = "STANDARD" | "SCIENTIFIC" | "ENGINEERING" | "COMPACT"; /** * Base number formatting options that can be applied to all number formatters. Controls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat. Examples: useGrouping: true makes 1234567 display as "1,234,567" maximumFractionDigits: 2 makes 3.14159 display as "3.14" notation: SCIENTIFIC makes 1234 display as "1.234E3" * * Log Safety: SAFE */ declare interface NumberFormatOptions { useGrouping?: boolean; convertNegativeToParenthesis?: boolean; minimumIntegerDigits?: number; minimumFractionDigits?: number; maximumFractionDigits?: number; minimumSignificantDigits?: number; maximumSignificantDigits?: number; notation?: NumberFormatNotation; roundingMode?: NumberRoundingMode; } /** * Display the value as a ratio with different scaling factors and suffixes: PERCENTAGE: Multiply by 100 and add "%" suffix (0.15 → "15%") PER_MILLE: Multiply by 1000 and add "‰" suffix (0.015 → "15‰") BASIS_POINTS: Multiply by 10000 and add "bps" suffix (0.0015 → "15bps") * * Log Safety: SAFE */ declare interface NumberFormatRatio { ratioType: NumberRatioType; baseFormatOptions: NumberFormatOptions; } /** * Scale the numeric value by dividing by the specified factor and append an appropriate suffix. THOUSANDS: 1500 displays as "1.5K" MILLIONS: 2500000 displays as "2.5M" BILLIONS: 3200000000 displays as "3.2B" * * Log Safety: SAFE */ declare interface NumberFormatScale { scaleType: NumberScaleType; baseFormatOptions: NumberFormatOptions; } /** * Standard number formatting with configurable options. This provides basic number formatting without any special units, scaling, or transformations. * * Log Safety: SAFE */ declare interface NumberFormatStandard { baseFormatOptions: NumberFormatOptions; } /** * Format numbers with standard units supported by Intl.NumberFormat. Examples: "meter", "kilogram", "celsius", "percent" Input: 25 with unit "celsius" displays as "25 degrees C" * * Log Safety: UNSAFE */ declare interface NumberFormatStandardUnit { baseFormatOptions: NumberFormatOptions; unit: PropertyTypeReferenceOrStringConstant; } /** * Specifies the number of audio channels. Defaults to 2 (stereo). * * Log Safety: SAFE */ declare interface NumberOfChannels { numberOfChannels: number; } /** * Ratio format options for displaying proportional values: PERCENTAGE: Multiply by 100 and add "%" suffix PER_MILLE: Multiply by 1000 and add "‰" suffix BASIS_POINTS: Multiply by 10000 and add "bps" suffix * * Log Safety: SAFE */ declare type NumberRatioType = "PERCENTAGE" | "PER_MILLE" | "BASIS_POINTS"; /** * Number rounding behavior: CEIL: Always round up (3.1 becomes 4) FLOOR: Always round down (3.9 becomes 3) ROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4) * * Log Safety: SAFE */ declare type NumberRoundingMode = "CEIL" | "FLOOR" | "ROUND_CLOSEST"; /** * Scale factor options for large numbers: THOUSANDS: Divide by 1,000 and add "K" suffix MILLIONS: Divide by 1,000,000 and add "M" suffix BILLIONS: Divide by 1,000,000,000 and add "B" suffix * * Log Safety: SAFE */ declare type NumberScaleType = "THOUSANDS" | "MILLIONS" | "BILLIONS"; /** * The range of numeric values a check is expected to be within. * * Log Safety: SAFE */ declare interface NumericBounds { lowerBound?: number; upperBound?: number; } /** * Configuration for numeric bounds check with severity settings. * * Log Safety: SAFE */ declare interface NumericBoundsConfig { numericBounds: NumericBounds; severity: SeverityLevel; } /** * Configuration for numeric column-based checks (such as mean or median). At least one of numericBounds or trend must be specified. Both may be provided to validate both the absolute value range and the trend behavior over time. * * Log Safety: UNSAFE */ declare interface NumericColumnCheckConfig { columnName: ColumnName_3; numericBounds?: NumericBoundsConfig; trend?: TrendConfig; } /** * Checks the mean value of a numeric column. * * Log Safety: UNSAFE */ declare interface NumericColumnMeanCheckConfig { subject: DatasetSubject; numericColumnCheckConfig: NumericColumnCheckConfig; } /** * Checks the median value of a numeric column. * * Log Safety: UNSAFE */ declare interface NumericColumnMedianCheckConfig { subject: DatasetSubject; numericColumnCheckConfig: NumericColumnCheckConfig; } /** * Checks that values in a numeric column fall within a specified range. * * Log Safety: UNSAFE */ declare interface NumericColumnRangeCheckConfig { subject: DatasetSubject; columnName: ColumnName_3; numericBoundsConfig: NumericBoundsConfig; } /** * A numeric column value. * * Log Safety: UNSAFE */ declare interface NumericColumnValue { value: number; } /** * The time series property can either contain either numeric or non-numeric data. This enables mixed sensor types where some sensor time series are numeric and others are categorical. A boolean property reference can be used to determine if the series is numeric or non-numeric. Without this property, the series type can be either numeric or non-numeric and must be inferred from the result of a time series query. * * Log Safety: UNSAFE */ declare interface NumericOrNonNumericType { isNonNumericPropertyTypeId?: string; } /** * Authenticate as a service principal using OAuth. Create a service principal in Databricks and generate an OAuth secret to obtain a client ID and secret. Read the official Databricks documentation for more information about OAuth machine-to-machine authentication. * * Log Safety: DO_NOT_LOG */ declare interface OauthMachineToMachineAuth { clientID: string; clientSecret: EncryptedProperty; } /** * The object the user is attempting to create already exists. * * Log Safety: SAFE */ declare interface ObjectAlreadyExists { errorCode: "CONFLICT"; errorName: "ObjectAlreadyExists"; errorDescription: "The object the user is attempting to create already exists."; errorInstanceId: string; parameters: {}; } /** * An object used by this Action was changed by someone else while the Action was running. * * Log Safety: UNSAFE */ declare interface ObjectChanged { errorCode: "CONFLICT"; errorName: "ObjectChanged"; errorDescription: "An object used by this Action was changed by someone else while the Action was running."; errorInstanceId: string; parameters: { primaryKey: unknown; objectType: unknown; }; } /** * Details of relevant retrieved object instances for a user's message to include as additional context in the prompt to the Agent. * * Log Safety: SAFE */ declare interface ObjectContext { objectRids: Array<_Ontologies.ObjectRid>; propertyTypeRids: Array<_Ontologies.PropertyTypeRid>; } /** * Log Safety: UNSAFE */ declare type ObjectEdit = ({ type: "modifyObject"; } & ModifyObject) | ({ type: "deleteObject"; } & DeleteObject) | ({ type: "addObject"; } & AddObject) | ({ type: "deleteLink"; } & DeleteLink) | ({ type: "addLink"; } & AddLink); /** * Represents a single object edit operation in the history. This captures when an object was created, modified, or deleted as part of an action execution. * * Log Safety: UNSAFE */ declare interface ObjectEditHistoryEntry { objectPrimaryKey: ObjectPrimaryKeyV2; operationId: ActionRid; actionTypeRid: ActionTypeRid; userId: string; timestamp: string; edit: EditHistoryEdit; } /** * An add object edit in the transaction did not include the object's primary key property. The primary key property must be provided when creating an object. * * Log Safety: UNSAFE */ declare interface ObjectEditMissingPrimaryKey { errorCode: "INVALID_ARGUMENT"; errorName: "ObjectEditMissingPrimaryKey"; errorDescription: "An add object edit in the transaction did not include the object's primary key property. The primary key property must be provided when creating an object."; errorInstanceId: string; parameters: { objectType: unknown; primaryKey: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ObjectEdits { edits: Array; addedObjectCount: number; modifiedObjectsCount: number; deletedObjectsCount: number; addedLinksCount: number; deletedLinksCount: number; } /** * Optional features to toggle when generating the object loading response. * * Log Safety: SAFE */ declare interface ObjectLoadingResponseOptions { shouldLoadObjectRids?: boolean; } /** * An object identifier containing an object type API name and primary key. * * Log Safety: UNSAFE */ declare interface ObjectLocator { objectTypeApiName: ObjectTypeApiName; primaryKeyValue: PrimaryKeyValue; } /** * The requested object is not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface ObjectNotFound { errorCode: "NOT_FOUND"; errorName: "ObjectNotFound"; errorDescription: "The requested object is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { objectType: unknown; primaryKey: unknown; }; } /** * Represents an object parameter property argument in a logic rule. * * Log Safety: UNSAFE */ declare interface ObjectParameterPropertyArgument { parameterId: ParameterId_2; propertyTypeApiName: PropertyTypeApiName; } /** * Log Safety: UNSAFE */ declare type ObjectPrimaryKey = Record; /** * Log Safety: UNSAFE */ declare type ObjectPrimaryKeyV2 = Record; /** * A union of all the types supported by Ontology Object properties. * * Log Safety: UNSAFE */ declare type ObjectPropertyType = ({ type: "date"; } & _Core.DateType) | ({ type: "struct"; } & StructType) | ({ type: "string"; } & _Core.StringType) | ({ type: "byte"; } & _Core.ByteType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "geopoint"; } & _Core.GeoPointType) | ({ type: "geotimeSeriesReference"; } & _Core.GeotimeSeriesReferenceType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "float"; } & _Core.FloatType) | ({ type: "geoshape"; } & _Core.GeoShapeType) | ({ type: "long"; } & _Core.LongType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "cipherText"; } & _Core.CipherTextType) | ({ type: "marking"; } & _Core.MarkingType) | ({ type: "attachment"; } & _Core.AttachmentType) | ({ type: "mediaReference"; } & _Core.MediaReferenceType) | ({ type: "timeseries"; } & _Core.TimeseriesType) | ({ type: "array"; } & OntologyObjectArrayType) | ({ type: "short"; } & _Core.ShortType) | ({ type: "vector"; } & _Core.VectorType) | ({ type: "decimal"; } & _Core.DecimalType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * The parameter value must be a property value of an object found within an object set. * * Log Safety: SAFE */ declare interface ObjectPropertyValueConstraint { } /** * The parameter value must be the primary key of an object found within an object set. * * Log Safety: SAFE */ declare interface ObjectQueryResultConstraint { } /** * @deprecated Use `ObjectRid` in the `foundry.ontologies` package * * The Resource Identifier (RID) for an ontology object instance. * * Log Safety: SAFE */ declare type ObjectRid = LooselyBrandedString<"ObjectRid">; /** * The unique resource identifier of an object, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type ObjectRid_2 = LooselyBrandedString_5<"ObjectRid">; /** * @deprecated Use `ObjectSet` in the `foundry.ontologies` package * * Represents the definition of an ObjectSet in the ontology. * * Log Safety: UNSAFE */ declare type ObjectSet = ({ type: "searchAround"; } & ObjectSetSearchAroundType) | ({ type: "static"; } & ObjectSetStaticType) | ({ type: "intersect"; } & ObjectSetIntersectionType) | ({ type: "withProperties"; } & ObjectSetWithPropertiesType) | ({ type: "subtract"; } & ObjectSetSubtractType) | ({ type: "nearestNeighbors"; } & ObjectSetNearestNeighborsType) | ({ type: "union"; } & ObjectSetUnionType) | ({ type: "asType"; } & ObjectSetAsTypeType) | ({ type: "methodInput"; } & ObjectSetMethodInputType) | ({ type: "reference"; } & ObjectSetReferenceType) | ({ type: "filter"; } & ObjectSetFilterType) | ({ type: "interfaceBase"; } & ObjectSetInterfaceBaseType) | ({ type: "asBaseObjectTypes"; } & ObjectSetAsBaseObjectTypesType) | ({ type: "base"; } & ObjectSetBaseType); /** * Represents the definition of an ObjectSet in the Ontology. * * Log Safety: UNSAFE */ declare type ObjectSet_2 = ({ type: "searchAround"; } & ObjectSetSearchAroundType_2) | ({ type: "static"; } & ObjectSetStaticType_2) | ({ type: "intersect"; } & ObjectSetIntersectionType_2) | ({ type: "withProperties"; } & ObjectSetWithPropertiesType_2) | ({ type: "interfaceLinkSearchAround"; } & ObjectSetInterfaceLinkSearchAroundType) | ({ type: "subtract"; } & ObjectSetSubtractType_2) | ({ type: "nearestNeighbors"; } & ObjectSetNearestNeighborsType_2) | ({ type: "union"; } & ObjectSetUnionType_2) | ({ type: "asType"; } & ObjectSetAsTypeType_2) | ({ type: "methodInput"; } & ObjectSetMethodInputType_2) | ({ type: "reference"; } & ObjectSetReferenceType_2) | ({ type: "filter"; } & ObjectSetFilterType_2) | ({ type: "interfaceBase"; } & ObjectSetInterfaceBaseType_2) | ({ type: "asBaseObjectTypes"; } & ObjectSetAsBaseObjectTypesType_2) | ({ type: "base"; } & ObjectSetBaseType_2); /** * @deprecated Use `ObjectSetAsBaseObjectTypesType` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare interface ObjectSetAsBaseObjectTypesType { objectSet: ObjectSet; } /** * Casts the objects in the object set to their base type and thus ensures objects are returned with all of their properties in the resulting object set, not just the properties that implement interface properties. * * Log Safety: UNSAFE */ declare interface ObjectSetAsBaseObjectTypesType_2 { objectSet: ObjectSet_2; } /** * @deprecated Use `ObjectSetAsTypeType` in the `foundry.ontologies` package * * Casts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. This is currently unsupported and an exception will be thrown if used. * * Log Safety: UNSAFE */ declare interface ObjectSetAsTypeType { entityType: string; objectSet: ObjectSet; } /** * Casts an object set to a specified object type or interface type API name. Any object whose object type does not match the object type provided or implement the interface type provided will be dropped from the resulting object set. * * Log Safety: UNSAFE */ declare interface ObjectSetAsTypeType_2 { entityType: string; objectSet: ObjectSet_2; } /** * @deprecated Use `ObjectSetBaseType` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare interface ObjectSetBaseType { objectType: string; } /** * Log Safety: UNSAFE */ declare interface ObjectSetBaseType_2 { objectType: string; } /** * @deprecated Use `ObjectSetFilterType` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare interface ObjectSetFilterType { objectSet: ObjectSet; where: SearchJsonQueryV2; } /** * Log Safety: UNSAFE */ declare interface ObjectSetFilterType_2 { objectSet: ObjectSet_2; where: SearchJsonQueryV2_2; } /** * @deprecated Use `ObjectSetInterfaceBaseType` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare interface ObjectSetInterfaceBaseType { interfaceType: string; } /** * Log Safety: UNSAFE */ declare interface ObjectSetInterfaceBaseType_2 { interfaceType: string; includeAllBaseObjectProperties?: boolean; } /** * Log Safety: UNSAFE */ declare interface ObjectSetInterfaceLinkSearchAroundType { objectSet: ObjectSet_2; interfaceLink: InterfaceLinkTypeApiName; } /** * @deprecated Use `ObjectSetIntersectionType` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare interface ObjectSetIntersectionType { objectSets: Array; } /** * Log Safety: UNSAFE */ declare interface ObjectSetIntersectionType_2 { objectSets: Array; } /** * @deprecated Use `ObjectSetMethodInputType` in the `foundry.ontologies` package * * Log Safety: SAFE */ declare interface ObjectSetMethodInputType { } /** * ObjectSet which is the root of a MethodObjectSet definition. This feature is experimental and not yet generally available. * * Log Safety: SAFE */ declare interface ObjectSetMethodInputType_2 { } /** * @deprecated Use `ObjectSetNearestNeighborsType` in the `foundry.ontologies` package * * Log Safety: SAFE */ declare interface ObjectSetNearestNeighborsType { } /** * ObjectSet containing the top numNeighbors objects with propertyIdentifier nearest to the input vector or text. This can only be performed on a property with type vector that has been configured to be searched with approximate nearest neighbors using a similarity function configured in the Ontology. A non-zero score for each resulting object is returned when the orderType in the orderBy field is set to relevance. Note that: Scores will not be returned if a nearestNeighbors object set is composed through union, subtraction or intersection with non-nearestNeighbors object sets. If results have scores, the order of the scores will be decreasing (duplicate scores are possible). * * Log Safety: UNSAFE */ declare interface ObjectSetNearestNeighborsType_2 { objectSet: ObjectSet_2; propertyIdentifier: PropertyIdentifier_2; numNeighbors: number; similarityThreshold?: number; query: NearestNeighborsQuery; } /** * The requested object set is not found, or the client token does not have access to it. * * Log Safety: SAFE */ declare interface ObjectSetNotFound { errorCode: "NOT_FOUND"; errorName: "ObjectSetNotFound"; errorDescription: "The requested object set is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { objectSetRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ObjectSetParameter { expectedObjectTypes: Array<_Ontologies.ObjectTypeId>; } /** * A value passed for ObjectSetParameter application variable types. * * Log Safety: UNSAFE */ declare interface ObjectSetParameterValue { objectSet: _Ontologies.ObjectSet; ontology: _Ontologies.OntologyIdentifier; } /** * Log Safety: SAFE */ declare interface ObjectSetParameterValueUpdate { value: _Ontologies.ObjectSetRid; } /** * @deprecated Use `ObjectSetReferenceType` in the `foundry.ontologies` package * * Log Safety: SAFE */ declare interface ObjectSetReferenceType { reference: ObjectSetRid; } /** * Log Safety: SAFE */ declare interface ObjectSetReferenceType_2 { reference: ObjectSetRid_2; } /** * @deprecated Use `ObjectSetRid` in the `foundry.ontologies` package * * The Resource Identifier (RID) for an object set. * * Log Safety: SAFE */ declare type ObjectSetRid = LooselyBrandedString<"ObjectSetRid">; /** * Log Safety: SAFE */ declare type ObjectSetRid_2 = LooselyBrandedString_5<"ObjectSetRid">; /** * @deprecated Use `ObjectSetSearchAroundType` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare interface ObjectSetSearchAroundType { objectSet: ObjectSet; link: LinkTypeApiName; } /** * Log Safety: UNSAFE */ declare interface ObjectSetSearchAroundType_2 { objectSet: ObjectSet_2; link: LinkTypeApiName_2; } /** * @deprecated Use `ObjectSetStaticType` in the `foundry.ontologies` package * * Log Safety: SAFE */ declare interface ObjectSetStaticType { objects: Array; } /** * Log Safety: SAFE */ declare interface ObjectSetStaticType_2 { objects: Array; } /** * branch identifies the Foundry branch. scenarioRid identifies the Ontology Scenario. If a scenario is based on a non-default branch, branch must identify that non-default base branch. * * Log Safety: UNSAFE */ declare interface ObjectSetStreamSubscribeRequest { objectSet: ObjectSet_2; branch?: _Core.FoundryBranch; scenarioRid?: OntologyScenarioRid; propertySet: Array; referenceSet: Array; objectLoadingResponseOptions?: ObjectLoadingResponseOptions; } /** * The list of object sets that should be subscribed to. A client can stop subscribing to an object set by removing the request from subsequent ObjectSetStreamSubscribeRequests. * * Log Safety: UNSAFE */ declare interface ObjectSetStreamSubscribeRequests { id: RequestId; requests: Array; } /** * Log Safety: UNSAFE */ declare type ObjectSetSubscribeResponse = ({ type: "qos"; } & QosError) | ({ type: "success"; } & SubscriptionSuccess) | ({ type: "error"; } & SubscriptionError); /** * Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId. * * Log Safety: UNSAFE */ declare interface ObjectSetSubscribeResponses { responses: Array; id: RequestId; } /** * @deprecated Use `ObjectSetSubtractType` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare interface ObjectSetSubtractType { objectSets: Array; } /** * Log Safety: UNSAFE */ declare interface ObjectSetSubtractType_2 { objectSets: Array; } /** * @deprecated Use `ObjectSetUnionType` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare interface ObjectSetUnionType { objectSets: Array; } /** * Log Safety: UNSAFE */ declare interface ObjectSetUnionType_2 { objectSets: Array; } /** * Log Safety: UNSAFE */ declare type ObjectSetUpdate = ({ type: "reference"; } & ReferenceUpdate) | ({ type: "object"; } & ObjectUpdate); /** * Log Safety: UNSAFE */ declare interface ObjectSetUpdates { id: SubscriptionId; updates: Array; } /** * @deprecated Use `ObjectSetWithPropertiesType` in the `foundry.ontologies` package * * Log Safety: SAFE */ declare interface ObjectSetWithPropertiesType { } /** * ObjectSet which returns objects with additional derived properties. This feature is experimental and not yet generally available. * * Log Safety: UNSAFE */ declare interface ObjectSetWithPropertiesType_2 { objectSet: ObjectSet_2; derivedProperties: Record; } /** * There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this API for a given request. * * Log Safety: SAFE */ declare interface ObjectsExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "ObjectsExceededLimit"; errorDescription: "There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this API for a given request."; errorInstanceId: string; parameters: {}; } /** * The provided objects are being modified concurrently and the operation would result in a conflict. The client should retry the request later. * * Log Safety: UNSAFE */ declare interface ObjectsModifiedConcurrently { errorCode: "CONFLICT"; errorName: "ObjectsModifiedConcurrently"; errorDescription: "The provided objects are being modified concurrently and the operation would result in a conflict. The client should retry the request later."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was added to the set or the object has updated and was previously in the set. REMOVED indicates that the object was removed from the set due to the object being deleted or the object no longer meets the object set definition. * * Log Safety: SAFE */ declare type ObjectState = "ADDED_OR_UPDATED" | "REMOVED"; /** * Represents an object type in the Ontology. * * Log Safety: UNSAFE */ declare interface ObjectType { apiName: ObjectTypeApiName; legacyObjectTypeId?: LegacyObjectTypeId; displayName?: _Core.DisplayName; status: _Core.ReleaseStatus; description?: string; visibility?: ObjectTypeVisibility; primaryKey: Array; properties: Record; rid: ObjectTypeRid_2; } /** * The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the List object types endpoint or check the Ontology Manager. * * Log Safety: UNSAFE */ declare type ObjectTypeApiName = LooselyBrandedString_5<"ObjectTypeApiName">; /** * An object type datasource backed by a Foundry dataset. * * Log Safety: UNSAFE */ declare interface ObjectTypeDatasetDatasource { datasetRid: _Datasets.DatasetRid; branch?: DatasourceBranchId; propertyMapping: Record; } /** * A datasource that supplies property values for an object type. Each object type can have one or more datasources; together they back all of the object type's properties. The definition carries the RID of the backing Foundry resource (for example, the dataset RID for a dataset-backed object type), enabling callers to navigate from an object type to its backing data. * * Log Safety: UNSAFE */ declare interface ObjectTypeDatasource { rid: DatasourceRid; definition: ObjectTypeDatasourceDefinition; } /** * The definition of an object type datasource, identifying the kind of Foundry resource that backs the object type. * * Log Safety: UNSAFE */ declare type ObjectTypeDatasourceDefinition = ({ type: "timeSeries"; } & ObjectTypeTimeSeriesDatasource) | ({ type: "unsupported"; } & ObjectTypeUnsupportedDatasource) | ({ type: "restrictedView"; } & ObjectTypeRestrictedViewDatasource) | ({ type: "stream"; } & ObjectTypeStreamDatasource) | ({ type: "mediaSetView"; } & ObjectTypeMediaSetViewDatasource) | ({ type: "direct"; } & ObjectTypeDirectDatasource) | ({ type: "geotimeSeries"; } & ObjectTypeGeotimeSeriesDatasource) | ({ type: "editsOnly"; } & ObjectTypeEditsOnlyDatasource) | ({ type: "dataset"; } & ObjectTypeDatasetDatasource) | ({ type: "table"; } & ObjectTypeTableDatasource); /** * The request uses an object type derived property in a way that is not supported. This occurs when results are sorted by the derived property, when the object set is filtered on the derived property, or when the derived property is returned only because the request asked for all properties of the object type (rather than naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any filters, and select only the specific properties you need - you may select the derived property itself by name. * * Log Safety: SAFE */ declare interface ObjectTypeDerivedPropertyNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "ObjectTypeDerivedPropertyNotSupported"; errorDescription: "The request uses an object type derived property in a way that is not supported. This occurs when results are sorted by the derived property, when the object set is filtered on the derived property, or when the derived property is returned only because the request asked for all properties of the object type (rather than naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any filters, and select only the specific properties you need - you may select the derived property itself by name."; errorInstanceId: string; parameters: {}; } /** * An object type datasource backed by a direct-write source. Property values are written directly to the datasource rather than being read from a separate Foundry resource. Unlike an edits-only datasource, a direct datasource has a backing source that values are written to by some writer. An edits-only datasource has no backing source at all and its properties are populated solely via Actions. * * Log Safety: UNSAFE */ declare interface ObjectTypeDirectDatasource { directSourceRid: DirectSourceRid; propertyMapping: Record; } /** * Log Safety: UNSAFE */ declare interface ObjectTypeEdits { editedObjectTypes: Array; } /** * Request object for querying object type edits history, containing both filters and pagination parameters If objectPrimaryKey property is set, the method will return edits history for the particular object. Otherwise, the method will return edits history for all objects of this object type. * * Log Safety: UNSAFE */ declare interface ObjectTypeEditsHistoryRequest { objectPrimaryKey?: ObjectPrimaryKeyV2; filters?: EditsHistoryFilter; sortOrder?: EditsHistorySortOrder; includeAllPreviousProperties?: boolean; pageSize?: number; pageToken?: string; } /** * Response containing the history of edits for objects of a specific object type. Only contains object edits (create, modify, delete) - link edits are not included. * * Log Safety: UNSAFE */ declare interface ObjectTypeEditsHistoryResponse { data: Array; totalCount?: number; nextPageToken?: string; } /** * An object type datasource that is not backed by any external Foundry resource. All properties on the object type can only be populated via Actions. Other datasources have edit only properties, which are permissioned to the backing tabular datasource. This datasource has no backing tabular datasource and is a true edit only object type. Note that this datasource type is incompatible with any other datasource and all the properties on the object type are backed by it. * * Log Safety: SAFE */ declare interface ObjectTypeEditsOnlyDatasource { } /** * Log Safety: UNSAFE */ declare interface ObjectTypeFullMetadata { objectType: ObjectTypeV2; linkTypes: Array; implementsInterfaces: Array; implementsInterfaces2: Record; sharedPropertyTypeMapping: Record; } /** * An object type datasource backed by a Geotime series integration, providing values for Geotime series reference properties. * * Log Safety: UNSAFE */ declare interface ObjectTypeGeotimeSeriesDatasource { geotimeSeriesIntegrationRid: GeotimeSeriesIntegrationRid; properties: Array; } /** * @deprecated Use `ObjectTypeId` in the `foundry.ontologies` package * * The unique identifier (ID) for an object type. This can be viewed in Ontology Manager. * * Log Safety: UNSAFE */ declare type ObjectTypeId = LooselyBrandedString<"ObjectTypeId">; /** * The unique identifier (ID) for an object type. This can be viewed in Ontology Manager. * * Log Safety: UNSAFE */ declare type ObjectTypeId_2 = LooselyBrandedString_5<"ObjectTypeId">; /** * Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in Ontology Manager. * * Log Safety: UNSAFE */ declare interface ObjectTypeIdsNotFound { errorCode: "NOT_FOUND"; errorName: "ObjectTypeIdsNotFound"; errorDescription: "Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in Ontology Manager."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; objectTypeIds: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ObjectTypeInterfaceImplementation { apiName?: InterfaceTypeApiName; rid?: InterfaceTypeRid; properties: Record; propertiesV2: Record; links: Record>; actionTypes: Record; } /** * Groups link type API names by the object type they're scoped to. Link type API names are only unique within an object type, so this pairing is required to identify a link type unambiguously. * * Log Safety: UNSAFE */ declare interface ObjectTypeLinkTypeApiNameMapping { objectTypeApiName: ObjectTypeApiName; linkTypes: Array; } /** * An object type datasource backed by a Foundry media set view, providing media for media reference properties. * * Log Safety: UNSAFE */ declare interface ObjectTypeMediaSetViewDatasource { mediaSetRid: _Core.MediaSetRid; mediaSetViewRid: _Core.MediaSetViewRid; properties: Array; } /** * The requested object type is not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface ObjectTypeNotFound { errorCode: "NOT_FOUND"; errorName: "ObjectTypeNotFound"; errorDescription: "The requested object type is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { objectType: unknown; objectTypeRid: unknown; }; } /** * The requested object type is not synced into the ontology. Please reach out to your Ontology Administrator to re-index the object type in Ontology Management Application. * * Log Safety: UNSAFE */ declare interface ObjectTypeNotSynced { errorCode: "CONFLICT"; errorName: "ObjectTypeNotSynced"; errorDescription: "The requested object type is not synced into the ontology. Please reach out to your Ontology Administrator to re-index the object type in Ontology Management Application."; errorInstanceId: string; parameters: { objectType: unknown; }; } /** * An object type datasource backed by a Foundry restricted view. * * Log Safety: UNSAFE */ declare interface ObjectTypeRestrictedViewDatasource { restrictedViewRid: RestrictedViewRid; propertyMapping: Record; } /** * @deprecated Use `ObjectTypeRid` in the `foundry.ontologies` package * * The unique Resource Identifier (RID) of an object type, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type ObjectTypeRid = LooselyBrandedString<"ObjectTypeRid">; /** * The unique resource identifier of an object type, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type ObjectTypeRid_2 = LooselyBrandedString_5<"ObjectTypeRid">; /** * Identifier for an ontology object type. * * Log Safety: SAFE */ declare type ObjectTypeRid_3 = LooselyBrandedString_19<"ObjectTypeRid">; /** * Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in Ontology Manager. * * Log Safety: SAFE */ declare interface ObjectTypeRidsNotFound { errorCode: "NOT_FOUND"; errorName: "ObjectTypeRidsNotFound"; errorDescription: "Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in Ontology Manager."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; objectTypeRids: unknown; }; } /** * One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology Administrator to re-index the object type(s) in Ontology Management Application. * * Log Safety: UNSAFE */ declare interface ObjectTypesNotSynced { errorCode: "CONFLICT"; errorName: "ObjectTypesNotSynced"; errorDescription: "One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology Administrator to re-index the object type(s) in Ontology Management Application."; errorInstanceId: string; parameters: { objectTypes: unknown; }; } /** * An object type datasource backed by a Foundry stream. * * Log Safety: UNSAFE */ declare interface ObjectTypeStreamDatasource { streamRid: StreamRid; branch?: DatasourceBranchId; propertyMapping: Record; } export declare namespace ObjectTypesV2 { export { list_22 as list, get_28 as get, getEditsHistory, listOutgoingLinkTypes, getOutgoingLinkType } } /** * An object type datasource backed by a Foundry table. * * Log Safety: UNSAFE */ declare interface ObjectTypeTableDatasource { tableRid: TableRid_2; branch?: DatasourceBranchId; propertyMapping: Record; } /** * An object type datasource backed by a time series sync, providing values for time-dependent properties. * * Log Safety: UNSAFE */ declare interface ObjectTypeTimeSeriesDatasource { timeSeriesSyncRid: TimeseriesSyncRid; properties: Array; } /** * A datasource of a kind not yet exposed in the public API. The unsupportedType discriminator supplies the underlying OMS variant so callers can recognize known but unmodelled cases (e.g., derived properties). Variants the adapter does not recognise at all are returned with an "unknown" discriminator. The properties list enumerates the property API names this datasource backs. The properties will be empty for "unknown" datasources. * * Log Safety: UNSAFE */ declare interface ObjectTypeUnsupportedDatasource { unsupportedType: string; properties: Array; } /** * Represents an object type in the Ontology. * * Log Safety: UNSAFE */ declare interface ObjectTypeV2 { apiName: ObjectTypeApiName; displayName: _Core.DisplayName; status: _Core.ReleaseStatus; description?: string; pluralDisplayName: string; icon: Icon; primaryKey: PropertyApiName_2; properties: Record; rid: ObjectTypeRid_2; titleProperty: PropertyApiName_2; visibility?: ObjectTypeVisibility; aliases: Array; datasources: Array; } /** * The suggested visibility of the object type. * * Log Safety: SAFE */ declare type ObjectTypeVisibility = "NORMAL" | "PROMINENT" | "HIDDEN"; /** * Log Safety: UNSAFE */ declare interface ObjectUpdate { object: OntologyObjectV2; state: ObjectState; } /** * hOCR (HTML-based OCR) output format. * * Log Safety: SAFE */ declare interface OcrHocrOutputFormat { } /** * Language codes for OCR. * * Log Safety: SAFE */ declare type OcrLanguage = "AFR" | "AMH" | "ARA" | "ASM" | "AZE" | "AZE_CYRL" | "BEL" | "BEN" | "BOD" | "BOS" | "BRE" | "BUL" | "CAT" | "CEB" | "CES" | "CHI_SIM" | "CHI_SIM_VERT" | "CHI_TRA" | "CHI_TRA_VERT" | "CHR" | "COS" | "CYM" | "DAN" | "DEU" | "DIV" | "DZO" | "ELL" | "ENG" | "ENM" | "EPO" | "EST" | "EUS" | "FAO" | "FAS" | "FIL" | "FIN" | "FRA" | "FRM" | "FRY" | "GLA" | "GLE" | "GLG" | "GRC" | "GUJ" | "HAT" | "HEB" | "HIN" | "HRV" | "HUN" | "HYE" | "IKU" | "IND" | "ISL" | "ITA" | "ITA_OLD" | "JAV" | "JPN" | "JPN_VERT" | "KAN" | "KAT" | "KAT_OLD" | "KAZ" | "KHM" | "KIR" | "KMR" | "KOR" | "KOR_VERT" | "LAO" | "LAT" | "LAV" | "LIT" | "LTZ" | "MAL" | "MAR" | "MKD" | "MLT" | "MON" | "MRI" | "MSA" | "MYA" | "NEP" | "NLD" | "NOR" | "OCI" | "ORI" | "OSD" | "PAN" | "POL" | "POR" | "PUS" | "QUE" | "RON" | "RUS" | "SAN" | "SIN" | "SLK" | "SLV" | "SND" | "SPA" | "SPA_OLD" | "SQI" | "SRP" | "SRP_LATN" | "SUN" | "SWA" | "SWE" | "SYR" | "TAM" | "TAT" | "TEL" | "TGK" | "THA" | "TIR" | "TON" | "TUR" | "UIG" | "UKR" | "URD" | "UZB" | "UZB_CYRL" | "VIE" | "YID" | "YOR"; /** * Either a specific language or a script for OCR. * * Log Safety: UNSAFE */ declare type OcrLanguageOrScript = ({ type: "language"; } & OcrLanguageWrapper) | ({ type: "script"; } & OcrScriptWrapper); /** * Wrapper for an OCR language. * * Log Safety: SAFE */ declare interface OcrLanguageWrapper { language: OcrLanguage; } /** * OCR mode for document extraction. * * Log Safety: SAFE */ declare type OcrMode = "AUTO" | "ELECTRONIC" | "SCAN"; /** * Performs OCR (Optical Character Recognition) on a specific page of a document. * * Log Safety: UNSAFE */ declare interface OcrOnPageOperation { pageNumber: number; parameters: OcrParameters; } /** * Creates access patterns for OCR across pages of a document. * * Log Safety: UNSAFE */ declare interface OcrOnPagesOperation { parameters: OcrParameters; pageNumber: number; } /** * The output format for OCR results. * * Log Safety: UNSAFE */ declare type OcrOutputFormat = ({ type: "hocr"; } & OcrHocrOutputFormat) | ({ type: "text"; } & OcrTextOutputFormat); /** * Parameters for OCR (Optical Character Recognition) operations. * * Log Safety: UNSAFE */ declare interface OcrParameters { outputFormat: OcrOutputFormat; languages: Array; } /** * Script codes for OCR. * * Log Safety: SAFE */ declare type OcrScript = "ARABIC" | "ARMENIAN" | "BENGALI" | "CANADIAN_ABORIGINAL" | "CHEROKEE" | "CYRILLIC" | "DEVANAGARI" | "ETHIOPIC" | "FRAKTUR" | "GEORGIAN" | "GREEK" | "GUJARATI" | "GURMUKHI" | "HAN_SIMPLIFIED" | "HAN_SIMPLIFIED_VERT" | "HAN_TRADITIONAL" | "HAN_TRADITIONAL_VERT" | "HANGUL" | "HANGUL_VERT" | "HEBREW" | "JAPANESE" | "JAPANESE_VERT" | "KANNADA" | "KHMER" | "LAO" | "LATIN" | "MALAYALAM" | "MYANMAR" | "ORIYA" | "SINHALA" | "SYRIAC" | "TAMIL" | "TELUGU" | "THAANA" | "THAI" | "TIBETAN" | "VIETNAMESE"; /** * Wrapper for an OCR script. * * Log Safety: SAFE */ declare interface OcrScriptWrapper { script: OcrScript; } /** * Plain text output format for OCR. * * Log Safety: SAFE */ declare interface OcrTextOutputFormat { } /** * Log Safety: SAFE */ declare interface OidcAuthenticationProtocol { } /** * The parameter value must be one of a fixed set of labelled options. * * Log Safety: UNSAFE */ declare interface OneOfAllowedValues { options: Array; otherValuesAllowed: boolean; } /** * The parameter has a manually predefined set of options. * * Log Safety: UNSAFE */ declare interface OneOfConstraint { options: Array; otherValuesAllowed: boolean; } export declare namespace Ontologies { export { AbsoluteTimeRange, AbsoluteValuePropertyExpression, Action, ActionExecutionTime, ActionLogicRule, ActionMode, ActionParameterArrayType, ActionParameterRid, ActionParameterType, ActionParameterV2, ActionParameterValidation, ActionParameterValidationBlock, ActionResults, ActionRid, ActionSectionRid, ActionType, ActionTypeApiName, ActionTypeApiNameActionTypesQueryV2, ActionTypeDescriptionActionTypesQueryV2, ActionTypeDisplayNameActionTypesQueryV2, ActionTypeFullMetadata, ActionTypeFuzziness, ActionTypeLogicRuleTypeFilter, ActionTypePermissionModelFilter, ActionTypeRid, ActionTypeRidActionTypesQueryV2, ActionTypeSearchJsonQueryV2, ActionTypeSortByV2, ActionTypeStatusFilter, ActionTypeV2, ActivePropertyTypeStatus, AddLink, AddLinkEdit, AddObject, AddObjectEdit, AddPropertyExpression, AffectedInterfaceTypeRidActionTypesQueryV2, AffectedLinkTypeRidActionTypesQueryV2, AffectedObjectTypeRidActionTypesQueryV2, Affix, AggregateObjectSetRequestV2, AggregateObjectsRequest, AggregateObjectsRequestV2, AggregateObjectsResponse, AggregateObjectsResponseItem, AggregateObjectsResponseItemV2, AggregateObjectsResponseV2, AggregateTimeSeries, Aggregation, AggregationAccuracy, AggregationAccuracyRequest, AggregationDurationGrouping, AggregationDurationGroupingV2, AggregationExactGrouping, AggregationExactGroupingV2, AggregationFixedWidthGrouping, AggregationFixedWidthGroupingV2, AggregationGroupBy, AggregationGroupByV2, AggregationGroupKey, AggregationGroupKeyV2, AggregationGroupValue, AggregationGroupValueV2, AggregationMetricName, AggregationMetricResult, AggregationMetricResultV2, AggregationObjectTypeGrouping, AggregationOrderBy, AggregationRange, AggregationRangesGrouping, AggregationRangesGroupingV2, AggregationRangeV2, AggregationV2, AllOfRule, AllTermsQuery, AndActionTypesQueryV2, AndQuery, AndQueryV2_2 as AndQueryV2, AnyOfRule, AnyTermQuery, ApplyActionMode, ApplyActionOverrides, ApplyActionRequest, ApplyActionRequestOptions, ApplyActionRequestV2, ApplyActionResponse, ApplyActionWithOverridesRequest, ApplyReducersAndExtractMainValueLoadLevel, ApplyReducersLoadLevel, ApplyScenarioLogicRule, ApplyScenarioRule, ApproximateDistinctAggregation, ApproximateDistinctAggregationV2, ApproximatePercentileAggregationV2, Arg, ArrayConstraint, ArrayEntryEvaluatedConstraint, ArrayEvaluatedConstraint, ArraySizeConstraint, ArtifactRepositoryRid, AsyncActionOperation, AsyncActionStatus, AsyncApplyActionOperationResponseV2, AsyncApplyActionOperationV2, AsyncApplyActionRequest, AsyncApplyActionRequestV2, AsyncApplyActionResponse, AsyncApplyActionResponseV2, Attachment, AttachmentAllowedValues, AttachmentMetadataResponse, AttachmentProperty, AttachmentPropertyV2, AttachmentRid, AttachmentV2, AvgAggregation, AvgAggregationV2, BatchActionObjectEdit, BatchActionObjectEdits, BatchActionResults, BatchApplyActionRequest, BatchApplyActionRequestItem, BatchApplyActionRequestItemWithOverrides, BatchApplyActionRequestOptions, BatchApplyActionRequestV2, BatchApplyActionResponse, BatchApplyActionResponseV2, BatchApplyActionWithOverridesRequest, BatchedFunctionLogicRule, BatchReturnEditsMode, BlueprintIcon, BooleanValue, BoundingBoxValue_2 as BoundingBoxValue, CenterPoint_2 as CenterPoint, CenterPointTypes_2 as CenterPointTypes, CipherChannelStrategy, CipherText, CipherTextProperty, ColumnName_2 as ColumnName, ColumnPropertyMapping, ConjunctiveMarkingSummary, ContainerConjunctiveMarkingSummary, ContainerDisjunctiveMarkingSummary, ContainsAllTermsInOrderPrefixLastTerm_2 as ContainsAllTermsInOrderPrefixLastTerm, ContainsAllTermsInOrderQuery_2 as ContainsAllTermsInOrderQuery, ContainsAllTermsQuery_2 as ContainsAllTermsQuery, ContainsAnyTermQuery_2 as ContainsAnyTermQuery, ContainsQuery, ContainsQueryV2_2 as ContainsQueryV2, CountAggregation, CountAggregationV2, CountObjectsResponseV2, CreateEdit, CreateInterfaceLinkLogicRule, CreateInterfaceLogicRule, CreateInterfaceObjectRule, CreateLinkLogicRule, CreateLinkRule, CreateObjectLogicRule, CreateObjectRule, CreateOntologyScenarioRequest, CreateOntologyScenarioResponse, CreateOrModifyObjectLogicRule, CreateOrModifyObjectLogicRuleV2, CreateTemporaryObjectSetRequestV2, CreateTemporaryObjectSetResponseV2, CurrentTimeArgument, CurrentUserArgument, CustomTypeId, DatasourceBranchId, DatasourceRid, DataValue, DatetimeAllowedValues, DatetimeFormat, DatetimeLocalizedFormat, DatetimeLocalizedFormatType, DatetimeStringFormat, DatetimeTimezone, DatetimeTimezoneStatic, DatetimeTimezoneUser, DateValue, DecryptionResult, DeleteEdit, DeleteInterfaceLinkLogicRule, DeleteInterfaceObjectRule, DeleteLink, DeleteLinkEdit, DeleteLinkLogicRule, DeleteLinkRule, DeleteObject, DeleteObjectEdit, DeleteObjectLogicRule, DeleteObjectRule, DeprecatedPropertyTypeStatus, DerivedPropertyApiName, DerivedPropertyDefinition, DerivedTimeSeriesProperty, DirectSourceRid, DisjunctiveMarkingSummary, DividePropertyExpression, DoesNotIntersectBoundingBoxQuery_2 as DoesNotIntersectBoundingBoxQuery, DoesNotIntersectPolygonQuery_2 as DoesNotIntersectPolygonQuery, DoubleValue, DoubleVector, Duration_2 as Duration, DurationBaseValue, DurationFormatStyle, DurationPrecision, EditHistoryEdit, EditOnlyPropertyMapping, EditsHistoryFilter, EditsHistoryOperationIdsFilter, EditsHistorySortOrder, EditsHistoryTimestampFilter, EditTypeFilter, EncryptionRequest, EncryptionResult, EntrySetType, EnumConstraint, EqualsQuery, EqualsQueryV2_2 as EqualsQueryV2, Error_2 as Error, ErrorComputingSecurity, ErrorName, ExactDistinctAggregationV2, ExamplePropertyTypeStatus, ExecuteQueryRequest, ExecuteQueryResponse, ExperimentalPropertyTypeStatus, ExtractDatePart, ExtractMainValueLoadLevel, ExtractPropertyExpression, FieldNameV1, FilterValue, FixedDatetimeValue, FixedValuesMapKey, FullTextStringContainsPredicate, FullTextStringExactPredicate, FullTextStringPredicateV2, FunctionLogicRule, FunctionParameterName, FunctionRid, FunctionRidActionTypesQueryV2, FunctionVersion, FuzzinessAuto, FuzzinessOff, Fuzzy, FuzzyRule, FuzzyV2_2 as FuzzyV2, GeoJsonString, GeoShapeV2Geometry, GeoShapeV2Query, GeotemporalSeriesEntry, GeotemporalSeriesProperty, GeotimeSeriesId, GeotimeSeriesIntegrationRid, GeotimeSeriesProperty, GeotimeSeriesValue, GetActionTypeByRidBatchRequest, GetActionTypeByRidBatchRequestElement, GetActionTypeByRidBatchResponse, GetActionTypeFullMetadataBatchRequest, GetActionTypeFullMetadataBatchRequestElement, GetActionTypeFullMetadataBatchResponse, GetObjectTypeByRidBatchRequest, GetObjectTypeByRidBatchRequestElement, GetObjectTypeByRidBatchResponse, GetObjectTypeFullMetadataBatchRequest, GetObjectTypeFullMetadataBatchRequestElement, GetObjectTypeFullMetadataBatchResponse, GetOutgoingLinkTypesByObjectTypeRidBatchRequest, GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement, GetOutgoingLinkTypesByObjectTypeRidBatchResponse, GetQueryTypeByRidBatchRequest, GetQueryTypeByRidBatchRequestElement, GetQueryTypeByRidBatchResponse, GetSelectedPropertyOperation, GreatestPropertyExpression, GroupMemberConstraint, GteQuery, GteQueryV2_2 as GteQueryV2, GtQuery, GtQueryV2_2 as GtQueryV2, HasActionLogActionTypesQueryV2, HasNotificationActionTypesQueryV2, HasWebhookActionTypesQueryV2, HumanReadableFormat, Icon, InputObjectTypeRidActionTypesQueryV2, InQuery_2 as InQuery, IntegerValue, InterfaceActionTypeConstraintApiName, InterfaceDefinedPropertyType, InterfaceLinkType, InterfaceLinkTypeApiName, InterfaceLinkTypeCardinality, InterfaceLinkTypeLinkedEntityApiName, InterfaceLinkTypeRid, InterfaceParameterPropertyArgument, InterfacePropertyApiName, InterfacePropertyLocalPropertyImplementation, InterfacePropertyReducedPropertyImplementation, InterfacePropertyStructFieldImplementation, InterfacePropertyStructImplementation, InterfacePropertyStructImplementationMapping, InterfacePropertyType, InterfacePropertyTypeImplementation, InterfacePropertyTypeRid, InterfaceSharedPropertyType, InterfaceToObjectTypeMapping, InterfaceToObjectTypeMappings, InterfaceToObjectTypeMappingsV2, InterfaceToObjectTypeMappingV2, InterfaceType, InterfaceTypeApiName, InterfaceTypeRid, IntersectsBoundingBoxQuery_2 as IntersectsBoundingBoxQuery, IntersectsPolygonQuery_2 as IntersectsPolygonQuery, IntervalQuery, IntervalQueryRule, IsNullQuery, IsNullQueryV2_2 as IsNullQueryV2, KnownType, LeastPropertyExpression, LegacyObjectTypeId, LegacyPropertyId, LengthConstraint, LinkedInterfaceTypeApiName, LinkedObjectLocator, LinkedObjectTypeApiName, LinkedObjectV2, LinksFromObject, LinkSideObject, LinksMessage, LinkState, LinkSubscriptionObjectLocator, LinkSubscriptionObjectLocators, LinkTypeApiName_2 as LinkTypeApiName, LinkTypeApiNames, LinkTypeId, LinkTypeRid, LinkTypeSide, LinkTypeSideCardinality, LinkTypeSideV2, LinkTypeSubscribeRequest, LinkTypeSubscribeRequests, LinkUpdate, LinkUpdates, ListActionTypesFullMetadataResponse, ListActionTypesResponse, ListActionTypesResponseV2, ListAttachmentsResponseV2, ListInterfaceLinkedObjectsResponse, ListInterfaceTypesResponse, ListLinkedObjectsResponse, ListLinkedObjectsResponseV2, ListObjectsForInterfaceResponse, ListObjectsResponse, ListObjectsResponseV2, ListObjectTypesResponse, ListObjectTypesV2Response, ListOntologiesResponse, ListOntologiesV2Response, ListOntologyValueTypesResponse, ListOutgoingInterfaceLinkTypesResponse, ListOutgoingLinkTypesResponse, ListOutgoingLinkTypesResponseV2, ListQueryTypesResponse, ListQueryTypesResponseV2, ListScenarioConflictingObjectsResponse, ListScenarioEditedEntityTypesResponse, ListScenarioEditedLinksResponse, ListScenarioEditedLinkTypesResponse, ListScenarioEditedObjectsResponse, ListScenarioEditedObjectTypesResponse, LoadGeotemporalSeriesRequest, LoadGeotemporalSeriesResponse, LoadObjectSetLinksRequestV2, LoadObjectSetLinksResponseV2, LoadObjectSetRequestV2, LoadObjectSetResponseV2, LoadObjectSetV2MultipleObjectTypesRequest, LoadObjectSetV2MultipleObjectTypesResponse, LoadObjectSetV2ObjectsOrInterfacesRequest, LoadObjectSetV2ObjectsOrInterfacesResponse, LoadOntologyMetadataRequest, LogicRule, LogicRuleActionTypesQueryV2, LogicRuleArgument, LongValue, LteQuery, LteQueryV2_2 as LteQueryV2, LtQuery, LtQueryV2_2 as LtQueryV2, MarkdownAllowedValues, MarkingId_2 as MarkingId, MatchRule, MaxAggregation, MaxAggregationV2, MediaMetadata_2 as MediaMetadata, MediaReferenceProperty, MethodObjectSet, MinAggregation, MinAggregationV2, ModifyEdit, ModifyInterfaceLogicRule, ModifyInterfaceObjectRule, ModifyObject, ModifyObjectEdit, ModifyObjectLogicRule, ModifyObjectRule, MultiplyPropertyExpression, MustBeEmptyAllowedValues, NearestNeighborsQuery, NearestNeighborsQueryText, NegatePropertyExpression, NestedInterfacePropertyTypeImplementation, NestedQueryAggregation, NoLoadLevel, NotQuery, NotQueryV2_2 as NotQueryV2, NowDatetimeValue, NumberFormatAffix, NumberFormatBasisPoints, NumberFormatCurrency, NumberFormatCurrencyStyle, NumberFormatCustomUnit, NumberFormatDuration, NumberFormatFixedValues, NumberFormatNotation, NumberFormatOptions, NumberFormatRatio, NumberFormatScale, NumberFormatStandard, NumberFormatStandardUnit, NumberRatioType, NumberRoundingMode, NumberScaleType, ObjectEdit, ObjectEditHistoryEntry, ObjectEdits, ObjectLoadingResponseOptions, ObjectLocator, ObjectParameterPropertyArgument, ObjectPrimaryKey, ObjectPrimaryKeyV2, ObjectPropertyType, ObjectPropertyValueConstraint, ObjectQueryResultConstraint, ObjectRid_2 as ObjectRid, ObjectSet_2 as ObjectSet, ObjectSetAsBaseObjectTypesType_2 as ObjectSetAsBaseObjectTypesType, ObjectSetAsTypeType_2 as ObjectSetAsTypeType, ObjectSetBaseType_2 as ObjectSetBaseType, ObjectSetFilterType_2 as ObjectSetFilterType, ObjectSetInterfaceBaseType_2 as ObjectSetInterfaceBaseType, ObjectSetInterfaceLinkSearchAroundType, ObjectSetIntersectionType_2 as ObjectSetIntersectionType, ObjectSetMethodInputType_2 as ObjectSetMethodInputType, ObjectSetNearestNeighborsType_2 as ObjectSetNearestNeighborsType, ObjectSetReferenceType_2 as ObjectSetReferenceType, ObjectSetRid_2 as ObjectSetRid, ObjectSetSearchAroundType_2 as ObjectSetSearchAroundType, ObjectSetStaticType_2 as ObjectSetStaticType, ObjectSetStreamSubscribeRequest, ObjectSetStreamSubscribeRequests, ObjectSetSubscribeResponse, ObjectSetSubscribeResponses, ObjectSetSubtractType_2 as ObjectSetSubtractType, ObjectSetUnionType_2 as ObjectSetUnionType, ObjectSetUpdate, ObjectSetUpdates, ObjectSetWithPropertiesType_2 as ObjectSetWithPropertiesType, ObjectState, ObjectType, ObjectTypeApiName, ObjectTypeDatasetDatasource, ObjectTypeDatasource, ObjectTypeDatasourceDefinition, ObjectTypeDirectDatasource, ObjectTypeEdits, ObjectTypeEditsHistoryRequest, ObjectTypeEditsHistoryResponse, ObjectTypeEditsOnlyDatasource, ObjectTypeFullMetadata, ObjectTypeGeotimeSeriesDatasource, ObjectTypeId_2 as ObjectTypeId, ObjectTypeInterfaceImplementation, ObjectTypeLinkTypeApiNameMapping, ObjectTypeMediaSetViewDatasource, ObjectTypeRestrictedViewDatasource, ObjectTypeRid_2 as ObjectTypeRid, ObjectTypeStreamDatasource, ObjectTypeTableDatasource, ObjectTypeTimeSeriesDatasource, ObjectTypeUnsupportedDatasource, ObjectTypeV2, ObjectTypeVisibility, ObjectUpdate, OneOfAllowedValues, OneOfConstraint, Ontology, OntologyApiName, OntologyArrayType, OntologyBase, OntologyBaseBranch, OntologyDataType, OntologyFullMetadata, OntologyIdentifier_2 as OntologyIdentifier, OntologyInterface, OntologyInterfaceObjectSetType, OntologyInterfaceObjectType, OntologyMapType, OntologyObject, OntologyObjectArrayType, OntologyObjectArrayTypeReducer, OntologyObjectArrayTypeReducerSortDirection, OntologyObjectSet, OntologyObjectSetType, OntologyObjectType, OntologyObjectTypeReferenceType, OntologyObjectV2, OntologyRid, OntologyScenario, OntologyScenarioRid, OntologySetType, OntologyStructField, OntologyStructType, OntologyTransaction, OntologyTransactionId, OntologyV2, OntologyValueType, OntologyVersion, OrActionTypesQueryV2, OrderBy, OrderByDirection_2 as OrderByDirection, OrQuery, OrQueryV2_2 as OrQueryV2, Parameter_2 as Parameter, ParameterAllowedValueOption, ParameterAllowedValues, ParameterArraySize, ParameterConstraintValue, ParameterDatetimeValue, ParameterEvaluatedConstraint, ParameterEvaluationResult, ParameterId_2 as ParameterId, ParameterIdArgument, ParameterNameActionTypesQueryV2, ParameterOption, ParameterRidActionTypesQueryV2, PermissionModelActionTypesQueryV2, PhraseQuery, Plaintext, PolygonValue_2 as PolygonValue, PostTransactionEditsRequest, PostTransactionEditsResponse, PreciseDuration, PreciseTimeUnit, PrefixOnLastTokenRule, PrefixQuery, PrimaryKeyPropertySelector, PrimaryKeyValue, PrimaryKeyValueV2, Property, PropertyApiName_2 as PropertyApiName, PropertyApiNameSelector_2 as PropertyApiNameSelector, PropertyBooleanFormattingRule, PropertyDateFormattingRule, PropertyFilter, PropertyId, PropertyIdentifier_2 as PropertyIdentifier, PropertyImplementation, PropertyKnownTypeFormattingRule, PropertyLoadLevel, PropertyMarkingSummary, PropertyNumberFormattingRule, PropertyNumberFormattingRuleType, PropertyOrStructFieldOfPropertyImplementation, PropertySecurities, PropertySecurity, PropertyTimestampFormattingRule, PropertyTypeApiName, PropertyTypeMappingInfo, PropertyTypeReference, PropertyTypeReferenceOrStringConstant, PropertyTypeRid_2 as PropertyTypeRid, PropertyTypeStatus, PropertyTypeVisibility, PropertyV2, PropertyValue_2 as PropertyValue, PropertyValueEscapedString, PropertyValueFormattingRule, PropertyWithLoadLevelSelector, QosError, QualifiedTimeseriesProperty, Query, QueryAggregation, QueryAggregationKeyType, QueryAggregationRange, QueryAggregationRangeSubType, QueryAggregationRangeType, QueryAggregationValueType, QueryApiName, QueryArrayType, QueryDataType, QueryOutputV2, QueryParameterV2, QueryRuntimeErrorParameter, QuerySetType, QueryStructField, QueryStructType, QueryThreeDimensionalAggregation, QueryTwoDimensionalAggregation, QueryType, QueryTypeReferenceType, QueryTypeV2, QueryUnionType, RangeAllowedValues, RangeConstraint, RangesConstraint, Reason, ReasonType, ReferenceSigningOptions, ReferenceUpdate, ReferenceValue, RefreshLinks, RefreshObjectSet, RegexConstraint, RegexQuery, RelativeDateRangeBound, RelativeDateRangeQuery, RelativeDatetimeDuration, RelativeDatetimeTense, RelativeDatetimeUnit, RelativeDatetimeValue, RelativePointInTime, RelativeTime, RelativeTimeRange, RelativeTimeRelation, RelativeTimeSeriesTimeUnit, RelativeTimeUnit, RequestId, ResolvedInterfacePropertyType, RestrictedViewRid, ReturnEditsMode, RevertActionEnabledActionTypesQueryV2, RidConstraint, RollingAggregateWindowPoints, SdkPackageName, SdkPackageRid, SdkVersion, SearchActionTypesOrderByV2, SearchActionTypesRequestV2, SearchActionTypesResponseV2, SearchJsonQuery, SearchJsonQueryV2_2 as SearchJsonQueryV2, SearchObjectsForInterfaceRequest, SearchObjectsRequest, SearchObjectsRequestV2, SearchObjectsResponse, SearchObjectsResponseV2, SearchOrderBy, SearchOrderByType, SearchOrderByV2, SearchOrdering, SearchOrderingV2, SectionRidActionTypesQueryV2, SecuredPropertyValue, SelectedPropertyApiName, SelectedPropertyApproximateDistinctAggregation, SelectedPropertyApproximatePercentileAggregation, SelectedPropertyAvgAggregation, SelectedPropertyCollectListAggregation, SelectedPropertyCollectSetAggregation, SelectedPropertyCountAggregation, SelectedPropertyExactDistinctAggregation, SelectedPropertyExpression, SelectedPropertyMaxAggregation, SelectedPropertyMinAggregation, SelectedPropertyOperation, SelectedPropertySumAggregation, SeriesId, SharedPropertyType, SharedPropertyTypeApiName, SharedPropertyTypeRid, SpatialFilterMode, StartsWithQuery_2 as StartsWithQuery, StaticArgument, StaticConstraintValue, StatusActionTypesQueryV2, StreamingOutputFormat, StreamMessage, StreamRid, StreamTimeSeriesPointsRequest, StreamTimeSeriesPointsResponse, StreamTimeSeriesValuesRequest, StreamTimeSeriesValuesResponse, StringConstant, StringLengthConstraint, StringRegexMatchConstraint, StringValue, StructConstraint, StructEvaluatedConstraint, StructFieldApiName_2 as StructFieldApiName, StructFieldArgument, StructFieldEvaluatedConstraint, StructFieldEvaluationResult, StructFieldOfPropertyImplementation, StructFieldPropertyMapping, StructFieldSelector_2 as StructFieldSelector, StructFieldType_2 as StructFieldType, StructFieldTypeRid, StructListParameterFieldArgument, StructParameterFieldApiName, StructParameterFieldArgument, StructPropertyMapping, StructType, StructTypeMainValue, SubmissionCriteriaEvaluation, SubscriptionClosed, SubscriptionClosureCause, SubscriptionError, SubscriptionId, SubscriptionSuccess, SubtractPropertyExpression, SumAggregation, SumAggregationV2, SyncApplyActionResponseV2, SynchronousWebhookOutputArgument, TableRid_2 as TableRid, TextAllowedValues, ThreeDimensionalAggregation, TimeCodeFormat, TimeRange, TimeSeriesAggregationMethod, TimeSeriesAggregationStrategy, TimeSeriesCumulativeAggregate, TimeseriesEntry, TimeSeriesPeriodicAggregate, TimeSeriesPoint, TimeSeriesPropertyV2, TimeSeriesRollingAggregate, TimeSeriesRollingAggregateWindow, TimeseriesSyncRid, TimeseriesTemplateRid, TimeseriesTemplateVersion, TimeSeriesValueBankProperty, TimeSeriesWindowType, TimestampValue, TimeUnit_2 as TimeUnit, TitlePropertySelector, TransactionEdit, TwoDimensionalAggregation, TypeClass, TypeClassesActionTypesQueryV2, TypeClassPredicateV2, TypeReferenceIdentifier, UnevaluableConstraint, UniqueIdentifierArgument, UniqueIdentifierLinkId, UniqueIdentifierValue, UnsupportedPolicy, UuidConstraint, ValidateActionRequest, ValidateActionResponse, ValidateActionResponseV2, ValidationResult, ValueType, ValueTypeAllowedValues, ValueTypeApiName, ValueTypeArrayType, ValueTypeConstraint, ValueTypeDecimalType, ValueTypeFieldType, ValueTypeMapType, ValueTypeOptionalType, ValueTypeReferenceType, ValueTypeRid, ValueTypeStatus, ValueTypeStructField, ValueTypeStructType, ValueTypeUnionType, ValueTypeVersionId, VersionedQueryTypeApiName, WebhookRid, WebhookRidActionTypesQueryV2, WildcardQuery, WithinBoundingBoxPoint_2 as WithinBoundingBoxPoint, WithinBoundingBoxQuery_2 as WithinBoundingBoxQuery, WithinDistanceOfQuery_2 as WithinDistanceOfQuery, WithinPolygonQuery_2 as WithinPolygonQuery, ActionContainsDuplicateEdits, ActionEditedPropertiesNotFound, ActionEditsNotSupportedWithMarketplace, ActionEditsReadOnlyEntity, ActionNotFound, ActionParameterInterfaceTypeNotFound, ActionParameterObjectNotFound, ActionParameterObjectTypeNotFound, ActionTypeNotFound, ActionValidationFailed, AggregationAccuracyNotSupported, AggregationDepthExceededLimit, AggregationGroupCountExceededLimit, AggregationMemoryExceededLimit, AggregationMetricNotSupported, AggregationNestedObjectSetSizeExceededLimit, ApplyActionFailed, AttachmentNotFound, AttachmentRidAlreadyExists, AttachmentSizeExceededLimit, BranchNotSupportedWithMarketplaceQuery, CipherChannelNotFound, CipherChannelNotResolvable, CompositePrimaryKeyNotSupported, ConsistentSnapshotError, DefaultAndNullGroupsNotSupported, DerivedPropertyApiNamesNotUnique, DistinctEnumValuesExceededLimit, DuplicateOrderBy, EditObjectPermissionDenied, FunctionEncounteredUserFacingError, FunctionExecutionFailed, FunctionExecutionTimedOut, FunctionInvalidInput, FunctionNotSupportedWithTransaction, HighScaleComputationNotEnabled, IncompatibleNestedObjectSet, InterfaceBasedObjectSetNotSupported, InterfaceLinkTypeNotFound, InterfacePropertiesHaveDifferentIds, InterfacePropertiesNotFound, InterfacePropertyNotFound, InterfaceTypeNotFound, InterfaceTypesNotFound, InvalidAggregationOrdering, InvalidAggregationOrderingWithNullValues, InvalidAggregationRange, InvalidAggregationRangePropertyType, InvalidAggregationRangePropertyTypeForInterface, InvalidAggregationRangeValue, InvalidAggregationRangeValueForInterface, InvalidApplyActionOptionCombination, InvalidContentLength, InvalidContentType, InvalidDerivedPropertyDefinition, InvalidDerivedPropertyDefinitionOnInterface, InvalidDurationGroupByPropertyType, InvalidDurationGroupByPropertyTypeForInterface, InvalidDurationGroupByValue, InvalidFields, InvalidGroupId, InvalidOrderType, InvalidParameterValue, InvalidPropertyFiltersCombination, InvalidPropertyFilterValue, InvalidPropertyType, InvalidPropertyValue, InvalidQueryOutputValue, InvalidQueryParameterValue, InvalidRangeQuery, InvalidSortOrder, InvalidSortType, InvalidTransactionEditPropertyValue, InvalidUserId, InvalidVectorDimension, LinkAlreadyExists, LinkedObjectNotFound, LinkTypeNotFound, LoadObjectSetLinksNotSupported, MalformedPropertyFilters, MarketplaceActionMappingNotFound, MarketplaceInstallationNotFound, MarketplaceLinkMappingNotFound, MarketplaceObjectMappingNotFound, MarketplaceQueryMappingNotFound, MarketplaceSdkActionMappingNotFound, MarketplaceSdkInstallationNotFound, MarketplaceSdkLinkMappingNotFound, MarketplaceSdkObjectMappingNotFound, MarketplaceSdkPropertyMappingNotFound, MarketplaceSdkQueryMappingNotFound, MediaUploadDestinationNotConfigured, MediaUploadPropertyNotBackedByMediaSetView, MissingParameter, MissingValueTypeReference, MultipleGroupByOnFieldNotSupported, MultipleMediaUploadDestinations, MultiplePropertyValuesNotSupported, NotCipherFormatted, ObjectAlreadyExists, ObjectChanged, ObjectEditMissingPrimaryKey, ObjectNotFound, ObjectSetNotFound, ObjectsExceededLimit, ObjectsModifiedConcurrently, ObjectTypeDerivedPropertyNotSupported, ObjectTypeNotFound, ObjectTypeNotSynced, ObjectTypesNotSynced, OntologyApiNameNotUnique, OntologyDefinitionOutOfSync, OntologyEditsExceededLimit, OntologyNotFound, OntologySyncing, OntologySyncingObjectTypes, ParameterObjectNotFound, ParameterObjectSetRidNotFound, ParametersNotFound, ParameterTypeNotSupported, ParentAttachmentPermissionDenied, PropertiesHaveDifferentIds, PropertiesNotFilterable, PropertiesNotFound, PropertiesNotSearchable, PropertiesNotSortable, PropertyApiNameNotFound, PropertyBaseTypeNotSupported, PropertyExactMatchingNotSupported, PropertyFiltersNotSupported, PropertyNotFound, PropertyNotFoundOnObject, PropertyTypeDoesNotSupportNearestNeighbors, PropertyTypeNotFound, PropertyTypeRidNotFound, PropertyTypesSearchNotSupported, QueryEncounteredUserFacingError, QueryMemoryExceededLimit, QueryNotFound, QueryRuntimeError, QueryTimeExceededLimit, QueryVersionNotFound, RateLimitReached, SharedPropertiesNotFound, SharedPropertyTypeNotFound, SimilarityThresholdOutOfRange, TooManyNearestNeighborsRequested, UnauthorizedCipherOperation, UndecryptableValue, UniqueIdentifierLinkIdsDoNotExistInActionType, UnknownParameter, UnsupportedInterfaceBasedObjectSet, UnsupportedObjectSet, ValueTypeNotFound, ViewObjectPermissionDenied, Actions, ActionTypesFullMetadata, ActionTypesV2, Attachments, AttachmentPropertiesV2, CipherTextProperties, GeotemporalSeriesProperties, LinkedObjectsV2, MediaReferenceProperties, ObjectTypesV2, OntologyInterfaces, OntologyObjectSets, OntologyObjectsV2, OntologyScenarios, OntologyTransactions, OntologiesV2, OntologyValueTypes, Queries, QueryTypes, TimeSeriesPropertiesV2, TimeSeriesValueBankProperties } } declare namespace _Ontologies { export { AbsoluteTimeRange, AbsoluteValuePropertyExpression, Action, ActionExecutionTime, ActionLogicRule, ActionMode, ActionParameterArrayType, ActionParameterRid, ActionParameterType, ActionParameterV2, ActionParameterValidation, ActionParameterValidationBlock, ActionResults, ActionRid, ActionSectionRid, ActionType, ActionTypeApiName, ActionTypeApiNameActionTypesQueryV2, ActionTypeDescriptionActionTypesQueryV2, ActionTypeDisplayNameActionTypesQueryV2, ActionTypeFullMetadata, ActionTypeFuzziness, ActionTypeLogicRuleTypeFilter, ActionTypePermissionModelFilter, ActionTypeRid, ActionTypeRidActionTypesQueryV2, ActionTypeSearchJsonQueryV2, ActionTypeSortByV2, ActionTypeStatusFilter, ActionTypeV2, ActivePropertyTypeStatus, AddLink, AddLinkEdit, AddObject, AddObjectEdit, AddPropertyExpression, AffectedInterfaceTypeRidActionTypesQueryV2, AffectedLinkTypeRidActionTypesQueryV2, AffectedObjectTypeRidActionTypesQueryV2, Affix, AggregateObjectSetRequestV2, AggregateObjectsRequest, AggregateObjectsRequestV2, AggregateObjectsResponse, AggregateObjectsResponseItem, AggregateObjectsResponseItemV2, AggregateObjectsResponseV2, AggregateTimeSeries, Aggregation, AggregationAccuracy, AggregationAccuracyRequest, AggregationDurationGrouping, AggregationDurationGroupingV2, AggregationExactGrouping, AggregationExactGroupingV2, AggregationFixedWidthGrouping, AggregationFixedWidthGroupingV2, AggregationGroupBy, AggregationGroupByV2, AggregationGroupKey, AggregationGroupKeyV2, AggregationGroupValue, AggregationGroupValueV2, AggregationMetricName, AggregationMetricResult, AggregationMetricResultV2, AggregationObjectTypeGrouping, AggregationOrderBy, AggregationRange, AggregationRangesGrouping, AggregationRangesGroupingV2, AggregationRangeV2, AggregationV2, AllOfRule, AllTermsQuery, AndActionTypesQueryV2, AndQuery, AndQueryV2_2 as AndQueryV2, AnyOfRule, AnyTermQuery, ApplyActionMode, ApplyActionOverrides, ApplyActionRequest, ApplyActionRequestOptions, ApplyActionRequestV2, ApplyActionResponse, ApplyActionWithOverridesRequest, ApplyReducersAndExtractMainValueLoadLevel, ApplyReducersLoadLevel, ApplyScenarioLogicRule, ApplyScenarioRule, ApproximateDistinctAggregation, ApproximateDistinctAggregationV2, ApproximatePercentileAggregationV2, Arg, ArrayConstraint, ArrayEntryEvaluatedConstraint, ArrayEvaluatedConstraint, ArraySizeConstraint, ArtifactRepositoryRid, AsyncActionOperation, AsyncActionStatus, AsyncApplyActionOperationResponseV2, AsyncApplyActionOperationV2, AsyncApplyActionRequest, AsyncApplyActionRequestV2, AsyncApplyActionResponse, AsyncApplyActionResponseV2, Attachment, AttachmentAllowedValues, AttachmentMetadataResponse, AttachmentProperty, AttachmentPropertyV2, AttachmentRid, AttachmentV2, AvgAggregation, AvgAggregationV2, BatchActionObjectEdit, BatchActionObjectEdits, BatchActionResults, BatchApplyActionRequest, BatchApplyActionRequestItem, BatchApplyActionRequestItemWithOverrides, BatchApplyActionRequestOptions, BatchApplyActionRequestV2, BatchApplyActionResponse, BatchApplyActionResponseV2, BatchApplyActionWithOverridesRequest, BatchedFunctionLogicRule, BatchReturnEditsMode, BlueprintIcon, BooleanValue, BoundingBoxValue_2 as BoundingBoxValue, CenterPoint_2 as CenterPoint, CenterPointTypes_2 as CenterPointTypes, CipherChannelStrategy, CipherText, CipherTextProperty, ColumnName_2 as ColumnName, ColumnPropertyMapping, ConjunctiveMarkingSummary, ContainerConjunctiveMarkingSummary, ContainerDisjunctiveMarkingSummary, ContainsAllTermsInOrderPrefixLastTerm_2 as ContainsAllTermsInOrderPrefixLastTerm, ContainsAllTermsInOrderQuery_2 as ContainsAllTermsInOrderQuery, ContainsAllTermsQuery_2 as ContainsAllTermsQuery, ContainsAnyTermQuery_2 as ContainsAnyTermQuery, ContainsQuery, ContainsQueryV2_2 as ContainsQueryV2, CountAggregation, CountAggregationV2, CountObjectsResponseV2, CreateEdit, CreateInterfaceLinkLogicRule, CreateInterfaceLogicRule, CreateInterfaceObjectRule, CreateLinkLogicRule, CreateLinkRule, CreateObjectLogicRule, CreateObjectRule, CreateOntologyScenarioRequest, CreateOntologyScenarioResponse, CreateOrModifyObjectLogicRule, CreateOrModifyObjectLogicRuleV2, CreateTemporaryObjectSetRequestV2, CreateTemporaryObjectSetResponseV2, CurrentTimeArgument, CurrentUserArgument, CustomTypeId, DatasourceBranchId, DatasourceRid, DataValue, DatetimeAllowedValues, DatetimeFormat, DatetimeLocalizedFormat, DatetimeLocalizedFormatType, DatetimeStringFormat, DatetimeTimezone, DatetimeTimezoneStatic, DatetimeTimezoneUser, DateValue, DecryptionResult, DeleteEdit, DeleteInterfaceLinkLogicRule, DeleteInterfaceObjectRule, DeleteLink, DeleteLinkEdit, DeleteLinkLogicRule, DeleteLinkRule, DeleteObject, DeleteObjectEdit, DeleteObjectLogicRule, DeleteObjectRule, DeprecatedPropertyTypeStatus, DerivedPropertyApiName, DerivedPropertyDefinition, DerivedTimeSeriesProperty, DirectSourceRid, DisjunctiveMarkingSummary, DividePropertyExpression, DoesNotIntersectBoundingBoxQuery_2 as DoesNotIntersectBoundingBoxQuery, DoesNotIntersectPolygonQuery_2 as DoesNotIntersectPolygonQuery, DoubleValue, DoubleVector, Duration_2 as Duration, DurationBaseValue, DurationFormatStyle, DurationPrecision, EditHistoryEdit, EditOnlyPropertyMapping, EditsHistoryFilter, EditsHistoryOperationIdsFilter, EditsHistorySortOrder, EditsHistoryTimestampFilter, EditTypeFilter, EncryptionRequest, EncryptionResult, EntrySetType, EnumConstraint, EqualsQuery, EqualsQueryV2_2 as EqualsQueryV2, Error_2 as Error, ErrorComputingSecurity, ErrorName, ExactDistinctAggregationV2, ExamplePropertyTypeStatus, ExecuteQueryRequest, ExecuteQueryResponse, ExperimentalPropertyTypeStatus, ExtractDatePart, ExtractMainValueLoadLevel, ExtractPropertyExpression, FieldNameV1, FilterValue, FixedDatetimeValue, FixedValuesMapKey, FullTextStringContainsPredicate, FullTextStringExactPredicate, FullTextStringPredicateV2, FunctionLogicRule, FunctionParameterName, FunctionRid, FunctionRidActionTypesQueryV2, FunctionVersion, FuzzinessAuto, FuzzinessOff, Fuzzy, FuzzyRule, FuzzyV2_2 as FuzzyV2, GeoJsonString, GeoShapeV2Geometry, GeoShapeV2Query, GeotemporalSeriesEntry, GeotemporalSeriesProperty, GeotimeSeriesId, GeotimeSeriesIntegrationRid, GeotimeSeriesProperty, GeotimeSeriesValue, GetActionTypeByRidBatchRequest, GetActionTypeByRidBatchRequestElement, GetActionTypeByRidBatchResponse, GetActionTypeFullMetadataBatchRequest, GetActionTypeFullMetadataBatchRequestElement, GetActionTypeFullMetadataBatchResponse, GetObjectTypeByRidBatchRequest, GetObjectTypeByRidBatchRequestElement, GetObjectTypeByRidBatchResponse, GetObjectTypeFullMetadataBatchRequest, GetObjectTypeFullMetadataBatchRequestElement, GetObjectTypeFullMetadataBatchResponse, GetOutgoingLinkTypesByObjectTypeRidBatchRequest, GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement, GetOutgoingLinkTypesByObjectTypeRidBatchResponse, GetQueryTypeByRidBatchRequest, GetQueryTypeByRidBatchRequestElement, GetQueryTypeByRidBatchResponse, GetSelectedPropertyOperation, GreatestPropertyExpression, GroupMemberConstraint, GteQuery, GteQueryV2_2 as GteQueryV2, GtQuery, GtQueryV2_2 as GtQueryV2, HasActionLogActionTypesQueryV2, HasNotificationActionTypesQueryV2, HasWebhookActionTypesQueryV2, HumanReadableFormat, Icon, InputObjectTypeRidActionTypesQueryV2, InQuery_2 as InQuery, IntegerValue, InterfaceActionTypeConstraintApiName, InterfaceDefinedPropertyType, InterfaceLinkType, InterfaceLinkTypeApiName, InterfaceLinkTypeCardinality, InterfaceLinkTypeLinkedEntityApiName, InterfaceLinkTypeRid, InterfaceParameterPropertyArgument, InterfacePropertyApiName, InterfacePropertyLocalPropertyImplementation, InterfacePropertyReducedPropertyImplementation, InterfacePropertyStructFieldImplementation, InterfacePropertyStructImplementation, InterfacePropertyStructImplementationMapping, InterfacePropertyType, InterfacePropertyTypeImplementation, InterfacePropertyTypeRid, InterfaceSharedPropertyType, InterfaceToObjectTypeMapping, InterfaceToObjectTypeMappings, InterfaceToObjectTypeMappingsV2, InterfaceToObjectTypeMappingV2, InterfaceType, InterfaceTypeApiName, InterfaceTypeRid, IntersectsBoundingBoxQuery_2 as IntersectsBoundingBoxQuery, IntersectsPolygonQuery_2 as IntersectsPolygonQuery, IntervalQuery, IntervalQueryRule, IsNullQuery, IsNullQueryV2_2 as IsNullQueryV2, KnownType, LeastPropertyExpression, LegacyObjectTypeId, LegacyPropertyId, LengthConstraint, LinkedInterfaceTypeApiName, LinkedObjectLocator, LinkedObjectTypeApiName, LinkedObjectV2, LinksFromObject, LinkSideObject, LinksMessage, LinkState, LinkSubscriptionObjectLocator, LinkSubscriptionObjectLocators, LinkTypeApiName_2 as LinkTypeApiName, LinkTypeApiNames, LinkTypeId, LinkTypeRid, LinkTypeSide, LinkTypeSideCardinality, LinkTypeSideV2, LinkTypeSubscribeRequest, LinkTypeSubscribeRequests, LinkUpdate, LinkUpdates, ListActionTypesFullMetadataResponse, ListActionTypesResponse, ListActionTypesResponseV2, ListAttachmentsResponseV2, ListInterfaceLinkedObjectsResponse, ListInterfaceTypesResponse, ListLinkedObjectsResponse, ListLinkedObjectsResponseV2, ListObjectsForInterfaceResponse, ListObjectsResponse, ListObjectsResponseV2, ListObjectTypesResponse, ListObjectTypesV2Response, ListOntologiesResponse, ListOntologiesV2Response, ListOntologyValueTypesResponse, ListOutgoingInterfaceLinkTypesResponse, ListOutgoingLinkTypesResponse, ListOutgoingLinkTypesResponseV2, ListQueryTypesResponse, ListQueryTypesResponseV2, ListScenarioConflictingObjectsResponse, ListScenarioEditedEntityTypesResponse, ListScenarioEditedLinksResponse, ListScenarioEditedLinkTypesResponse, ListScenarioEditedObjectsResponse, ListScenarioEditedObjectTypesResponse, LoadGeotemporalSeriesRequest, LoadGeotemporalSeriesResponse, LoadObjectSetLinksRequestV2, LoadObjectSetLinksResponseV2, LoadObjectSetRequestV2, LoadObjectSetResponseV2, LoadObjectSetV2MultipleObjectTypesRequest, LoadObjectSetV2MultipleObjectTypesResponse, LoadObjectSetV2ObjectsOrInterfacesRequest, LoadObjectSetV2ObjectsOrInterfacesResponse, LoadOntologyMetadataRequest, LogicRule, LogicRuleActionTypesQueryV2, LogicRuleArgument, LongValue, LteQuery, LteQueryV2_2 as LteQueryV2, LtQuery, LtQueryV2_2 as LtQueryV2, MarkdownAllowedValues, MarkingId_2 as MarkingId, MatchRule, MaxAggregation, MaxAggregationV2, MediaMetadata_2 as MediaMetadata, MediaReferenceProperty, MethodObjectSet, MinAggregation, MinAggregationV2, ModifyEdit, ModifyInterfaceLogicRule, ModifyInterfaceObjectRule, ModifyObject, ModifyObjectEdit, ModifyObjectLogicRule, ModifyObjectRule, MultiplyPropertyExpression, MustBeEmptyAllowedValues, NearestNeighborsQuery, NearestNeighborsQueryText, NegatePropertyExpression, NestedInterfacePropertyTypeImplementation, NestedQueryAggregation, NoLoadLevel, NotQuery, NotQueryV2_2 as NotQueryV2, NowDatetimeValue, NumberFormatAffix, NumberFormatBasisPoints, NumberFormatCurrency, NumberFormatCurrencyStyle, NumberFormatCustomUnit, NumberFormatDuration, NumberFormatFixedValues, NumberFormatNotation, NumberFormatOptions, NumberFormatRatio, NumberFormatScale, NumberFormatStandard, NumberFormatStandardUnit, NumberRatioType, NumberRoundingMode, NumberScaleType, ObjectEdit, ObjectEditHistoryEntry, ObjectEdits, ObjectLoadingResponseOptions, ObjectLocator, ObjectParameterPropertyArgument, ObjectPrimaryKey, ObjectPrimaryKeyV2, ObjectPropertyType, ObjectPropertyValueConstraint, ObjectQueryResultConstraint, ObjectRid_2 as ObjectRid, ObjectSet_2 as ObjectSet, ObjectSetAsBaseObjectTypesType_2 as ObjectSetAsBaseObjectTypesType, ObjectSetAsTypeType_2 as ObjectSetAsTypeType, ObjectSetBaseType_2 as ObjectSetBaseType, ObjectSetFilterType_2 as ObjectSetFilterType, ObjectSetInterfaceBaseType_2 as ObjectSetInterfaceBaseType, ObjectSetInterfaceLinkSearchAroundType, ObjectSetIntersectionType_2 as ObjectSetIntersectionType, ObjectSetMethodInputType_2 as ObjectSetMethodInputType, ObjectSetNearestNeighborsType_2 as ObjectSetNearestNeighborsType, ObjectSetReferenceType_2 as ObjectSetReferenceType, ObjectSetRid_2 as ObjectSetRid, ObjectSetSearchAroundType_2 as ObjectSetSearchAroundType, ObjectSetStaticType_2 as ObjectSetStaticType, ObjectSetStreamSubscribeRequest, ObjectSetStreamSubscribeRequests, ObjectSetSubscribeResponse, ObjectSetSubscribeResponses, ObjectSetSubtractType_2 as ObjectSetSubtractType, ObjectSetUnionType_2 as ObjectSetUnionType, ObjectSetUpdate, ObjectSetUpdates, ObjectSetWithPropertiesType_2 as ObjectSetWithPropertiesType, ObjectState, ObjectType, ObjectTypeApiName, ObjectTypeDatasetDatasource, ObjectTypeDatasource, ObjectTypeDatasourceDefinition, ObjectTypeDirectDatasource, ObjectTypeEdits, ObjectTypeEditsHistoryRequest, ObjectTypeEditsHistoryResponse, ObjectTypeEditsOnlyDatasource, ObjectTypeFullMetadata, ObjectTypeGeotimeSeriesDatasource, ObjectTypeId_2 as ObjectTypeId, ObjectTypeInterfaceImplementation, ObjectTypeLinkTypeApiNameMapping, ObjectTypeMediaSetViewDatasource, ObjectTypeRestrictedViewDatasource, ObjectTypeRid_2 as ObjectTypeRid, ObjectTypeStreamDatasource, ObjectTypeTableDatasource, ObjectTypeTimeSeriesDatasource, ObjectTypeUnsupportedDatasource, ObjectTypeV2, ObjectTypeVisibility, ObjectUpdate, OneOfAllowedValues, OneOfConstraint, Ontology, OntologyApiName, OntologyArrayType, OntologyBase, OntologyBaseBranch, OntologyDataType, OntologyFullMetadata, OntologyIdentifier_2 as OntologyIdentifier, OntologyInterface, OntologyInterfaceObjectSetType, OntologyInterfaceObjectType, OntologyMapType, OntologyObject, OntologyObjectArrayType, OntologyObjectArrayTypeReducer, OntologyObjectArrayTypeReducerSortDirection, OntologyObjectSet, OntologyObjectSetType, OntologyObjectType, OntologyObjectTypeReferenceType, OntologyObjectV2, OntologyRid, OntologyScenario, OntologyScenarioRid, OntologySetType, OntologyStructField, OntologyStructType, OntologyTransaction, OntologyTransactionId, OntologyV2, OntologyValueType, OntologyVersion, OrActionTypesQueryV2, OrderBy, OrderByDirection_2 as OrderByDirection, OrQuery, OrQueryV2_2 as OrQueryV2, Parameter_2 as Parameter, ParameterAllowedValueOption, ParameterAllowedValues, ParameterArraySize, ParameterConstraintValue, ParameterDatetimeValue, ParameterEvaluatedConstraint, ParameterEvaluationResult, ParameterId_2 as ParameterId, ParameterIdArgument, ParameterNameActionTypesQueryV2, ParameterOption, ParameterRidActionTypesQueryV2, PermissionModelActionTypesQueryV2, PhraseQuery, Plaintext, PolygonValue_2 as PolygonValue, PostTransactionEditsRequest, PostTransactionEditsResponse, PreciseDuration, PreciseTimeUnit, PrefixOnLastTokenRule, PrefixQuery, PrimaryKeyPropertySelector, PrimaryKeyValue, PrimaryKeyValueV2, Property, PropertyApiName_2 as PropertyApiName, PropertyApiNameSelector_2 as PropertyApiNameSelector, PropertyBooleanFormattingRule, PropertyDateFormattingRule, PropertyFilter, PropertyId, PropertyIdentifier_2 as PropertyIdentifier, PropertyImplementation, PropertyKnownTypeFormattingRule, PropertyLoadLevel, PropertyMarkingSummary, PropertyNumberFormattingRule, PropertyNumberFormattingRuleType, PropertyOrStructFieldOfPropertyImplementation, PropertySecurities, PropertySecurity, PropertyTimestampFormattingRule, PropertyTypeApiName, PropertyTypeMappingInfo, PropertyTypeReference, PropertyTypeReferenceOrStringConstant, PropertyTypeRid_2 as PropertyTypeRid, PropertyTypeStatus, PropertyTypeVisibility, PropertyV2, PropertyValue_2 as PropertyValue, PropertyValueEscapedString, PropertyValueFormattingRule, PropertyWithLoadLevelSelector, QosError, QualifiedTimeseriesProperty, Query, QueryAggregation, QueryAggregationKeyType, QueryAggregationRange, QueryAggregationRangeSubType, QueryAggregationRangeType, QueryAggregationValueType, QueryApiName, QueryArrayType, QueryDataType, QueryOutputV2, QueryParameterV2, QueryRuntimeErrorParameter, QuerySetType, QueryStructField, QueryStructType, QueryThreeDimensionalAggregation, QueryTwoDimensionalAggregation, QueryType, QueryTypeReferenceType, QueryTypeV2, QueryUnionType, RangeAllowedValues, RangeConstraint, RangesConstraint, Reason, ReasonType, ReferenceSigningOptions, ReferenceUpdate, ReferenceValue, RefreshLinks, RefreshObjectSet, RegexConstraint, RegexQuery, RelativeDateRangeBound, RelativeDateRangeQuery, RelativeDatetimeDuration, RelativeDatetimeTense, RelativeDatetimeUnit, RelativeDatetimeValue, RelativePointInTime, RelativeTime, RelativeTimeRange, RelativeTimeRelation, RelativeTimeSeriesTimeUnit, RelativeTimeUnit, RequestId, ResolvedInterfacePropertyType, RestrictedViewRid, ReturnEditsMode, RevertActionEnabledActionTypesQueryV2, RidConstraint, RollingAggregateWindowPoints, SdkPackageName, SdkPackageRid, SdkVersion, SearchActionTypesOrderByV2, SearchActionTypesRequestV2, SearchActionTypesResponseV2, SearchJsonQuery, SearchJsonQueryV2_2 as SearchJsonQueryV2, SearchObjectsForInterfaceRequest, SearchObjectsRequest, SearchObjectsRequestV2, SearchObjectsResponse, SearchObjectsResponseV2, SearchOrderBy, SearchOrderByType, SearchOrderByV2, SearchOrdering, SearchOrderingV2, SectionRidActionTypesQueryV2, SecuredPropertyValue, SelectedPropertyApiName, SelectedPropertyApproximateDistinctAggregation, SelectedPropertyApproximatePercentileAggregation, SelectedPropertyAvgAggregation, SelectedPropertyCollectListAggregation, SelectedPropertyCollectSetAggregation, SelectedPropertyCountAggregation, SelectedPropertyExactDistinctAggregation, SelectedPropertyExpression, SelectedPropertyMaxAggregation, SelectedPropertyMinAggregation, SelectedPropertyOperation, SelectedPropertySumAggregation, SeriesId, SharedPropertyType, SharedPropertyTypeApiName, SharedPropertyTypeRid, SpatialFilterMode, StartsWithQuery_2 as StartsWithQuery, StaticArgument, StaticConstraintValue, StatusActionTypesQueryV2, StreamingOutputFormat, StreamMessage, StreamRid, StreamTimeSeriesPointsRequest, StreamTimeSeriesPointsResponse, StreamTimeSeriesValuesRequest, StreamTimeSeriesValuesResponse, StringConstant, StringLengthConstraint, StringRegexMatchConstraint, StringValue, StructConstraint, StructEvaluatedConstraint, StructFieldApiName_2 as StructFieldApiName, StructFieldArgument, StructFieldEvaluatedConstraint, StructFieldEvaluationResult, StructFieldOfPropertyImplementation, StructFieldPropertyMapping, StructFieldSelector_2 as StructFieldSelector, StructFieldType_2 as StructFieldType, StructFieldTypeRid, StructListParameterFieldArgument, StructParameterFieldApiName, StructParameterFieldArgument, StructPropertyMapping, StructType, StructTypeMainValue, SubmissionCriteriaEvaluation, SubscriptionClosed, SubscriptionClosureCause, SubscriptionError, SubscriptionId, SubscriptionSuccess, SubtractPropertyExpression, SumAggregation, SumAggregationV2, SyncApplyActionResponseV2, SynchronousWebhookOutputArgument, TableRid_2 as TableRid, TextAllowedValues, ThreeDimensionalAggregation, TimeCodeFormat, TimeRange, TimeSeriesAggregationMethod, TimeSeriesAggregationStrategy, TimeSeriesCumulativeAggregate, TimeseriesEntry, TimeSeriesPeriodicAggregate, TimeSeriesPoint, TimeSeriesPropertyV2, TimeSeriesRollingAggregate, TimeSeriesRollingAggregateWindow, TimeseriesSyncRid, TimeseriesTemplateRid, TimeseriesTemplateVersion, TimeSeriesValueBankProperty, TimeSeriesWindowType, TimestampValue, TimeUnit_2 as TimeUnit, TitlePropertySelector, TransactionEdit, TwoDimensionalAggregation, TypeClass, TypeClassesActionTypesQueryV2, TypeClassPredicateV2, TypeReferenceIdentifier, UnevaluableConstraint, UniqueIdentifierArgument, UniqueIdentifierLinkId, UniqueIdentifierValue, UnsupportedPolicy, UuidConstraint, ValidateActionRequest, ValidateActionResponse, ValidateActionResponseV2, ValidationResult, ValueType, ValueTypeAllowedValues, ValueTypeApiName, ValueTypeArrayType, ValueTypeConstraint, ValueTypeDecimalType, ValueTypeFieldType, ValueTypeMapType, ValueTypeOptionalType, ValueTypeReferenceType, ValueTypeRid, ValueTypeStatus, ValueTypeStructField, ValueTypeStructType, ValueTypeUnionType, ValueTypeVersionId, VersionedQueryTypeApiName, WebhookRid, WebhookRidActionTypesQueryV2, WildcardQuery, WithinBoundingBoxPoint_2 as WithinBoundingBoxPoint, WithinBoundingBoxQuery_2 as WithinBoundingBoxQuery, WithinDistanceOfQuery_2 as WithinDistanceOfQuery, WithinPolygonQuery_2 as WithinPolygonQuery, ActionContainsDuplicateEdits, ActionEditedPropertiesNotFound, ActionEditsNotSupportedWithMarketplace, ActionEditsReadOnlyEntity, ActionNotFound, ActionParameterInterfaceTypeNotFound, ActionParameterObjectNotFound, ActionParameterObjectTypeNotFound, ActionTypeNotFound, ActionValidationFailed, AggregationAccuracyNotSupported, AggregationDepthExceededLimit, AggregationGroupCountExceededLimit, AggregationMemoryExceededLimit, AggregationMetricNotSupported, AggregationNestedObjectSetSizeExceededLimit, ApplyActionFailed, AttachmentNotFound, AttachmentRidAlreadyExists, AttachmentSizeExceededLimit, BranchNotSupportedWithMarketplaceQuery, CipherChannelNotFound, CipherChannelNotResolvable, CompositePrimaryKeyNotSupported, ConsistentSnapshotError, DefaultAndNullGroupsNotSupported, DerivedPropertyApiNamesNotUnique, DistinctEnumValuesExceededLimit, DuplicateOrderBy, EditObjectPermissionDenied, FunctionEncounteredUserFacingError, FunctionExecutionFailed, FunctionExecutionTimedOut, FunctionInvalidInput, FunctionNotSupportedWithTransaction, HighScaleComputationNotEnabled, IncompatibleNestedObjectSet, InterfaceBasedObjectSetNotSupported, InterfaceLinkTypeNotFound, InterfacePropertiesHaveDifferentIds, InterfacePropertiesNotFound, InterfacePropertyNotFound, InterfaceTypeNotFound, InterfaceTypesNotFound, InvalidAggregationOrdering, InvalidAggregationOrderingWithNullValues, InvalidAggregationRange, InvalidAggregationRangePropertyType, InvalidAggregationRangePropertyTypeForInterface, InvalidAggregationRangeValue, InvalidAggregationRangeValueForInterface, InvalidApplyActionOptionCombination, InvalidContentLength, InvalidContentType, InvalidDerivedPropertyDefinition, InvalidDerivedPropertyDefinitionOnInterface, InvalidDurationGroupByPropertyType, InvalidDurationGroupByPropertyTypeForInterface, InvalidDurationGroupByValue, InvalidFields, InvalidGroupId, InvalidOrderType, InvalidParameterValue, InvalidPropertyFiltersCombination, InvalidPropertyFilterValue, InvalidPropertyType, InvalidPropertyValue, InvalidQueryOutputValue, InvalidQueryParameterValue, InvalidRangeQuery, InvalidSortOrder, InvalidSortType, InvalidTransactionEditPropertyValue, InvalidUserId, InvalidVectorDimension, LinkAlreadyExists, LinkedObjectNotFound, LinkTypeNotFound, LoadObjectSetLinksNotSupported, MalformedPropertyFilters, MarketplaceActionMappingNotFound, MarketplaceInstallationNotFound, MarketplaceLinkMappingNotFound, MarketplaceObjectMappingNotFound, MarketplaceQueryMappingNotFound, MarketplaceSdkActionMappingNotFound, MarketplaceSdkInstallationNotFound, MarketplaceSdkLinkMappingNotFound, MarketplaceSdkObjectMappingNotFound, MarketplaceSdkPropertyMappingNotFound, MarketplaceSdkQueryMappingNotFound, MediaUploadDestinationNotConfigured, MediaUploadPropertyNotBackedByMediaSetView, MissingParameter, MissingValueTypeReference, MultipleGroupByOnFieldNotSupported, MultipleMediaUploadDestinations, MultiplePropertyValuesNotSupported, NotCipherFormatted, ObjectAlreadyExists, ObjectChanged, ObjectEditMissingPrimaryKey, ObjectNotFound, ObjectSetNotFound, ObjectsExceededLimit, ObjectsModifiedConcurrently, ObjectTypeDerivedPropertyNotSupported, ObjectTypeNotFound, ObjectTypeNotSynced, ObjectTypesNotSynced, OntologyApiNameNotUnique, OntologyDefinitionOutOfSync, OntologyEditsExceededLimit, OntologyNotFound, OntologySyncing, OntologySyncingObjectTypes, ParameterObjectNotFound, ParameterObjectSetRidNotFound, ParametersNotFound, ParameterTypeNotSupported, ParentAttachmentPermissionDenied, PropertiesHaveDifferentIds, PropertiesNotFilterable, PropertiesNotFound, PropertiesNotSearchable, PropertiesNotSortable, PropertyApiNameNotFound, PropertyBaseTypeNotSupported, PropertyExactMatchingNotSupported, PropertyFiltersNotSupported, PropertyNotFound, PropertyNotFoundOnObject, PropertyTypeDoesNotSupportNearestNeighbors, PropertyTypeNotFound, PropertyTypeRidNotFound, PropertyTypesSearchNotSupported, QueryEncounteredUserFacingError, QueryMemoryExceededLimit, QueryNotFound, QueryRuntimeError, QueryTimeExceededLimit, QueryVersionNotFound, RateLimitReached, SharedPropertiesNotFound, SharedPropertyTypeNotFound, SimilarityThresholdOutOfRange, TooManyNearestNeighborsRequested, UnauthorizedCipherOperation, UndecryptableValue, UniqueIdentifierLinkIdsDoNotExistInActionType, UnknownParameter, UnsupportedInterfaceBasedObjectSet, UnsupportedObjectSet, ValueTypeNotFound, ViewObjectPermissionDenied, Actions, ActionTypesFullMetadata, ActionTypesV2, Attachments, AttachmentPropertiesV2, CipherTextProperties, GeotemporalSeriesProperties, LinkedObjectsV2, MediaReferenceProperties, ObjectTypesV2, OntologyInterfaces, OntologyObjectSets, OntologyObjectsV2, OntologyScenarios, OntologyTransactions, OntologiesV2, OntologyValueTypes, Queries, QueryTypes, TimeSeriesPropertiesV2, TimeSeriesValueBankProperties } } declare namespace _Ontologies_2 { export { LooselyBrandedString_5 as LooselyBrandedString, AbsoluteTimeRange, AbsoluteValuePropertyExpression, Action, ActionExecutionTime, ActionLogicRule, ActionMode, ActionParameterArrayType, ActionParameterRid, ActionParameterType, ActionParameterV2, ActionParameterValidation, ActionParameterValidationBlock, ActionResults, ActionRid, ActionSectionRid, ActionType, ActionTypeApiName, ActionTypeApiNameActionTypesQueryV2, ActionTypeDescriptionActionTypesQueryV2, ActionTypeDisplayNameActionTypesQueryV2, ActionTypeFullMetadata, ActionTypeFuzziness, ActionTypeLogicRuleTypeFilter, ActionTypePermissionModelFilter, ActionTypeRid, ActionTypeRidActionTypesQueryV2, ActionTypeSearchJsonQueryV2, ActionTypeSortByV2, ActionTypeStatusFilter, ActionTypeV2, ActivePropertyTypeStatus, AddLink, AddLinkEdit, AddObject, AddObjectEdit, AddPropertyExpression, AffectedInterfaceTypeRidActionTypesQueryV2, AffectedLinkTypeRidActionTypesQueryV2, AffectedObjectTypeRidActionTypesQueryV2, Affix, AggregateObjectSetRequestV2, AggregateObjectsRequest, AggregateObjectsRequestV2, AggregateObjectsResponse, AggregateObjectsResponseItem, AggregateObjectsResponseItemV2, AggregateObjectsResponseV2, AggregateTimeSeries, Aggregation, AggregationAccuracy, AggregationAccuracyRequest, AggregationDurationGrouping, AggregationDurationGroupingV2, AggregationExactGrouping, AggregationExactGroupingV2, AggregationFixedWidthGrouping, AggregationFixedWidthGroupingV2, AggregationGroupBy, AggregationGroupByV2, AggregationGroupKey, AggregationGroupKeyV2, AggregationGroupValue, AggregationGroupValueV2, AggregationMetricName, AggregationMetricResult, AggregationMetricResultV2, AggregationObjectTypeGrouping, AggregationOrderBy, AggregationRange, AggregationRangesGrouping, AggregationRangesGroupingV2, AggregationRangeV2, AggregationV2, AllOfRule, AllTermsQuery, AndActionTypesQueryV2, AndQuery, AndQueryV2_2 as AndQueryV2, AnyOfRule, AnyTermQuery, ApplyActionMode, ApplyActionOverrides, ApplyActionRequest, ApplyActionRequestOptions, ApplyActionRequestV2, ApplyActionResponse, ApplyActionWithOverridesRequest, ApplyReducersAndExtractMainValueLoadLevel, ApplyReducersLoadLevel, ApplyScenarioLogicRule, ApplyScenarioRule, ApproximateDistinctAggregation, ApproximateDistinctAggregationV2, ApproximatePercentileAggregationV2, Arg, ArrayConstraint, ArrayEntryEvaluatedConstraint, ArrayEvaluatedConstraint, ArraySizeConstraint, ArtifactRepositoryRid, AsyncActionOperation, AsyncActionStatus, AsyncApplyActionOperationResponseV2, AsyncApplyActionOperationV2, AsyncApplyActionRequest, AsyncApplyActionRequestV2, AsyncApplyActionResponse, AsyncApplyActionResponseV2, Attachment, AttachmentAllowedValues, AttachmentMetadataResponse, AttachmentProperty, AttachmentPropertyV2, AttachmentRid, AttachmentV2, AvgAggregation, AvgAggregationV2, BatchActionObjectEdit, BatchActionObjectEdits, BatchActionResults, BatchApplyActionRequest, BatchApplyActionRequestItem, BatchApplyActionRequestItemWithOverrides, BatchApplyActionRequestOptions, BatchApplyActionRequestV2, BatchApplyActionResponse, BatchApplyActionResponseV2, BatchApplyActionWithOverridesRequest, BatchedFunctionLogicRule, BatchReturnEditsMode, BlueprintIcon, BooleanValue, BoundingBoxValue_2 as BoundingBoxValue, CenterPoint_2 as CenterPoint, CenterPointTypes_2 as CenterPointTypes, CipherChannelStrategy, CipherText, CipherTextProperty, ColumnName_2 as ColumnName, ColumnPropertyMapping, ConjunctiveMarkingSummary, ContainerConjunctiveMarkingSummary, ContainerDisjunctiveMarkingSummary, ContainsAllTermsInOrderPrefixLastTerm_2 as ContainsAllTermsInOrderPrefixLastTerm, ContainsAllTermsInOrderQuery_2 as ContainsAllTermsInOrderQuery, ContainsAllTermsQuery_2 as ContainsAllTermsQuery, ContainsAnyTermQuery_2 as ContainsAnyTermQuery, ContainsQuery, ContainsQueryV2_2 as ContainsQueryV2, CountAggregation, CountAggregationV2, CountObjectsResponseV2, CreateEdit, CreateInterfaceLinkLogicRule, CreateInterfaceLogicRule, CreateInterfaceObjectRule, CreateLinkLogicRule, CreateLinkRule, CreateObjectLogicRule, CreateObjectRule, CreateOntologyScenarioRequest, CreateOntologyScenarioResponse, CreateOrModifyObjectLogicRule, CreateOrModifyObjectLogicRuleV2, CreateTemporaryObjectSetRequestV2, CreateTemporaryObjectSetResponseV2, CurrentTimeArgument, CurrentUserArgument, CustomTypeId, DatasourceBranchId, DatasourceRid, DataValue, DatetimeAllowedValues, DatetimeFormat, DatetimeLocalizedFormat, DatetimeLocalizedFormatType, DatetimeStringFormat, DatetimeTimezone, DatetimeTimezoneStatic, DatetimeTimezoneUser, DateValue, DecryptionResult, DeleteEdit, DeleteInterfaceLinkLogicRule, DeleteInterfaceObjectRule, DeleteLink, DeleteLinkEdit, DeleteLinkLogicRule, DeleteLinkRule, DeleteObject, DeleteObjectEdit, DeleteObjectLogicRule, DeleteObjectRule, DeprecatedPropertyTypeStatus, DerivedPropertyApiName, DerivedPropertyDefinition, DerivedTimeSeriesProperty, DirectSourceRid, DisjunctiveMarkingSummary, DividePropertyExpression, DoesNotIntersectBoundingBoxQuery_2 as DoesNotIntersectBoundingBoxQuery, DoesNotIntersectPolygonQuery_2 as DoesNotIntersectPolygonQuery, DoubleValue, DoubleVector, Duration_2 as Duration, DurationBaseValue, DurationFormatStyle, DurationPrecision, EditHistoryEdit, EditOnlyPropertyMapping, EditsHistoryFilter, EditsHistoryOperationIdsFilter, EditsHistorySortOrder, EditsHistoryTimestampFilter, EditTypeFilter, EncryptionRequest, EncryptionResult, EntrySetType, EnumConstraint, EqualsQuery, EqualsQueryV2_2 as EqualsQueryV2, Error_2 as Error, ErrorComputingSecurity, ErrorName, ExactDistinctAggregationV2, ExamplePropertyTypeStatus, ExecuteQueryRequest, ExecuteQueryResponse, ExperimentalPropertyTypeStatus, ExtractDatePart, ExtractMainValueLoadLevel, ExtractPropertyExpression, FieldNameV1, FilterValue, FixedDatetimeValue, FixedValuesMapKey, FullTextStringContainsPredicate, FullTextStringExactPredicate, FullTextStringPredicateV2, FunctionLogicRule, FunctionParameterName, FunctionRid, FunctionRidActionTypesQueryV2, FunctionVersion, FuzzinessAuto, FuzzinessOff, Fuzzy, FuzzyRule, FuzzyV2_2 as FuzzyV2, GeoJsonString, GeoShapeV2Geometry, GeoShapeV2Query, GeotemporalSeriesEntry, GeotemporalSeriesProperty, GeotimeSeriesId, GeotimeSeriesIntegrationRid, GeotimeSeriesProperty, GeotimeSeriesValue, GetActionTypeByRidBatchRequest, GetActionTypeByRidBatchRequestElement, GetActionTypeByRidBatchResponse, GetActionTypeFullMetadataBatchRequest, GetActionTypeFullMetadataBatchRequestElement, GetActionTypeFullMetadataBatchResponse, GetObjectTypeByRidBatchRequest, GetObjectTypeByRidBatchRequestElement, GetObjectTypeByRidBatchResponse, GetObjectTypeFullMetadataBatchRequest, GetObjectTypeFullMetadataBatchRequestElement, GetObjectTypeFullMetadataBatchResponse, GetOutgoingLinkTypesByObjectTypeRidBatchRequest, GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement, GetOutgoingLinkTypesByObjectTypeRidBatchResponse, GetQueryTypeByRidBatchRequest, GetQueryTypeByRidBatchRequestElement, GetQueryTypeByRidBatchResponse, GetSelectedPropertyOperation, GreatestPropertyExpression, GroupMemberConstraint, GteQuery, GteQueryV2_2 as GteQueryV2, GtQuery, GtQueryV2_2 as GtQueryV2, HasActionLogActionTypesQueryV2, HasNotificationActionTypesQueryV2, HasWebhookActionTypesQueryV2, HumanReadableFormat, Icon, InputObjectTypeRidActionTypesQueryV2, InQuery_2 as InQuery, IntegerValue, InterfaceActionTypeConstraintApiName, InterfaceDefinedPropertyType, InterfaceLinkType, InterfaceLinkTypeApiName, InterfaceLinkTypeCardinality, InterfaceLinkTypeLinkedEntityApiName, InterfaceLinkTypeRid, InterfaceParameterPropertyArgument, InterfacePropertyApiName, InterfacePropertyLocalPropertyImplementation, InterfacePropertyReducedPropertyImplementation, InterfacePropertyStructFieldImplementation, InterfacePropertyStructImplementation, InterfacePropertyStructImplementationMapping, InterfacePropertyType, InterfacePropertyTypeImplementation, InterfacePropertyTypeRid, InterfaceSharedPropertyType, InterfaceToObjectTypeMapping, InterfaceToObjectTypeMappings, InterfaceToObjectTypeMappingsV2, InterfaceToObjectTypeMappingV2, InterfaceType, InterfaceTypeApiName, InterfaceTypeRid, IntersectsBoundingBoxQuery_2 as IntersectsBoundingBoxQuery, IntersectsPolygonQuery_2 as IntersectsPolygonQuery, IntervalQuery, IntervalQueryRule, IsNullQuery, IsNullQueryV2_2 as IsNullQueryV2, KnownType, LeastPropertyExpression, LegacyObjectTypeId, LegacyPropertyId, LengthConstraint, LinkedInterfaceTypeApiName, LinkedObjectLocator, LinkedObjectTypeApiName, LinkedObjectV2, LinksFromObject, LinkSideObject, LinksMessage, LinkState, LinkSubscriptionObjectLocator, LinkSubscriptionObjectLocators, LinkTypeApiName_2 as LinkTypeApiName, LinkTypeApiNames, LinkTypeId, LinkTypeRid, LinkTypeSide, LinkTypeSideCardinality, LinkTypeSideV2, LinkTypeSubscribeRequest, LinkTypeSubscribeRequests, LinkUpdate, LinkUpdates, ListActionTypesFullMetadataResponse, ListActionTypesResponse, ListActionTypesResponseV2, ListAttachmentsResponseV2, ListInterfaceLinkedObjectsResponse, ListInterfaceTypesResponse, ListLinkedObjectsResponse, ListLinkedObjectsResponseV2, ListObjectsForInterfaceResponse, ListObjectsResponse, ListObjectsResponseV2, ListObjectTypesResponse, ListObjectTypesV2Response, ListOntologiesResponse, ListOntologiesV2Response, ListOntologyValueTypesResponse, ListOutgoingInterfaceLinkTypesResponse, ListOutgoingLinkTypesResponse, ListOutgoingLinkTypesResponseV2, ListQueryTypesResponse, ListQueryTypesResponseV2, ListScenarioConflictingObjectsResponse, ListScenarioEditedEntityTypesResponse, ListScenarioEditedLinksResponse, ListScenarioEditedLinkTypesResponse, ListScenarioEditedObjectsResponse, ListScenarioEditedObjectTypesResponse, LoadGeotemporalSeriesRequest, LoadGeotemporalSeriesResponse, LoadObjectSetLinksRequestV2, LoadObjectSetLinksResponseV2, LoadObjectSetRequestV2, LoadObjectSetResponseV2, LoadObjectSetV2MultipleObjectTypesRequest, LoadObjectSetV2MultipleObjectTypesResponse, LoadObjectSetV2ObjectsOrInterfacesRequest, LoadObjectSetV2ObjectsOrInterfacesResponse, LoadOntologyMetadataRequest, LogicRule, LogicRuleActionTypesQueryV2, LogicRuleArgument, LongValue, LteQuery, LteQueryV2_2 as LteQueryV2, LtQuery, LtQueryV2_2 as LtQueryV2, MarkdownAllowedValues, MarkingId_2 as MarkingId, MatchRule, MaxAggregation, MaxAggregationV2, MediaMetadata_2 as MediaMetadata, MediaReferenceProperty, MethodObjectSet, MinAggregation, MinAggregationV2, ModifyEdit, ModifyInterfaceLogicRule, ModifyInterfaceObjectRule, ModifyObject, ModifyObjectEdit, ModifyObjectLogicRule, ModifyObjectRule, MultiplyPropertyExpression, MustBeEmptyAllowedValues, NearestNeighborsQuery, NearestNeighborsQueryText, NegatePropertyExpression, NestedInterfacePropertyTypeImplementation, NestedQueryAggregation, NoLoadLevel, NotQuery, NotQueryV2_2 as NotQueryV2, NowDatetimeValue, NumberFormatAffix, NumberFormatBasisPoints, NumberFormatCurrency, NumberFormatCurrencyStyle, NumberFormatCustomUnit, NumberFormatDuration, NumberFormatFixedValues, NumberFormatNotation, NumberFormatOptions, NumberFormatRatio, NumberFormatScale, NumberFormatStandard, NumberFormatStandardUnit, NumberRatioType, NumberRoundingMode, NumberScaleType, ObjectEdit, ObjectEditHistoryEntry, ObjectEdits, ObjectLoadingResponseOptions, ObjectLocator, ObjectParameterPropertyArgument, ObjectPrimaryKey, ObjectPrimaryKeyV2, ObjectPropertyType, ObjectPropertyValueConstraint, ObjectQueryResultConstraint, ObjectRid_2 as ObjectRid, ObjectSet_2 as ObjectSet, ObjectSetAsBaseObjectTypesType_2 as ObjectSetAsBaseObjectTypesType, ObjectSetAsTypeType_2 as ObjectSetAsTypeType, ObjectSetBaseType_2 as ObjectSetBaseType, ObjectSetFilterType_2 as ObjectSetFilterType, ObjectSetInterfaceBaseType_2 as ObjectSetInterfaceBaseType, ObjectSetInterfaceLinkSearchAroundType, ObjectSetIntersectionType_2 as ObjectSetIntersectionType, ObjectSetMethodInputType_2 as ObjectSetMethodInputType, ObjectSetNearestNeighborsType_2 as ObjectSetNearestNeighborsType, ObjectSetReferenceType_2 as ObjectSetReferenceType, ObjectSetRid_2 as ObjectSetRid, ObjectSetSearchAroundType_2 as ObjectSetSearchAroundType, ObjectSetStaticType_2 as ObjectSetStaticType, ObjectSetStreamSubscribeRequest, ObjectSetStreamSubscribeRequests, ObjectSetSubscribeResponse, ObjectSetSubscribeResponses, ObjectSetSubtractType_2 as ObjectSetSubtractType, ObjectSetUnionType_2 as ObjectSetUnionType, ObjectSetUpdate, ObjectSetUpdates, ObjectSetWithPropertiesType_2 as ObjectSetWithPropertiesType, ObjectState, ObjectType, ObjectTypeApiName, ObjectTypeDatasetDatasource, ObjectTypeDatasource, ObjectTypeDatasourceDefinition, ObjectTypeDirectDatasource, ObjectTypeEdits, ObjectTypeEditsHistoryRequest, ObjectTypeEditsHistoryResponse, ObjectTypeEditsOnlyDatasource, ObjectTypeFullMetadata, ObjectTypeGeotimeSeriesDatasource, ObjectTypeId_2 as ObjectTypeId, ObjectTypeInterfaceImplementation, ObjectTypeLinkTypeApiNameMapping, ObjectTypeMediaSetViewDatasource, ObjectTypeRestrictedViewDatasource, ObjectTypeRid_2 as ObjectTypeRid, ObjectTypeStreamDatasource, ObjectTypeTableDatasource, ObjectTypeTimeSeriesDatasource, ObjectTypeUnsupportedDatasource, ObjectTypeV2, ObjectTypeVisibility, ObjectUpdate, OneOfAllowedValues, OneOfConstraint, Ontology, OntologyApiName, OntologyArrayType, OntologyBase, OntologyBaseBranch, OntologyDataType, OntologyFullMetadata, OntologyIdentifier_2 as OntologyIdentifier, OntologyInterface, OntologyInterfaceObjectSetType, OntologyInterfaceObjectType, OntologyMapType, OntologyObject, OntologyObjectArrayType, OntologyObjectArrayTypeReducer, OntologyObjectArrayTypeReducerSortDirection, OntologyObjectSet, OntologyObjectSetType, OntologyObjectType, OntologyObjectTypeReferenceType, OntologyObjectV2, OntologyRid, OntologyScenario, OntologyScenarioRid, OntologySetType, OntologyStructField, OntologyStructType, OntologyTransaction, OntologyTransactionId, OntologyV2, OntologyValueType, OntologyVersion, OrActionTypesQueryV2, OrderBy, OrderByDirection_2 as OrderByDirection, OrQuery, OrQueryV2_2 as OrQueryV2, Parameter_2 as Parameter, ParameterAllowedValueOption, ParameterAllowedValues, ParameterArraySize, ParameterConstraintValue, ParameterDatetimeValue, ParameterEvaluatedConstraint, ParameterEvaluationResult, ParameterId_2 as ParameterId, ParameterIdArgument, ParameterNameActionTypesQueryV2, ParameterOption, ParameterRidActionTypesQueryV2, PermissionModelActionTypesQueryV2, PhraseQuery, Plaintext, PolygonValue_2 as PolygonValue, PostTransactionEditsRequest, PostTransactionEditsResponse, PreciseDuration, PreciseTimeUnit, PrefixOnLastTokenRule, PrefixQuery, PrimaryKeyPropertySelector, PrimaryKeyValue, PrimaryKeyValueV2, Property, PropertyApiName_2 as PropertyApiName, PropertyApiNameSelector_2 as PropertyApiNameSelector, PropertyBooleanFormattingRule, PropertyDateFormattingRule, PropertyFilter, PropertyId, PropertyIdentifier_2 as PropertyIdentifier, PropertyImplementation, PropertyKnownTypeFormattingRule, PropertyLoadLevel, PropertyMarkingSummary, PropertyNumberFormattingRule, PropertyNumberFormattingRuleType, PropertyOrStructFieldOfPropertyImplementation, PropertySecurities, PropertySecurity, PropertyTimestampFormattingRule, PropertyTypeApiName, PropertyTypeMappingInfo, PropertyTypeReference, PropertyTypeReferenceOrStringConstant, PropertyTypeRid_2 as PropertyTypeRid, PropertyTypeStatus, PropertyTypeVisibility, PropertyV2, PropertyValue_2 as PropertyValue, PropertyValueEscapedString, PropertyValueFormattingRule, PropertyWithLoadLevelSelector, QosError, QualifiedTimeseriesProperty, Query, QueryAggregation, QueryAggregationKeyType, QueryAggregationRange, QueryAggregationRangeSubType, QueryAggregationRangeType, QueryAggregationValueType, QueryApiName, QueryArrayType, QueryDataType, QueryOutputV2, QueryParameterV2, QueryRuntimeErrorParameter, QuerySetType, QueryStructField, QueryStructType, QueryThreeDimensionalAggregation, QueryTwoDimensionalAggregation, QueryType, QueryTypeReferenceType, QueryTypeV2, QueryUnionType, RangeAllowedValues, RangeConstraint, RangesConstraint, Reason, ReasonType, ReferenceSigningOptions, ReferenceUpdate, ReferenceValue, RefreshLinks, RefreshObjectSet, RegexConstraint, RegexQuery, RelativeDateRangeBound, RelativeDateRangeQuery, RelativeDatetimeDuration, RelativeDatetimeTense, RelativeDatetimeUnit, RelativeDatetimeValue, RelativePointInTime, RelativeTime, RelativeTimeRange, RelativeTimeRelation, RelativeTimeSeriesTimeUnit, RelativeTimeUnit, RequestId, ResolvedInterfacePropertyType, RestrictedViewRid, ReturnEditsMode, RevertActionEnabledActionTypesQueryV2, RidConstraint, RollingAggregateWindowPoints, SdkPackageName, SdkPackageRid, SdkVersion, SearchActionTypesOrderByV2, SearchActionTypesRequestV2, SearchActionTypesResponseV2, SearchJsonQuery, SearchJsonQueryV2_2 as SearchJsonQueryV2, SearchObjectsForInterfaceRequest, SearchObjectsRequest, SearchObjectsRequestV2, SearchObjectsResponse, SearchObjectsResponseV2, SearchOrderBy, SearchOrderByType, SearchOrderByV2, SearchOrdering, SearchOrderingV2, SectionRidActionTypesQueryV2, SecuredPropertyValue, SelectedPropertyApiName, SelectedPropertyApproximateDistinctAggregation, SelectedPropertyApproximatePercentileAggregation, SelectedPropertyAvgAggregation, SelectedPropertyCollectListAggregation, SelectedPropertyCollectSetAggregation, SelectedPropertyCountAggregation, SelectedPropertyExactDistinctAggregation, SelectedPropertyExpression, SelectedPropertyMaxAggregation, SelectedPropertyMinAggregation, SelectedPropertyOperation, SelectedPropertySumAggregation, SeriesId, SharedPropertyType, SharedPropertyTypeApiName, SharedPropertyTypeRid, SpatialFilterMode, StartsWithQuery_2 as StartsWithQuery, StaticArgument, StaticConstraintValue, StatusActionTypesQueryV2, StreamingOutputFormat, StreamMessage, StreamRid, StreamTimeSeriesPointsRequest, StreamTimeSeriesPointsResponse, StreamTimeSeriesValuesRequest, StreamTimeSeriesValuesResponse, StringConstant, StringLengthConstraint, StringRegexMatchConstraint, StringValue, StructConstraint, StructEvaluatedConstraint, StructFieldApiName_2 as StructFieldApiName, StructFieldArgument, StructFieldEvaluatedConstraint, StructFieldEvaluationResult, StructFieldOfPropertyImplementation, StructFieldPropertyMapping, StructFieldSelector_2 as StructFieldSelector, StructFieldType_2 as StructFieldType, StructFieldTypeRid, StructListParameterFieldArgument, StructParameterFieldApiName, StructParameterFieldArgument, StructPropertyMapping, StructType, StructTypeMainValue, SubmissionCriteriaEvaluation, SubscriptionClosed, SubscriptionClosureCause, SubscriptionError, SubscriptionId, SubscriptionSuccess, SubtractPropertyExpression, SumAggregation, SumAggregationV2, SyncApplyActionResponseV2, SynchronousWebhookOutputArgument, TableRid_2 as TableRid, TextAllowedValues, ThreeDimensionalAggregation, TimeCodeFormat, TimeRange, TimeSeriesAggregationMethod, TimeSeriesAggregationStrategy, TimeSeriesCumulativeAggregate, TimeseriesEntry, TimeSeriesPeriodicAggregate, TimeSeriesPoint, TimeSeriesPropertyV2, TimeSeriesRollingAggregate, TimeSeriesRollingAggregateWindow, TimeseriesSyncRid, TimeseriesTemplateRid, TimeseriesTemplateVersion, TimeSeriesValueBankProperty, TimeSeriesWindowType, TimestampValue, TimeUnit_2 as TimeUnit, TitlePropertySelector, TransactionEdit, TwoDimensionalAggregation, TypeClass, TypeClassesActionTypesQueryV2, TypeClassPredicateV2, TypeReferenceIdentifier, UnevaluableConstraint, UniqueIdentifierArgument, UniqueIdentifierLinkId, UniqueIdentifierValue, UnsupportedPolicy, UuidConstraint, ValidateActionRequest, ValidateActionResponse, ValidateActionResponseV2, ValidationResult, ValueType, ValueTypeAllowedValues, ValueTypeApiName, ValueTypeArrayType, ValueTypeConstraint, ValueTypeDecimalType, ValueTypeFieldType, ValueTypeMapType, ValueTypeOptionalType, ValueTypeReferenceType, ValueTypeRid, ValueTypeStatus, ValueTypeStructField, ValueTypeStructType, ValueTypeUnionType, ValueTypeVersionId, VersionedQueryTypeApiName, WebhookRid, WebhookRidActionTypesQueryV2, WildcardQuery, WithinBoundingBoxPoint_2 as WithinBoundingBoxPoint, WithinBoundingBoxQuery_2 as WithinBoundingBoxQuery, WithinDistanceOfQuery_2 as WithinDistanceOfQuery, WithinPolygonQuery_2 as WithinPolygonQuery } } export declare namespace OntologiesV2 { export { list_25 as list, get_32 as get } } /** * Metadata about an Ontology. * * Log Safety: UNSAFE */ declare interface Ontology { apiName: OntologyApiName; displayName: _Core.DisplayName; description: string; rid: OntologyRid; } /** * Log Safety: UNSAFE */ declare type OntologyApiName = LooselyBrandedString_5<"OntologyApiName">; /** * The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name. * * Log Safety: UNSAFE */ declare interface OntologyApiNameNotUnique { errorCode: "INVALID_ARGUMENT"; errorName: "OntologyApiNameNotUnique"; errorDescription: "The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name."; errorInstanceId: string; parameters: { ontologyApiName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface OntologyArrayType { itemType: OntologyDataType; } /** * The base used to initialize a scenario. * * Log Safety: UNSAFE */ declare type OntologyBase = { type: "branch"; } & OntologyBaseBranch; /** * A branch reference used to initialize a scenario. * * Log Safety: SAFE */ declare interface OntologyBaseBranch { branch: _Core.FoundryBranch; } /** * An ontologyBinding is required when creating or replacing a model function. * * Log Safety: SAFE */ declare interface OntologyBindingRequired { errorCode: "INVALID_ARGUMENT"; errorName: "OntologyBindingRequired"; errorDescription: "An ontologyBinding is required when creating or replacing a model function."; errorInstanceId: string; parameters: {}; } /** * A union of all the primitive types used by Palantir's Ontology-based products. * * Log Safety: UNSAFE */ declare type OntologyDataType = ({ type: "date"; } & _Core.DateType) | ({ type: "struct"; } & OntologyStructType) | ({ type: "set"; } & OntologySetType) | ({ type: "string"; } & _Core.StringType) | ({ type: "byte"; } & _Core.ByteType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "float"; } & _Core.FloatType) | ({ type: "any"; } & _Core.AnyType) | ({ type: "long"; } & _Core.LongType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "cipherText"; } & _Core.CipherTextType) | ({ type: "marking"; } & _Core.MarkingType) | ({ type: "unsupported"; } & _Core.UnsupportedType) | ({ type: "mediaReference"; } & _Core.MediaReferenceType) | ({ type: "array"; } & OntologyArrayType) | ({ type: "objectSet"; } & OntologyObjectSetType) | ({ type: "binary"; } & _Core.BinaryType) | ({ type: "short"; } & _Core.ShortType) | ({ type: "decimal"; } & _Core.DecimalType) | ({ type: "map"; } & OntologyMapType) | ({ type: "timestamp"; } & _Core.TimestampType) | ({ type: "object"; } & OntologyObjectType); /** * The ontology definition is temporarily out of sync. The indexed definition does not yet reflect the latest saved definition for this type. This is typically a transient condition that resolves as indexing completes. * * Log Safety: SAFE */ declare interface OntologyDefinitionOutOfSync { errorCode: "CONFLICT"; errorName: "OntologyDefinitionOutOfSync"; errorDescription: "The ontology definition is temporarily out of sync. The indexed definition does not yet reflect the latest saved definition for this type. This is typically a transient condition that resolves as indexing completes."; errorInstanceId: string; parameters: { objectTypeRid: unknown; }; } /** * The number of edits to the Ontology exceeded the allowed limit. This may happen because of the request or because the Action is modifying too many objects. Please change the size of your request or contact the Ontology administrator. * * Log Safety: UNSAFE */ declare interface OntologyEditsExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "OntologyEditsExceededLimit"; errorDescription: "The number of edits to the Ontology exceeded the allowed limit. This may happen because of the request or because the Action is modifying too many objects. Please change the size of your request or contact the Ontology administrator."; errorInstanceId: string; parameters: { editsCount: unknown; editsLimit: unknown; }; } /** * Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in Ontology Manager. * * Log Safety: SAFE */ declare interface OntologyEntitiesNotFound { errorCode: "NOT_FOUND"; errorName: "OntologyEntitiesNotFound"; errorDescription: "Some ontology types are configured for use by the Agent but could not be found. The types either do not exist or the client token does not have access. Object types and their link types can be checked by listing available object/link types through the API, or searching in Ontology Manager."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; objectTypeRids: unknown; linkTypeRids: unknown; }; } /** * Log Safety: UNSAFE */ declare interface OntologyFullMetadata { ontology: OntologyV2; objectTypes: Record; actionTypes: Record; queryTypes: Record; interfaceTypes: Record; sharedPropertyTypes: Record; branch?: _Core.BranchMetadata; valueTypes: Record; } /** * @deprecated Use `OntologyIdentifier` in the `foundry.ontologies` package * * Either an ontology RID or an ontology API name. * * Log Safety: UNSAFE */ declare type OntologyIdentifier = LooselyBrandedString<"OntologyIdentifier">; /** * The API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or check the Ontology Manager. * * Log Safety: UNSAFE */ declare type OntologyIdentifier_2 = LooselyBrandedString_5<"OntologyIdentifier">; /** * Log Safety: UNSAFE */ declare type OntologyInterface = LooselyBrandedString_5<"OntologyInterface">; /** * Log Safety: UNSAFE */ declare interface OntologyInterfaceObjectSetType { interfaceTypeApiName: InterfaceTypeApiName; } /** * Log Safety: UNSAFE */ declare interface OntologyInterfaceObjectType { interfaceTypeApiName?: InterfaceTypeApiName; } export declare namespace OntologyInterfaces { export { } } /** * Log Safety: UNSAFE */ declare interface OntologyMapType { keyType: OntologyDataType; valueType: OntologyDataType; } /** * The requested Ontology is not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface OntologyNotFound { errorCode: "NOT_FOUND"; errorName: "OntologyNotFound"; errorDescription: "The requested Ontology is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { ontologyRid: unknown; apiName: unknown; }; } /** * The specified ontology was not found. * * Log Safety: SAFE */ declare interface OntologyNotFound_2 { errorCode: "NOT_FOUND"; errorName: "OntologyNotFound"; errorDescription: "The specified ontology was not found."; errorInstanceId: string; parameters: { ontologyRid: unknown; }; } /** * Represents an object in the Ontology. * * Log Safety: UNSAFE */ declare interface OntologyObject { properties: Record; rid: ObjectRid_2; } /** * Log Safety: UNSAFE */ declare interface OntologyObjectArrayType { subType: ObjectPropertyType; reducers: Array; } /** * Log Safety: UNSAFE */ declare interface OntologyObjectArrayTypeReducer { direction: OntologyObjectArrayTypeReducerSortDirection; field?: StructFieldApiName_2; } /** * Log Safety: SAFE */ declare type OntologyObjectArrayTypeReducerSortDirection = "ASCENDING_NULLS_LAST" | "DESCENDING_NULLS_LAST"; /** * Log Safety: UNSAFE */ declare type OntologyObjectSet = LooselyBrandedString_5<"OntologyObjectSet">; export declare namespace OntologyObjectSets { export { load, aggregate_2 as aggregate } } /** * Log Safety: UNSAFE */ declare interface OntologyObjectSetType { objectApiName?: ObjectTypeApiName; objectTypeApiName?: ObjectTypeApiName; } export declare namespace OntologyObjectsV2 { export { list_24 as list, get_31 as get, search_5 as search, aggregate_3 as aggregate } } /** * Log Safety: UNSAFE */ declare interface OntologyObjectType { objectApiName: ObjectTypeApiName; objectTypeApiName: ObjectTypeApiName; } /** * 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. * * Log Safety: SAFE */ declare interface OntologyObjectTypeNotFound { errorCode: "NOT_FOUND"; errorName: "OntologyObjectTypeNotFound"; errorDescription: "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."; errorInstanceId: string; parameters: { objectTypeRid: unknown; }; } /** * Log Safety: SAFE */ declare interface OntologyObjectTypeReferenceType { } /** * Represents an object in the Ontology. * * Log Safety: UNSAFE */ declare type OntologyObjectV2 = Record; /** * The Ontology query failed. * * Log Safety: UNSAFE */ declare interface OntologyQueryFailed { errorCode: "INTERNAL"; errorName: "OntologyQueryFailed"; errorDescription: "The Ontology query failed."; errorInstanceId: string; parameters: { errorMessage: unknown; }; } /** * 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. * * Log Safety: SAFE */ declare interface OntologyQueryInvalidObjectBackend { errorCode: "INVALID_ARGUMENT"; errorName: "OntologyQueryInvalidObjectBackend"; errorDescription: "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."; errorInstanceId: string; parameters: { objectTypeRids: unknown; linkTypeRids: unknown; }; } /** * 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. * * Log Safety: SAFE */ declare interface OntologyQueryNestedObjectSetTooLarge { errorCode: "INVALID_ARGUMENT"; errorName: "OntologyQueryNestedObjectSetTooLarge"; errorDescription: "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."; errorInstanceId: string; parameters: { nestedObjectSetSize: unknown; maxAllowedNestedObjectSetSize: unknown; }; } /** * 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. * * Log Safety: UNSAFE */ declare interface OntologyQueryStringColumnTooLong { errorCode: "INVALID_ARGUMENT"; errorName: "OntologyQueryStringColumnTooLong"; errorDescription: "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."; errorInstanceId: string; parameters: { columnName: unknown; }; } /** * The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager. * * Log Safety: SAFE */ declare type OntologyRid = LooselyBrandedString_5<"OntologyRid">; /** * The Resource Identifier (RID) of an Ontology. * * Log Safety: SAFE */ declare type OntologyRid_2 = LooselyBrandedString_15<"OntologyRid">; /** * Log Safety: UNSAFE */ declare type OntologyScenario = LooselyBrandedString_5<"OntologyScenario">; /** * The unique resource identifier of an ontology scenario. * * Log Safety: SAFE */ declare type OntologyScenarioRid = LooselyBrandedString_5<"OntologyScenarioRid">; export declare namespace OntologyScenarios { export { } } /** * A specification of an Ontology SDK used by a widget set. * * Log Safety: SAFE */ declare interface OntologySdkInputSpec { sdkPackageRid: OntologySdkPackageRid; sdkVersion: OntologySdkVersion; } /** * A referenced Ontology SDK package could not be found. * * Log Safety: UNSAFE */ declare interface OntologySdkNotFound { errorCode: "NOT_FOUND"; errorName: "OntologySdkNotFound"; errorDescription: "A referenced Ontology SDK package could not be found."; errorInstanceId: string; parameters: { sdkPackageRid: unknown; sdkVersion: unknown; }; } /** * A Resource Identifier (RID) identifying an Ontology SDK package. * * Log Safety: SAFE */ declare type OntologySdkPackageRid = LooselyBrandedString_24<"OntologySdkPackageRid">; /** * A limited semver version string of the format major.minor.patch. * * Log Safety: SAFE */ declare type OntologySdkVersion = LooselyBrandedString_24<"OntologySdkVersion">; /** * Log Safety: UNSAFE */ declare interface OntologySetType { itemType: OntologyDataType; } /** * Log Safety: UNSAFE */ declare interface OntologyStructField { name: _Core.StructFieldName; fieldType: OntologyDataType; required: boolean; } /** * Log Safety: UNSAFE */ declare interface OntologyStructType { fields: Array; } /** * The requested object type has been changed in the Ontology Manager and changes are currently being applied. Wait a few seconds and try again. * * Log Safety: UNSAFE */ declare interface OntologySyncing { errorCode: "CONFLICT"; errorName: "OntologySyncing"; errorDescription: "The requested object type has been changed in the Ontology Manager and changes are currently being applied. Wait a few seconds and try again."; errorInstanceId: string; parameters: { objectType: unknown; }; } /** * One or more requested object types have been changed in the Ontology Manager and changes are currently being applied. Wait a few seconds and try again. * * Log Safety: UNSAFE */ declare interface OntologySyncingObjectTypes { errorCode: "CONFLICT"; errorName: "OntologySyncingObjectTypes"; errorDescription: "One or more requested object types have been changed in the Ontology Manager and changes are currently being applied. Wait a few seconds and try again."; errorInstanceId: string; parameters: { objectTypes: unknown; }; } /** * Log Safety: UNSAFE */ declare type OntologyTransaction = LooselyBrandedString_5<"OntologyTransaction">; /** * The ID identifying a transaction. * * Log Safety: SAFE */ declare type OntologyTransactionId = LooselyBrandedString_5<"OntologyTransactionId">; export declare namespace OntologyTransactions { export { } } /** * Metadata about an Ontology. * * Log Safety: UNSAFE */ declare interface OntologyV2 { apiName: OntologyApiName; displayName: _Core.DisplayName; description: string; rid: OntologyRid; } /** * Log Safety: UNSAFE */ declare interface OntologyValueType { apiName: ValueTypeApiName; displayName: _Core.DisplayName; description?: string; rid: ValueTypeRid; status?: ValueTypeStatus; fieldType: ValueTypeFieldType; version: string; constraints: Array; } export declare namespace OntologyValueTypes { export { } } /** * Log Safety: SAFE */ declare type OntologyVersion = string; export declare namespace OpenAi { export { } } /** * Log Safety: UNSAFE */ declare type OpenAiEmbeddingInput = Array; /** * Could not embeddings the OpenAiModel. * * Log Safety: SAFE */ declare interface OpenAiEmbeddingsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "OpenAiEmbeddingsPermissionDenied"; errorDescription: "Could not embeddings the OpenAiModel."; errorInstanceId: string; parameters: { openAiModelModelId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface OpenAiEmbeddingsRequest { input: OpenAiEmbeddingInput; dimensions?: number; encodingFormat?: OpenAiEncodingFormat; } /** * Log Safety: UNSAFE */ declare interface OpenAiEmbeddingsResponse { data: Array>; model: string; usage: OpenAiEmbeddingTokenUsage; } /** * Log Safety: UNSAFE */ declare interface OpenAiEmbeddingTokenUsage { promptTokens: number; } /** * Log Safety: SAFE */ declare type OpenAiEncodingFormat = "FLOAT" | "BASE64"; /** * Log Safety: SAFE */ declare interface OpenAiModel { modelId: LanguageModelApiName; } /** * Log Safety: UNSAFE */ declare interface OpenApiDefinition { apiVersion: ApiVersion; deprecated: OpenApiDefinitionDeprecated; value: OpenApiDefinitionValue; } /** * Log Safety: SAFE */ declare type OpenApiDefinitionDeprecated = boolean; /** * The given OpenApiDefinition could not be found. * * Log Safety: SAFE */ declare interface OpenApiDefinitionNotFound { errorCode: "NOT_FOUND"; errorName: "OpenApiDefinitionNotFound"; errorDescription: "The given OpenApiDefinition could not be found."; errorInstanceId: string; parameters: { openApiDefinitionApiVersion: unknown; }; } export declare namespace OpenApiDefinitions { export { } } /** * Log Safety: UNSAFE */ declare type OpenApiDefinitionValue = any; /** * A transaction is already open on this dataset and branch. A branch of a dataset can only have one open transaction at a time. * * Log Safety: UNSAFE */ declare interface OpenTransactionAlreadyExists { errorCode: "CONFLICT"; errorName: "OpenTransactionAlreadyExists"; errorDescription: "A transaction is already open on this dataset and branch. A branch of a dataset can only have one open transaction at a time."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; }; } /** * An operation that can be performed on a resource. Operations are used to define the permissions that a Role has. Operations are typically in the format service:action, where service is related to the type of resource and action is the action being performed. * * Log Safety: SAFE */ declare type Operation = LooselyBrandedString<"Operation">; /** * The operation is not found, or the user does not have access to it. * * Log Safety: SAFE */ declare interface OperationNotFound { errorCode: "INVALID_ARGUMENT"; errorName: "OperationNotFound"; errorDescription: "The operation is not found, or the user does not have access to it."; errorInstanceId: string; parameters: { id: unknown; }; } export declare namespace Operations { export { AsyncOperation, OperationNotFound, AsyncOperations } } declare namespace _Operations { export { LooselyBrandedString_18 as LooselyBrandedString, AsyncOperation } } /** * Log Safety: SAFE */ declare type OperationScope = LooselyBrandedString<"OperationScope">; /** * The import configuration for an Oracle Database 21 connection. * * Log Safety: UNSAFE */ declare interface OracleTableImportConfig { query: TableImportQuery; initialIncrementalState?: TableImportInitialIncrementalState; } /** * Returns action types where at least one query is satisfied. An empty list matches no action types. * * Log Safety: UNSAFE */ declare interface OrActionTypesQueryV2 { value: Array; } export declare namespace Orchestration { export { AbortOnFailure, Action_2 as Action, AffectedResourcesResponse, AndTrigger, Build, BuildableRid, BuildStatus, BuildTarget, ConnectingTarget, CreateBuildRequest, CreateScheduleRequest, CreateScheduleRequestAction, CreateScheduleRequestAndTrigger, CreateScheduleRequestBuildTarget, CreateScheduleRequestConnectingTarget, CreateScheduleRequestDatasetUpdatedTrigger, CreateScheduleRequestDuration, CreateScheduleRequestJobSucceededTrigger, CreateScheduleRequestManualTarget, CreateScheduleRequestManualTrigger, CreateScheduleRequestMediaSetUpdatedTrigger, CreateScheduleRequestNewLogicTrigger, CreateScheduleRequestOrTrigger, CreateScheduleRequestProjectScope, CreateScheduleRequestScheduleSucceededTrigger, CreateScheduleRequestScopeMode, CreateScheduleRequestTableUpdatedTrigger, CreateScheduleRequestTimeTrigger, CreateScheduleRequestTrigger, CreateScheduleRequestUpstreamTarget, CreateScheduleRequestUserScope, CronExpression, DatasetJobOutput, DatasetUpdatedTrigger, FallbackBranches, ForceBuild, GetBuildsBatchRequestElement, GetBuildsBatchResponse, GetJobsBatchRequestElement, GetJobsBatchResponse, GetSchedulesBatchRequestElement, GetSchedulesBatchResponse, Job, JobOutput, JobStartedTime, JobStatus, JobSucceededTrigger, ListJobsOfBuildResponse, ListRunsOfScheduleResponse, ManualTarget, ManualTrigger, MediaSetUpdatedTrigger, NewLogicTrigger, NotificationsEnabled, OrTrigger, ProjectScope, ReplaceScheduleRequest, ReplaceScheduleRequestAction, ReplaceScheduleRequestAndTrigger, ReplaceScheduleRequestBuildTarget, ReplaceScheduleRequestConnectingTarget, ReplaceScheduleRequestDatasetUpdatedTrigger, ReplaceScheduleRequestDuration, ReplaceScheduleRequestJobSucceededTrigger, ReplaceScheduleRequestManualTarget, ReplaceScheduleRequestManualTrigger, ReplaceScheduleRequestMediaSetUpdatedTrigger, ReplaceScheduleRequestNewLogicTrigger, ReplaceScheduleRequestOrTrigger, ReplaceScheduleRequestProjectScope, ReplaceScheduleRequestScheduleSucceededTrigger, ReplaceScheduleRequestScopeMode, ReplaceScheduleRequestTableUpdatedTrigger, ReplaceScheduleRequestTimeTrigger, ReplaceScheduleRequestTrigger, ReplaceScheduleRequestUpstreamTarget, ReplaceScheduleRequestUserScope, RetryBackoffDuration, RetryCount, Schedule, SchedulePaused, ScheduleRun, ScheduleRunError, ScheduleRunErrorName, ScheduleRunIgnored, ScheduleRunResult, ScheduleRunRid, ScheduleRunSubmitted, ScheduleSucceededTrigger, ScheduleVersion, ScheduleVersionRid, ScopeMode, SearchBuildsAndFilter, SearchBuildsEqualsFilter, SearchBuildsEqualsFilterField, SearchBuildsFilter, SearchBuildsGteFilter, SearchBuildsGteFilterField, SearchBuildsLtFilter, SearchBuildsLtFilterField, SearchBuildsNotFilter, SearchBuildsOrderBy, SearchBuildsOrderByField, SearchBuildsOrderByItem, SearchBuildsOrFilter, SearchBuildsRequest, SearchBuildsResponse, TableUpdatedTrigger, TimeTrigger, TransactionalMediaSetJobOutput, Trigger, UpstreamTarget, UserScope, BuildInputsNotFound, BuildInputsPermissionDenied, BuildNotFound, BuildNotRunning, BuildTargetsMissingJobSpecs, BuildTargetsNotFound, BuildTargetsPermissionDenied, BuildTargetsResolutionError, BuildTargetsUpToDate, CancelBuildPermissionDenied, CreateBuildPermissionDenied, CreateSchedulePermissionDenied, DeleteSchedulePermissionDenied, DuplicateBuildBranches, GetAffectedResourcesSchedulePermissionDenied, InvalidAndTrigger, InvalidMediaSetTrigger, InvalidOrTrigger, InvalidScheduleDescription, InvalidScheduleName, InvalidTimeTrigger, JobNotFound, MissingBuildTargets, MissingConnectingBuildInputs, MissingTrigger, PauseSchedulePermissionDenied, ReplaceSchedulePermissionDenied, RunSchedulePermissionDenied, ScheduleAlreadyRunning, ScheduleNotFound, ScheduleTriggerResourcesNotFound, ScheduleTriggerResourcesPermissionDenied, ScheduleVersionNotFound, SearchBuildsPermissionDenied, TargetNotSupported, UnpauseSchedulePermissionDenied, Builds, Jobs, Schedules, ScheduleVersions } } declare namespace _Orchestration { export { AbortOnFailure, Action_2 as Action, AffectedResourcesResponse, AndTrigger, Build, BuildableRid, BuildStatus, BuildTarget, ConnectingTarget, CreateBuildRequest, CreateScheduleRequest, CreateScheduleRequestAction, CreateScheduleRequestAndTrigger, CreateScheduleRequestBuildTarget, CreateScheduleRequestConnectingTarget, CreateScheduleRequestDatasetUpdatedTrigger, CreateScheduleRequestDuration, CreateScheduleRequestJobSucceededTrigger, CreateScheduleRequestManualTarget, CreateScheduleRequestManualTrigger, CreateScheduleRequestMediaSetUpdatedTrigger, CreateScheduleRequestNewLogicTrigger, CreateScheduleRequestOrTrigger, CreateScheduleRequestProjectScope, CreateScheduleRequestScheduleSucceededTrigger, CreateScheduleRequestScopeMode, CreateScheduleRequestTableUpdatedTrigger, CreateScheduleRequestTimeTrigger, CreateScheduleRequestTrigger, CreateScheduleRequestUpstreamTarget, CreateScheduleRequestUserScope, CronExpression, DatasetJobOutput, DatasetUpdatedTrigger, FallbackBranches, ForceBuild, GetBuildsBatchRequestElement, GetBuildsBatchResponse, GetJobsBatchRequestElement, GetJobsBatchResponse, GetSchedulesBatchRequestElement, GetSchedulesBatchResponse, Job, JobOutput, JobStartedTime, JobStatus, JobSucceededTrigger, ListJobsOfBuildResponse, ListRunsOfScheduleResponse, ManualTarget, ManualTrigger, MediaSetUpdatedTrigger, NewLogicTrigger, NotificationsEnabled, OrTrigger, ProjectScope, ReplaceScheduleRequest, ReplaceScheduleRequestAction, ReplaceScheduleRequestAndTrigger, ReplaceScheduleRequestBuildTarget, ReplaceScheduleRequestConnectingTarget, ReplaceScheduleRequestDatasetUpdatedTrigger, ReplaceScheduleRequestDuration, ReplaceScheduleRequestJobSucceededTrigger, ReplaceScheduleRequestManualTarget, ReplaceScheduleRequestManualTrigger, ReplaceScheduleRequestMediaSetUpdatedTrigger, ReplaceScheduleRequestNewLogicTrigger, ReplaceScheduleRequestOrTrigger, ReplaceScheduleRequestProjectScope, ReplaceScheduleRequestScheduleSucceededTrigger, ReplaceScheduleRequestScopeMode, ReplaceScheduleRequestTableUpdatedTrigger, ReplaceScheduleRequestTimeTrigger, ReplaceScheduleRequestTrigger, ReplaceScheduleRequestUpstreamTarget, ReplaceScheduleRequestUserScope, RetryBackoffDuration, RetryCount, Schedule, SchedulePaused, ScheduleRun, ScheduleRunError, ScheduleRunErrorName, ScheduleRunIgnored, ScheduleRunResult, ScheduleRunRid, ScheduleRunSubmitted, ScheduleSucceededTrigger, ScheduleVersion, ScheduleVersionRid, ScopeMode, SearchBuildsAndFilter, SearchBuildsEqualsFilter, SearchBuildsEqualsFilterField, SearchBuildsFilter, SearchBuildsGteFilter, SearchBuildsGteFilterField, SearchBuildsLtFilter, SearchBuildsLtFilterField, SearchBuildsNotFilter, SearchBuildsOrderBy, SearchBuildsOrderByField, SearchBuildsOrderByItem, SearchBuildsOrFilter, SearchBuildsRequest, SearchBuildsResponse, TableUpdatedTrigger, TimeTrigger, TransactionalMediaSetJobOutput, Trigger, UpstreamTarget, UserScope, BuildInputsNotFound, BuildInputsPermissionDenied, BuildNotFound, BuildNotRunning, BuildTargetsMissingJobSpecs, BuildTargetsNotFound, BuildTargetsPermissionDenied, BuildTargetsResolutionError, BuildTargetsUpToDate, CancelBuildPermissionDenied, CreateBuildPermissionDenied, CreateSchedulePermissionDenied, DeleteSchedulePermissionDenied, DuplicateBuildBranches, GetAffectedResourcesSchedulePermissionDenied, InvalidAndTrigger, InvalidMediaSetTrigger, InvalidOrTrigger, InvalidScheduleDescription, InvalidScheduleName, InvalidTimeTrigger, JobNotFound, MissingBuildTargets, MissingConnectingBuildInputs, MissingTrigger, PauseSchedulePermissionDenied, ReplaceSchedulePermissionDenied, RunSchedulePermissionDenied, ScheduleAlreadyRunning, ScheduleNotFound, ScheduleTriggerResourcesNotFound, ScheduleTriggerResourcesPermissionDenied, ScheduleVersionNotFound, SearchBuildsPermissionDenied, TargetNotSupported, UnpauseSchedulePermissionDenied, Builds, Jobs, Schedules, ScheduleVersions } } declare namespace _Orchestration_2 { export { LooselyBrandedString_16 as LooselyBrandedString, AbortOnFailure, Action_2 as Action, AffectedResourcesResponse, AndTrigger, Build, BuildableRid, BuildStatus, BuildTarget, ConnectingTarget, CreateBuildRequest, CreateScheduleRequest, CreateScheduleRequestAction, CreateScheduleRequestAndTrigger, CreateScheduleRequestBuildTarget, CreateScheduleRequestConnectingTarget, CreateScheduleRequestDatasetUpdatedTrigger, CreateScheduleRequestDuration, CreateScheduleRequestJobSucceededTrigger, CreateScheduleRequestManualTarget, CreateScheduleRequestManualTrigger, CreateScheduleRequestMediaSetUpdatedTrigger, CreateScheduleRequestNewLogicTrigger, CreateScheduleRequestOrTrigger, CreateScheduleRequestProjectScope, CreateScheduleRequestScheduleSucceededTrigger, CreateScheduleRequestScopeMode, CreateScheduleRequestTableUpdatedTrigger, CreateScheduleRequestTimeTrigger, CreateScheduleRequestTrigger, CreateScheduleRequestUpstreamTarget, CreateScheduleRequestUserScope, CronExpression, DatasetJobOutput, DatasetUpdatedTrigger, FallbackBranches, ForceBuild, GetBuildsBatchRequestElement, GetBuildsBatchResponse, GetJobsBatchRequestElement, GetJobsBatchResponse, GetSchedulesBatchRequestElement, GetSchedulesBatchResponse, Job, JobOutput, JobStartedTime, JobStatus, JobSucceededTrigger, ListJobsOfBuildResponse, ListRunsOfScheduleResponse, ManualTarget, ManualTrigger, MediaSetUpdatedTrigger, NewLogicTrigger, NotificationsEnabled, OrTrigger, ProjectScope, ReplaceScheduleRequest, ReplaceScheduleRequestAction, ReplaceScheduleRequestAndTrigger, ReplaceScheduleRequestBuildTarget, ReplaceScheduleRequestConnectingTarget, ReplaceScheduleRequestDatasetUpdatedTrigger, ReplaceScheduleRequestDuration, ReplaceScheduleRequestJobSucceededTrigger, ReplaceScheduleRequestManualTarget, ReplaceScheduleRequestManualTrigger, ReplaceScheduleRequestMediaSetUpdatedTrigger, ReplaceScheduleRequestNewLogicTrigger, ReplaceScheduleRequestOrTrigger, ReplaceScheduleRequestProjectScope, ReplaceScheduleRequestScheduleSucceededTrigger, ReplaceScheduleRequestScopeMode, ReplaceScheduleRequestTableUpdatedTrigger, ReplaceScheduleRequestTimeTrigger, ReplaceScheduleRequestTrigger, ReplaceScheduleRequestUpstreamTarget, ReplaceScheduleRequestUserScope, RetryBackoffDuration, RetryCount, Schedule, SchedulePaused, ScheduleRun, ScheduleRunError, ScheduleRunErrorName, ScheduleRunIgnored, ScheduleRunResult, ScheduleRunRid, ScheduleRunSubmitted, ScheduleSucceededTrigger, ScheduleVersion, ScheduleVersionRid, ScopeMode, SearchBuildsAndFilter, SearchBuildsEqualsFilter, SearchBuildsEqualsFilterField, SearchBuildsFilter, SearchBuildsGteFilter, SearchBuildsGteFilterField, SearchBuildsLtFilter, SearchBuildsLtFilterField, SearchBuildsNotFilter, SearchBuildsOrderBy, SearchBuildsOrderByField, SearchBuildsOrderByItem, SearchBuildsOrFilter, SearchBuildsRequest, SearchBuildsResponse, TableUpdatedTrigger, TimeTrigger, TransactionalMediaSetJobOutput, Trigger, UpstreamTarget, UserScope } } /** * A command representing the list of properties to order by. Properties should be delimited by commas and prefixed by p or properties. The format expected format is orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}... By default, the ordering for a property is ascending, and this can be explicitly specified by appending :asc (for ascending) or :desc (for descending). Example: use orderBy=properties.lastName:asc to order by a single property, orderBy=properties.lastName,properties.firstName,properties.age:desc to order by multiple properties. You may also use the shorthand p instead of properties such as orderBy=p.lastName:asc. * * Log Safety: UNSAFE */ declare type OrderBy = LooselyBrandedString_5<"OrderBy">; /** * Specifies the ordering direction (can be either ASC or DESC) * * Log Safety: SAFE */ declare type OrderByDirection = "ASC" | "DESC"; /** * Log Safety: SAFE */ declare type OrderByDirection_2 = "ASC" | "DESC"; /** * Log Safety: UNSAFE */ declare interface Organization { rid: _Core.OrganizationRid; name: OrganizationName; description?: string; markingId: _Core.MarkingId; host?: HostName; } /** * Organizations are access requirements applied to Projects that enforce strict silos between groups of users and resources. Every user is a member of only one Organization, but can be a guest member of multiple Organizations. In order to meet access requirements, users must be a member or guest member of at least one Organization applied to a Project. Organizations are inherited via the file hierarchy and direct dependencies. * * Log Safety: UNSAFE */ declare interface Organization_2 { markingId: _Core.MarkingId; organizationRid: _Core.OrganizationRid; isDirectlyApplied: IsDirectlyApplied; } /** * Log Safety: SAFE */ declare interface Organization_3 { rid: _Core.OrganizationRid; } /** * An organization cannot be removed from a project if it would result in a project with no organizations under a space marked with an organization. * * Log Safety: SAFE */ declare interface OrganizationCannotBeRemoved { errorCode: "INVALID_ARGUMENT"; errorName: "OrganizationCannotBeRemoved"; errorDescription: "An organization cannot be removed from a project if it would result in a project with no organizations under a space marked with an organization."; errorInstanceId: string; parameters: { organizationRids: unknown; }; } /** * Log Safety: SAFE */ declare interface OrganizationGuestMember { principalType: _Core.PrincipalType; principalId: _Core.PrincipalId; } export declare namespace OrganizationGuestMembers { export { } } /** * The ADMINISTER role on Organization markings cannot be managed through the Marking Role Assignments endpoints. To manage administrator roles for an Organization, use the Organization Role Assignment endpoints instead. * * Log Safety: UNSAFE */ declare interface OrganizationMarkingAdministerRoleNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "OrganizationMarkingAdministerRoleNotSupported"; errorDescription: "The ADMINISTER role on Organization markings cannot be managed through the Marking Role Assignments endpoints. To manage administrator roles for an Organization, use the Organization Role Assignment endpoints instead."; errorInstanceId: string; parameters: { markingId: unknown; organizationRid: unknown; }; } /** * At least one of the organization markings associated with a passed organization is not applied on the requested space. * * Log Safety: SAFE */ declare interface OrganizationMarkingNotOnSpace { errorCode: "INVALID_ARGUMENT"; errorName: "OrganizationMarkingNotOnSpace"; errorDescription: "At least one of the organization markings associated with a passed organization is not applied on the requested space."; errorInstanceId: string; parameters: { spaceRid: unknown; organizationRids: unknown; }; } /** * Adding an organization marking as a regular marking is not supported. Use the organization endpoints on a project resource instead. * * Log Safety: UNSAFE */ declare interface OrganizationMarkingNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "OrganizationMarkingNotSupported"; errorDescription: "Adding an organization marking as a regular marking is not supported. Use the organization endpoints on a project resource instead."; errorInstanceId: string; parameters: { markingIds: unknown; }; } /** * Log Safety: UNSAFE */ declare type OrganizationName = LooselyBrandedString_3<"OrganizationName">; /** * An organization with the same name already exists. * * Log Safety: UNSAFE */ declare interface OrganizationNameAlreadyExists { errorCode: "INVALID_ARGUMENT"; errorName: "OrganizationNameAlreadyExists"; errorDescription: "An organization with the same name already exists."; errorInstanceId: string; parameters: { displayName: unknown; }; } /** * The given Organization could not be found. * * Log Safety: SAFE */ declare interface OrganizationNotFound { errorCode: "NOT_FOUND"; errorName: "OrganizationNotFound"; errorDescription: "The given Organization could not be found."; errorInstanceId: string; parameters: { organizationRid: unknown; }; } /** * Log Safety: SAFE */ declare type OrganizationRid = LooselyBrandedString<"OrganizationRid">; /** * Identifier of the organization associated with a checkpoint. * * Log Safety: SAFE */ declare type OrganizationRid_2 = LooselyBrandedString_11<"OrganizationRid">; /** * Log Safety: SAFE */ declare interface OrganizationRoleAssignment { principalType: _Core.PrincipalType; principalId: _Core.PrincipalId; roleId: _Core.RoleId; } export declare namespace OrganizationRoleAssignments { export { list_12 as list, add_6 as add, remove_6 as remove } } export declare namespace Organizations { export { get_10 as get, replace_6 as replace, listAvailableRoles } } /** * List of Organizations directly applied to a Project. The number of Organizations on a Project is * typically small so the `pageSize` and `pageToken` parameters are not required. * * @public * * Required Scopes: [] * URL: /v2/filesystem/projects/{projectRid}/organizations */ declare function organizations($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ projectRid: _Filesystem_2.ProjectRid, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Filesystem_2.ListOrganizationsOfProjectResponse>; /** * At least one organization RID could not be found. * * Log Safety: SAFE */ declare interface OrganizationsNotFound { errorCode: "NOT_FOUND"; errorName: "OrganizationsNotFound"; errorDescription: "At least one organization RID could not be found."; errorInstanceId: string; parameters: { organizationRids: unknown; }; } /** * The orientation information as encoded in EXIF metadata. * * Log Safety: SAFE */ declare interface Orientation { rotationAngle?: RotationAngle; flipAxis?: FlipAxis; } /** * Returns objects where at least 1 query is satisfied. * * Log Safety: UNSAFE */ declare interface OrQuery { value: Array; } /** * @deprecated Use `OrQueryV2` in the `foundry.ontologies` package * * Returns objects where at least 1 query is satisfied. * * Log Safety: UNSAFE */ declare interface OrQueryV2 { value: Array; } /** * Returns objects where at least 1 query is satisfied. * * Log Safety: UNSAFE */ declare interface OrQueryV2_2 { value: Array; } /** * Trigger whenever any of the given triggers emit an event. * * Log Safety: UNSAFE */ declare interface OrTrigger { triggers: Array; } /** * A validation error that does not match any specific known type. * * Log Safety: UNSAFE */ declare interface OtherValidationError { message: string; } /** * A string alias used to identify outputs in a Model Studio configuration. * * Log Safety: UNSAFE */ declare type OutputAlias = LooselyBrandedString_15<"OutputAlias">; /** * The output resource is in a different project than the Model Studio. * * Log Safety: UNSAFE */ declare interface OutputResourceInDifferentProjectError { resourceRid: string; outputAlias: OutputAlias; } /** * The output resource does not exist or is in the trash. * * Log Safety: UNSAFE */ declare interface OutputResourceNotFoundError { resourceRid: string; outputAlias: OutputAlias; } export declare namespace Pack { export { ActivityCollaborativeUpdate, ActivityCreated, ActivityDeleted, ActivityEvent, AllPrincipal, ClientId, ClientSupportedVersionRange, CreateChildDocumentRequestBody, CreateDocumentAsChildRequest, CreateDocumentMatchingSecurityRequestBody, CreateDocumentRequest, CreateDocumentTypeRequest, CreateDocumentV2Request, CreateDocumentV2RequestBody, CreateDocumentWithMatchingSecurityRequest, CreateFirstPartyDocumentTypeRequest, CreateFirstPartyDocumentTypeRequestBody, CreateFirstPartyDocumentTypeResponse, CustomPresenceEvent, DeletionMethod, DiscretionaryPrincipal, DiscretionaryPrincipalGroupId, DiscretionaryPrincipalUserId, DiscretionarySecurityPrincipalType, Document_3 as Document, DocumentActivitySubscriptionRequest, DocumentCreateEventData, DocumentCustomEventData, DocumentDeletionUpdate, DocumentDescriptionUpdateEventData, DocumentDiscretionarySecurity, DocumentDiscretionarySecurityUpdateEventData, DocumentEditDescription, DocumentMandatorySecurity, DocumentMandatorySecurityUpdateEventData, DocumentMetadataUpdate, DocumentName, DocumentOntologyRid, DocumentOperation, DocumentParent, DocumentParentFolder, DocumentParentNamespace, DocumentPresenceChangeEvent, DocumentPresenceSubscriptionRequest, DocumentPublishMessage, DocumentRenameEventData, DocumentRid_2 as DocumentRid, DocumentSearchQuery, DocumentSearchRequest, DocumentSearchResponse, DocumentSecurity, DocumentSort, DocumentSortField, DocumentStorageType, DocumentType_2 as DocumentType, DocumentTypeAsset, DocumentTypeName, DocumentTypeRid, DocumentTypeSchema, DocumentUpdate, DocumentUpdateMessage, DocumentUpdateSubscriptionRequest, DoubleValue_2 as DoubleValue, EditId, ErrorCode, ErrorMessage, EventDataUnion, EventId, FieldDef, FieldKey, FieldTypeArray, FieldTypeMap, FieldTypeSet, FieldTypeUnion, FieldValueBoolean, FieldValueDatetime, FieldValueDocumentRef, FieldValueDouble, FieldValueInteger, FieldValueMediaRef, FieldValueModelRef, FieldValueObjectRef, FieldValueString, FieldValueText, FieldValueType, FieldValueUnion, FieldValueUnmanagedJson, FieldValueUserRef, FileSystemType, FolderRid_5 as FolderRid, GetOperationalVersionDocumentTypeRequest, GetOperationalVersionResponse, GroupId_2 as GroupId, IntegerValue_2 as IntegerValue, InterfaceTypeRid_2 as InterfaceTypeRid, LoadByNameDocumentTypesRequest, MarkingId_5 as MarkingId, MarkingPrincipal, ModelDef, ModelTypeKey, NamespaceRid_2 as NamespaceRid, ObjectTypeRid_3 as ObjectTypeRid, PageToken_2 as PageToken, PresenceCollaborativeUpdate, PresencePublishMessage, PresencePublishMessageType, RecordDef, ResolveDocumentApplicationResponse, RevisionId, SchemaMetadata, SchemaValidationFailure, SchemaVersion, SchemaViolation, SchemaViolationType, SearchDocumentsRequest, TextLength, UnionDef, UnionVariantKey, UpdateDocumentMetadataRequest, UpdateDocumentRequest, UpdateSchemaDocumentTypeRequest, UpdateSchemaRequestBody, UpdateSchemaResponse, UpdateSchemaSuccess, UserId_2 as UserId, UserPresence, YjsSchema, YjsUpdate, ArtifactDocumentCreationMissingNamespace, CannotDeleteAutosavedDocument, CannotDeleteHiddenDocument, CompassDocumentCreationMissingParentFolder, CompassDocumentCreationWithDiscretionarySecurityNotSupported, CreateDocumentAsChildPermissionDenied, CreateDocumentOfTypePermissionDenied, CreateDocumentPermissionDenied_2 as CreateDocumentPermissionDenied, CreateDocumentTypePermissionDenied, CreateDocumentV2PermissionDenied, CreateDocumentWithMatchingSecurityPermissionDenied, CreateFirstPartyDocumentTypePermissionDenied, DeleteDocumentPermissionDenied, DocumentNotFound_2 as DocumentNotFound, DocumentTypeAlreadyExists, DocumentTypeNameNotFound, DocumentTypeNotCompassBacked, DocumentTypeNotFound, GetOperationalVersionDocumentTypePermissionDenied, InvalidChildDocumentParent, InvalidDocumentTypeName, InvalidDocumentTypeVersion, LoadByNameDocumentTypesPermissionDenied, ResolveApplicationDocumentPermissionDenied, SchemaUpdateConflict, SearchDocumentsPermissionDenied, UpdateDocumentNotSupported, UpdateDocumentPermissionDenied, UpdateSchemaDocumentTypePermissionDenied, Documents, DocumentTypes } } declare namespace _Pack { export { LooselyBrandedString_19 as LooselyBrandedString, ActivityCollaborativeUpdate, ActivityCreated, ActivityDeleted, ActivityEvent, AllPrincipal, ClientId, ClientSupportedVersionRange, CreateChildDocumentRequestBody, CreateDocumentAsChildRequest, CreateDocumentMatchingSecurityRequestBody, CreateDocumentRequest, CreateDocumentTypeRequest, CreateDocumentV2Request, CreateDocumentV2RequestBody, CreateDocumentWithMatchingSecurityRequest, CreateFirstPartyDocumentTypeRequest, CreateFirstPartyDocumentTypeRequestBody, CreateFirstPartyDocumentTypeResponse, CustomPresenceEvent, DeletionMethod, DiscretionaryPrincipal, DiscretionaryPrincipalGroupId, DiscretionaryPrincipalUserId, DiscretionarySecurityPrincipalType, Document_3 as Document, DocumentActivitySubscriptionRequest, DocumentCreateEventData, DocumentCustomEventData, DocumentDeletionUpdate, DocumentDescriptionUpdateEventData, DocumentDiscretionarySecurity, DocumentDiscretionarySecurityUpdateEventData, DocumentEditDescription, DocumentMandatorySecurity, DocumentMandatorySecurityUpdateEventData, DocumentMetadataUpdate, DocumentName, DocumentOntologyRid, DocumentOperation, DocumentParent, DocumentParentFolder, DocumentParentNamespace, DocumentPresenceChangeEvent, DocumentPresenceSubscriptionRequest, DocumentPublishMessage, DocumentRenameEventData, DocumentRid_2 as DocumentRid, DocumentSearchQuery, DocumentSearchRequest, DocumentSearchResponse, DocumentSecurity, DocumentSort, DocumentSortField, DocumentStorageType, DocumentType_2 as DocumentType, DocumentTypeAsset, DocumentTypeName, DocumentTypeRid, DocumentTypeSchema, DocumentUpdate, DocumentUpdateMessage, DocumentUpdateSubscriptionRequest, DoubleValue_2 as DoubleValue, EditId, ErrorCode, ErrorMessage, EventDataUnion, EventId, FieldDef, FieldKey, FieldTypeArray, FieldTypeMap, FieldTypeSet, FieldTypeUnion, FieldValueBoolean, FieldValueDatetime, FieldValueDocumentRef, FieldValueDouble, FieldValueInteger, FieldValueMediaRef, FieldValueModelRef, FieldValueObjectRef, FieldValueString, FieldValueText, FieldValueType, FieldValueUnion, FieldValueUnmanagedJson, FieldValueUserRef, FileSystemType, FolderRid_5 as FolderRid, GetOperationalVersionDocumentTypeRequest, GetOperationalVersionResponse, GroupId_2 as GroupId, IntegerValue_2 as IntegerValue, InterfaceTypeRid_2 as InterfaceTypeRid, LoadByNameDocumentTypesRequest, MarkingId_5 as MarkingId, MarkingPrincipal, ModelDef, ModelTypeKey, NamespaceRid_2 as NamespaceRid, ObjectTypeRid_3 as ObjectTypeRid, PageToken_2 as PageToken, PresenceCollaborativeUpdate, PresencePublishMessage, PresencePublishMessageType, RecordDef, ResolveDocumentApplicationResponse, RevisionId, SchemaMetadata, SchemaValidationFailure, SchemaVersion, SchemaViolation, SchemaViolationType, SearchDocumentsRequest, TextLength, UnionDef, UnionVariantKey, UpdateDocumentMetadataRequest, UpdateDocumentRequest, UpdateSchemaDocumentTypeRequest, UpdateSchemaRequestBody, UpdateSchemaResponse, UpdateSchemaSuccess, UserId_2 as UserId, UserPresence, YjsSchema, YjsUpdate } } /** * Page range for document extraction. * * Log Safety: SAFE */ declare interface PageRange { startPageInclusive?: number; endPageExclusive?: number; } /** * The page size to use for the endpoint. * * Log Safety: SAFE */ declare type PageSize = number; /** * The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request. * * Log Safety: UNSAFE */ declare type PageToken = LooselyBrandedString<"PageToken">; /** * The page token indicates where to start paging on. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request. api-gateway's Core.PageToken is an immutable @Unsafe String, which is incompatible with PACK Document search. This is a PACK API specific PageToken that is @Safe. * * Log Safety: SAFE */ declare type PageToken_2 = LooselyBrandedString_19<"PageToken">; /** * The palette interpretation of a band. * * Log Safety: SAFE */ declare type PaletteInterpretation = "GRAY" | "RGB" | "RGBA" | "CMYK" | "HLS"; /** * A variable configured in the application state of an Agent in AIP Chatbot Studio. * * Log Safety: UNSAFE */ declare interface Parameter { parameterType: ParameterType; access: ParameterAccessMode; description?: string; } /** * Details about a parameter of an action or query. * * Log Safety: UNSAFE */ declare interface Parameter_2 { description?: string; baseType: ValueType; dataType?: OntologyDataType; required: boolean; } /** * Details about a parameter of a query. * * Log Safety: UNSAFE */ declare interface Parameter_3 { description?: string; dataType: QueryDataType_2; required: boolean; } /** * A parameter with its name and value. * * Log Safety: UNSAFE */ declare interface Parameter_4 { name: ParameterName; value: ParameterValue_2; } /** * READ_ONLY: Allows the variable to be read by the Agent, but the Agent cannot generate updates for it. READ_WRITE: Allows the variable to be read and updated by the Agent. * * Log Safety: SAFE */ declare type ParameterAccessMode = "READ_ONLY" | "READ_WRITE"; /** * A possible value for the parameter. * * Log Safety: UNSAFE */ declare interface ParameterAllowedValueOption { displayName: _Core.DisplayName; value: DataValue; } /** * The allowed-values constraint configured on an action parameter. * * Log Safety: UNSAFE */ declare type ParameterAllowedValues = ({ type: "oneOf"; } & OneOfAllowedValues) | ({ type: "datetime"; } & DatetimeAllowedValues) | ({ type: "attachment"; } & AttachmentAllowedValues) | ({ type: "valueType"; } & ValueTypeAllowedValues) | ({ type: "markdown"; } & MarkdownAllowedValues) | ({ type: "range"; } & RangeAllowedValues) | ({ type: "mustBeEmpty"; } & MustBeEmptyAllowedValues) | ({ type: "text"; } & TextAllowedValues); /** * An untyped parameter value. * * Log Safety: UNSAFE */ declare interface ParameterAnyValue { value: any; } /** * Bounds on the size of an array-typed parameter. * * Log Safety: SAFE */ declare interface ParameterArraySize { gte?: number; lte?: number; } /** * A boolean parameter value. * * Log Safety: UNSAFE */ declare interface ParameterBooleanValue { value: boolean; } /** * The source of a constraint bound value. * * Log Safety: UNSAFE */ declare type ParameterConstraintValue = { type: "static"; } & StaticConstraintValue; /** * A datetime bound value. * * Log Safety: UNSAFE */ declare type ParameterDatetimeValue = ({ type: "now"; } & NowDatetimeValue) | ({ type: "fixed"; } & FixedDatetimeValue) | ({ type: "relative"; } & RelativeDatetimeValue); /** * A date parameter value. * * Log Safety: UNSAFE */ declare interface ParameterDateValue { value: string; } /** * A decimal parameter value. * * Log Safety: UNSAFE */ declare interface ParameterDecimalValue { value: string; } /** * A double parameter value. * * Log Safety: UNSAFE */ declare interface ParameterDoubleValue { value: number; } /** * A constraint that an action parameter value must satisfy in order to be considered valid. Constraints can be configured on action parameters in the Ontology Manager. Applicable constraints are determined dynamically based on parameter inputs. Parameter values are evaluated against the final set of constraints. The type of the constraint. | Type | Description | |-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | arraySize | The parameter expects an array of values and the size of the array must fall within the defined range. | | groupMember | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | | objectPropertyValue | The parameter value must be a property value of an object found within an object set. | | objectQueryResult | The parameter value must be the primary key of an object found within an object set. | | oneOf | The parameter has a manually predefined set of options. | | range | The parameter value must be within the defined range. | | stringLength | The parameter value must have a length within the defined range. | | stringRegexMatch | The parameter value must match a predefined regular expression. | | unevaluable | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | * * Log Safety: UNSAFE */ declare type ParameterEvaluatedConstraint = ({ type: "struct"; } & StructEvaluatedConstraint) | ({ type: "oneOf"; } & OneOfConstraint) | ({ type: "array"; } & ArrayEvaluatedConstraint) | ({ type: "groupMember"; } & GroupMemberConstraint) | ({ type: "objectPropertyValue"; } & ObjectPropertyValueConstraint) | ({ type: "range"; } & RangeConstraint) | ({ type: "arraySize"; } & ArraySizeConstraint) | ({ type: "objectQueryResult"; } & ObjectQueryResultConstraint) | ({ type: "stringLength"; } & StringLengthConstraint) | ({ type: "stringRegexMatch"; } & StringRegexMatchConstraint) | ({ type: "unevaluable"; } & UnevaluableConstraint); /** * Represents the validity of a parameter against the configured constraints. * * Log Safety: UNSAFE */ declare interface ParameterEvaluationResult { result: ValidationResult; evaluatedConstraints: Array; required: boolean; defaultValue?: DataValue; } /** * A float parameter value. * * Log Safety: UNSAFE */ declare interface ParameterFloatValue { value: number; } /** * The unique identifier for a variable configured in the application state of an Agent in AIP Chatbot Studio. * * Log Safety: UNSAFE */ declare type ParameterId = LooselyBrandedString_4<"ParameterId">; /** * The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. Parameters can be viewed and managed in the Ontology Manager. * * Log Safety: UNSAFE */ declare type ParameterId_2 = LooselyBrandedString_5<"ParameterId">; /** * The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. Parameters can be viewed and managed in the Ontology Manager. * * Log Safety: UNSAFE */ declare type ParameterId_3 = LooselyBrandedString_9<"ParameterId">; /** * Represents a parameter ID argument in a logic rule. * * Log Safety: UNSAFE */ declare interface ParameterIdArgument { parameterId: ParameterId_2; } /** * An integer parameter value. * * Log Safety: UNSAFE */ declare interface ParameterIntegerValue { value: number; } /** * A parameter value that is a list of other parameter values. All values in the list must be of the same type. * * Log Safety: UNSAFE */ declare interface ParameterListValue { values: Array; elementType: ColumnType; } /** * A long integer parameter value. * * Log Safety: UNSAFE */ declare interface ParameterLongValue { value: string; } /** * A mapping of named parameters to their values. * * Log Safety: UNSAFE */ declare type ParameterMapping = Record; /** * A map parameter value. * * Log Safety: UNSAFE */ declare interface ParameterMapValue { values: Record; } /** * The name of an experiment parameter. * * Log Safety: UNSAFE */ declare type ParameterName = LooselyBrandedString_15<"ParameterName">; /** * The name of a SQL query parameter. * * Log Safety: UNSAFE */ declare type ParameterName_2 = LooselyBrandedString_21<"ParameterName">; /** * Returns action types with a parameter whose name matches the given string predicate. * * Log Safety: UNSAFE */ declare interface ParameterNameActionTypesQueryV2 { value: FullTextStringPredicateV2; } /** * A null parameter value. * * Log Safety: SAFE */ declare interface ParameterNullValue { } /** * The parameter object reference or parameter default value is not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface ParameterObjectNotFound { errorCode: "NOT_FOUND"; errorName: "ParameterObjectNotFound"; errorDescription: "The parameter object reference or parameter default value is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { objectType: unknown; primaryKey: unknown; }; } /** * The parameter object set RID is not found, or the client token does not have access to it. * * Log Safety: SAFE */ declare interface ParameterObjectSetRidNotFound { errorCode: "NOT_FOUND"; errorName: "ParameterObjectSetRidNotFound"; errorDescription: "The parameter object set RID is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { objectSetRid: unknown; }; } /** * A possible value for the parameter. This is defined in the Ontology Manager by Actions admins. * * Log Safety: UNSAFE */ declare interface ParameterOption { displayName?: _Core.DisplayName; value?: any; } /** * Returns action types with a parameter matching the given parameter rid. * * Log Safety: SAFE */ declare interface ParameterRidActionTypesQueryV2 { value: ActionParameterRid; } /** * Parameters for SQL query execution. Can be either unnamed positional parameters or named parameter mappings. * * Log Safety: UNSAFE */ declare type Parameters_2 = ({ type: "unnamedParameterValues"; } & UnnamedParameterValues) | ({ type: "namedParameterMapping"; } & NamedParameterMapping); /** * A short integer parameter value. * * Log Safety: UNSAFE */ declare interface ParameterShortValue { value: number; } /** * The provided parameter ID was not found for the action. Please look at the configuredParameterIds field to see which ones are available. * * Log Safety: UNSAFE */ declare interface ParametersNotFound { errorCode: "INVALID_ARGUMENT"; errorName: "ParametersNotFound"; errorDescription: "The provided parameter ID was not found for the action. Please look at the configuredParameterIds field to see which ones are available."; errorInstanceId: string; parameters: { actionType: unknown; unknownParameterIds: unknown; configuredParameterIds: unknown; }; } /** * A string parameter value. * * Log Safety: UNSAFE */ declare interface ParameterStringValue { value: string; } /** * A struct composed of ordered elements, each with a name and value. * * Log Safety: UNSAFE */ declare interface ParameterStructValue { structElements: Array; } /** * A timestamp parameter value. * * Log Safety: UNSAFE */ declare interface ParameterTimestampValue { value: string; } /** * Log Safety: UNSAFE */ declare type ParameterType = ({ type: "string"; } & StringParameter) | ({ type: "objectSet"; } & ObjectSetParameter); /** * The type of the requested parameter is not currently supported by this API. If you need support for this, please reach out to Palantir Support. * * Log Safety: UNSAFE */ declare interface ParameterTypeNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "ParameterTypeNotSupported"; errorDescription: "The type of the requested parameter is not currently supported by this API. If you need support for this, please reach out to Palantir Support."; errorInstanceId: string; parameters: { parameterId: unknown; parameterBaseType: unknown; }; } /** * The value provided for a variable configured in the application state of an Agent. * * Log Safety: UNSAFE */ declare type ParameterValue = ({ type: "string"; } & StringParameterValue) | ({ type: "objectSet"; } & ObjectSetParameterValue); /** * A parameter value logged for an experiment. * * Log Safety: UNSAFE */ declare type ParameterValue_2 = ({ type: "datetime"; } & DatetimeParameter) | ({ type: "boolean"; } & BooleanParameter) | ({ type: "string"; } & StringParameter_2) | ({ type: "double"; } & DoubleParameter) | ({ type: "integer"; } & IntegerParameter); /** * A typed parameter value for SQL query execution. * * Log Safety: UNSAFE */ declare type ParameterValue_3 = ({ type: "date"; } & ParameterDateValue) | ({ type: "struct"; } & ParameterStructValue) | ({ type: "string"; } & ParameterStringValue) | ({ type: "double"; } & ParameterDoubleValue) | ({ type: "integer"; } & ParameterIntegerValue) | ({ type: "float"; } & ParameterFloatValue) | ({ type: "list"; } & ParameterListValue) | ({ type: "any"; } & ParameterAnyValue) | ({ type: "long"; } & ParameterLongValue) | ({ type: "boolean"; } & ParameterBooleanValue) | ({ type: "null"; } & ParameterNullValue) | ({ type: "short"; } & ParameterShortValue) | ({ type: "decimal"; } & ParameterDecimalValue) | ({ type: "map"; } & ParameterMapValue) | ({ type: "timestamp"; } & ParameterTimestampValue); /** * A value update for an application variable generated by the Agent. For StringParameter types, this will be the updated string value. For ObjectSetParameter types, this will be a Resource Identifier (RID) for the updated object set. * * Log Safety: UNSAFE */ declare type ParameterValueUpdate = ({ type: "string"; } & StringParameterValue) | ({ type: "objectSet"; } & ObjectSetParameterValueUpdate); /** * The user does not have permission to parent attachments. * * Log Safety: SAFE */ declare interface ParentAttachmentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ParentAttachmentPermissionDenied"; errorDescription: "The user does not have permission to parent attachments."; errorInstanceId: string; parameters: {}; } /** * The parent folder for the specified connection could not be found. * * Log Safety: SAFE */ declare interface ParentFolderNotFoundForConnection { errorCode: "NOT_FOUND"; errorName: "ParentFolderNotFoundForConnection"; errorDescription: "The parent folder for the specified connection could not be found."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /* Excluded from this release type: parquet */ /* Excluded from this release type: parquet_2 */ /** * Could not parquet the ExperimentArtifactTable. * * Log Safety: UNSAFE */ declare interface ParquetExperimentArtifactTablePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ParquetExperimentArtifactTablePermissionDenied"; errorDescription: "Could not parquet the ExperimentArtifactTable."; errorInstanceId: string; parameters: { experimentRid: unknown; experimentArtifactTableName: unknown; modelRid: unknown; }; } /** * Could not parquet the ExperimentSeries. * * Log Safety: UNSAFE */ declare interface ParquetExperimentSeriesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ParquetExperimentSeriesPermissionDenied"; errorDescription: "Could not parquet the ExperimentSeries."; errorInstanceId: string; parameters: { experimentSeriesName: unknown; experimentRid: unknown; modelRid: unknown; }; } /* Excluded from this release type: parseClassifications */ /** * The provided token does not have permission to parse the given classification strings. * * Log Safety: UNSAFE */ declare interface ParseClassificationsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ParseClassificationsPermissionDenied"; errorDescription: "The provided token does not have permission to parse the given classification strings."; errorInstanceId: string; parameters: { classificationStrings: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ParseClassificationsRequest { classificationStrings: Array; } /** * Log Safety: UNSAFE */ declare interface ParseClassificationsResponse { parsed: Record>; errors: Record; } /** * The identifier for a partition of a Foundry stream. * * Log Safety: SAFE */ declare type PartitionId = LooselyBrandedString_22<"PartitionId">; /** * A map of partition IDs to offsets. * * Log Safety: SAFE */ declare type PartitionOffsets = Record; /** * Records from a single partition with their offsets. * * Log Safety: DO_NOT_LOG */ declare type PartitionRecords = Array; /** * The number of partitions for a Foundry stream. * * Log Safety: SAFE */ declare type PartitionsCount = number; /** * The given path could not be found. * * Log Safety: UNSAFE */ declare interface PathNotFound { errorCode: "NOT_FOUND"; errorName: "PathNotFound"; errorDescription: "The given path could not be found."; errorInstanceId: string; parameters: { path: unknown; }; } /** * @public * * Required Scopes: [api:orchestration-write] * URL: /v2/orchestration/schedules/{scheduleRid}/pause */ declare function pause($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [scheduleRid: _Core.ScheduleRid]): Promise; /** * Could not pause the Schedule. * * Log Safety: SAFE */ declare interface PauseSchedulePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PauseSchedulePermissionDenied"; errorDescription: "Could not pause the Schedule."; errorInstanceId: string; parameters: { scheduleRid: unknown; }; } /** * PDF document format. * * Log Safety: SAFE */ declare interface PdfFormat { } /** * The configuration for the range of percentage values between which the health check is expected to succeed. * * Log Safety: SAFE */ declare interface PercentageBounds { lowerBoundPercentage?: PercentageValue; upperBoundPercentage?: PercentageValue; } /** * Configuration for percentage bounds check with severity settings. * * Log Safety: SAFE */ declare interface PercentageBoundsConfig { percentageBounds: PercentageBounds; severity: SeverityLevel; } /** * Configuration for percentage-based checks (such as null percentage). * * Log Safety: UNSAFE */ declare interface PercentageCheckConfig { columnName: ColumnName_3; percentageBounds?: PercentageBoundsConfig; medianDeviation?: MedianDeviationConfig; } /** * A percentage value in the range 0.0 to 100.0. Validation rules: must be greater than or equal to 0.0 must be less than or equal to 100.0 * * Log Safety: SAFE */ declare type PercentageValue = number; /** * PercentageValue must be less than or equal to 100.0 * * Log Safety: SAFE */ declare interface PercentageValueAboveMaximum { errorCode: "INVALID_ARGUMENT"; errorName: "PercentageValueAboveMaximum"; errorDescription: "PercentageValue must be less than or equal to 100.0"; errorInstanceId: string; parameters: { value: unknown; maxInclusive: unknown; }; } /** * PercentageValue must be greater than or equal to 0.0 * * Log Safety: SAFE */ declare interface PercentageValueBelowMinimum { errorCode: "INVALID_ARGUMENT"; errorName: "PercentageValueBelowMinimum"; errorDescription: "PercentageValue must be greater than or equal to 0.0"; errorInstanceId: string; parameters: { value: unknown; minInclusive: unknown; }; } /** * The performance mode for transcription. * * Log Safety: SAFE */ declare type PerformanceMode = "MORE_ECONOMICAL" | "MORE_PERFORMANT"; /** * Permanently delete the given resource from the trash. If the resource is not directly trashed, a * `ResourceNotTrashed` error will be thrown. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/resources/{resourceRid}/permanentlyDelete */ declare function permanentlyDelete($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [resourceRid: _Filesystem_2.ResourceRid]): Promise; /** * Could not permanentlyDelete the Resource. * * Log Safety: UNSAFE */ declare interface PermanentlyDeleteResourcePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PermanentlyDeleteResourcePermissionDenied"; errorDescription: "Could not permanentlyDelete the Resource."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Returns action types with the given permission model. * * Log Safety: SAFE */ declare interface PermissionModelActionTypesQueryV2 { value: ActionTypePermissionModelFilter; } /** * Authenticate as a user or service principal using a personal access token. Read the official Databricks documentation for information on generating a personal access token. * * Log Safety: DO_NOT_LOG */ declare interface PersonalAccessToken { personalAccessToken: EncryptedProperty; } /** * Returns objects where the specified field contains the provided value as a substring. * * Log Safety: UNSAFE */ declare interface PhraseQuery { field: FieldNameV1; value: string; } /** * Log Safety: DO_NOT_LOG */ declare type Plaintext = LooselyBrandedString_5<"Plaintext">; /** * Plain text transcription output format. * * Log Safety: SAFE */ declare interface PlainTextNoSegmentData { addTimestamps: boolean; } /** * Log Safety: DO_NOT_LOG */ declare type PlaintextValue = LooselyBrandedString_12<"PlaintextValue">; /** * PNG image format. * * Log Safety: SAFE */ declare interface PngFormat { } /** * Log Safety: UNSAFE */ declare interface Polygon { coordinates: Array; bbox?: BBox; } /** * @deprecated Use `PolygonValue` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare type PolygonValue = { type: "Polygon"; } & _Geo.Polygon; /** * Log Safety: UNSAFE */ declare type PolygonValue_2 = { type: "Polygon"; } & _Geo.Polygon; /** * The specified port is not in the valid range (1-65535). * * Log Safety: SAFE */ declare interface PortNotInRange { errorCode: "INVALID_ARGUMENT"; errorName: "PortNotInRange"; errorDescription: "The specified port is not in the valid range (1-65535)."; errorInstanceId: string; parameters: { port: unknown; }; } /** * GeoJSon fundamental geometry construct. A position is an array of numbers. There MUST be two or more elements. The first two elements are longitude and latitude, precisely in that order and using decimal numbers. Altitude or elevation MAY be included as an optional third element. Implementations SHOULD NOT extend positions beyond three elements because the semantics of extra elements are unspecified and ambiguous. Historically, some implementations have used a fourth element to carry a linear referencing measure (sometimes denoted as "M") or a numerical timestamp, but in most situations a parser will not be able to properly interpret these values. The interpretation and meaning of additional elements is beyond the scope of this specification, and additional elements MAY be ignored by parsers. * * Log Safety: UNSAFE */ declare type Position = Array; /* Excluded from this release type: postEdits */ /** * The import configuration for a PostgreSQL connection. * * Log Safety: UNSAFE */ declare interface PostgreSqlTableImportConfig { query: TableImportQuery; initialIncrementalState?: TableImportInitialIncrementalState; } /** * The request payload for staging edits to a transaction. * * Log Safety: UNSAFE */ declare interface PostTransactionEditsRequest { edits: Array; } /** * Log Safety: SAFE */ declare interface PostTransactionEditsResponse { } /** * A measurement of duration. * * Log Safety: SAFE */ declare interface PreciseDuration { value: number; unit: PreciseTimeUnit; } /** * The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days. * * Log Safety: SAFE */ declare type PreciseTimeUnit = "NANOSECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS"; /** * Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for the last term. Ordering of the terms in the query is preserved. * * Log Safety: UNSAFE */ declare interface PrefixOnLastTokenRule { query: string; } /** * Returns objects where the specified field starts with the provided value. * * Log Safety: UNSAFE */ declare interface PrefixQuery { field: FieldNameV1; value: string; } /* Excluded from this release type: preregisterGroup */ /** * Could not preregisterGroup the AuthenticationProvider. * * Log Safety: SAFE */ declare interface PreregisterGroupPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PreregisterGroupPermissionDenied"; errorDescription: "Could not preregisterGroup the AuthenticationProvider."; errorInstanceId: string; parameters: { enrollmentRid: unknown; authenticationProviderRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface PreregisterGroupRequest { name: GroupName_2; organizations: Array<_Core.OrganizationRid>; } /* Excluded from this release type: preregisterUser */ /** * Could not preregisterUser the AuthenticationProvider. * * Log Safety: SAFE */ declare interface PreregisterUserPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PreregisterUserPermissionDenied"; errorDescription: "Could not preregisterUser the AuthenticationProvider."; errorInstanceId: string; parameters: { enrollmentRid: unknown; authenticationProviderRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface PreregisterUserRequest { username: UserUsername; organization: _Core.OrganizationRid; givenName?: string; familyName?: string; email?: string; attributes?: Record; } /** * Log Safety: UNSAFE */ declare type PresenceCollaborativeUpdate = ({ type: "presenceChangeEvent"; } & DocumentPresenceChangeEvent) | ({ type: "customPresenceEvent"; } & CustomPresenceEvent) | ({ type: "error"; } & ErrorMessage); /** * Log Safety: UNSAFE */ declare interface PresencePublishMessage { schemaVersion?: SchemaVersion; messageType: PresencePublishMessageType; clientSupportedVersionRange: ClientSupportedVersionRange; } /** * Log Safety: UNSAFE */ declare type PresencePublishMessageType = { type: "custom"; } & CustomPresenceEvent; /** * Enables the use of preview functionality. * * Log Safety: SAFE */ declare type PreviewMode = boolean; /** * Checks the uniqueness and non-null values of one or more columns (primary key constraint). * * Log Safety: UNSAFE */ declare interface PrimaryKeyCheckConfig { subject: DatasetSubject; primaryKeyConfig: PrimaryKeyConfig; } /** * Configuration for primary key validation with severity settings. * * Log Safety: UNSAFE */ declare interface PrimaryKeyConfig { columnNames: Array; severity: SeverityLevel; } /** * Picks the row with the highest value of a list of columns, compared in order. * * Log Safety: UNSAFE */ declare interface PrimaryKeyLatestWinsResolutionStrategy { columns: Array; } /** * Specifies the primary key property of an object type which is present on all object types. * * Log Safety: SAFE */ declare interface PrimaryKeyPropertySelector { } /** * Duplicate primary key values may exist within the dataset – resolution required. * * Log Safety: UNSAFE */ declare interface PrimaryKeyResolutionDuplicate { deletionColumn?: string; resolutionStrategy: PrimaryKeyResolutionStrategy; } /** * Log Safety: UNSAFE */ declare type PrimaryKeyResolutionStrategy = { type: "latestWins"; } & PrimaryKeyLatestWinsResolutionStrategy; /** * Primary key values are unique within the dataset – no conflicts. * * Log Safety: SAFE */ declare interface PrimaryKeyResolutionUnique { } /** * Represents the primary key value that is used as a unique identifier for an object. * * Log Safety: UNSAFE */ declare type PrimaryKeyValue = any; /** * Log Safety: UNSAFE */ declare type PrimaryKeyValueV2 = ({ type: "dateValue"; } & DateValue) | ({ type: "stringValue"; } & StringValue) | ({ type: "timestampValue"; } & TimestampValue) | ({ type: "booleanValue"; } & BooleanValue) | ({ type: "integerValue"; } & IntegerValue) | ({ type: "doubleValue"; } & DoubleValue) | ({ type: "longValue"; } & LongValue); /** * Log Safety: SAFE */ declare type PrincipalFilterType = "queryString"; /** * The ID of a Foundry Group or User. * * Log Safety: SAFE */ declare type PrincipalId = string; /** * Represents a principal with just an ID, without the type. * * Log Safety: SAFE */ declare interface PrincipalIdOnly { principalId: _Core.PrincipalId; } /** * A principal (User or Group) with the given PrincipalId could not be found * * Log Safety: SAFE */ declare interface PrincipalNotFound { errorCode: "NOT_FOUND"; errorName: "PrincipalNotFound"; errorDescription: "A principal (User or Group) with the given PrincipalId could not be found"; errorInstanceId: string; parameters: { principalId: unknown; }; } /** * Log Safety: SAFE */ declare type PrincipalType = "USER" | "GROUP"; /** * Represents a user principal or group principal with an ID. * * Log Safety: SAFE */ declare interface PrincipalWithId { principalId: _Core.PrincipalId; principalType: _Core.PrincipalType; } /** * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/users/{userId}/profilePicture */ declare function profilePicture($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [userId: _Core.UserId]): Promise; /** * The user has not set a profile picture * * Log Safety: SAFE */ declare interface ProfilePictureNotFound { errorCode: "NOT_FOUND"; errorName: "ProfilePictureNotFound"; errorDescription: "The user has not set a profile picture"; errorInstanceId: string; parameters: { userId: unknown; }; } /** * The Profile service is unexpectedly not present. * * Log Safety: SAFE */ declare interface ProfileServiceNotPresent { errorCode: "INTERNAL"; errorName: "ProfileServiceNotPresent"; errorDescription: "The Profile service is unexpectedly not present."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface Project { rid: ProjectRid; displayName: ResourceDisplayName; description?: string; documentation?: string; path: ResourcePath; createdBy: _Core.CreatedBy; updatedBy: _Core.UpdatedBy; createdTime: _Core.CreatedTime; updatedTime: _Core.UpdatedTime; trashStatus: TrashStatus; spaceRid: SpaceRid; resourceLevelRoleGrantsAllowed: ProjectResourceLevelRoleGrantsAllowed; } /** * Project creation is not supported in the current user's space. * * Log Safety: SAFE */ declare interface ProjectCreationNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "ProjectCreationNotSupported"; errorDescription: "Project creation is not supported in the current user's space."; errorInstanceId: string; parameters: { spaceRid: unknown; }; } /** * A reference to a resource that exists outside of the Foundry filesystem such as a spark profile or an LLM model. * * Log Safety: UNSAFE */ declare interface ProjectExternalResourceReference { resourceRid: string; name: string; importedAt: string; importedBy: _Core.UserId; } /** * A reference to a resource that exists within another project * * Log Safety: UNSAFE */ declare interface ProjectFilesystemResourceReference { resourceRid: ResourceRid; name: string; importedAt: string; importedBy: _Core.UserId; } /** * The requested display name for the created project is already being used in the space. * * Log Safety: UNSAFE */ declare interface ProjectNameAlreadyExists { errorCode: "CONFLICT"; errorName: "ProjectNameAlreadyExists"; errorDescription: "The requested display name for the created project is already being used in the space."; errorInstanceId: string; parameters: { displayName: unknown; spaceRid: unknown; }; } /** * The given Project could not be found. * * Log Safety: SAFE */ declare interface ProjectNotFound { errorCode: "NOT_FOUND"; errorName: "ProjectNotFound"; errorDescription: "The given Project could not be found."; errorInstanceId: string; parameters: { projectRid: unknown; }; } /** * Whether role grants are allowed on individual resources within the Project. * * Log Safety: SAFE */ declare type ProjectResourceLevelRoleGrantsAllowed = boolean; /** * Log Safety: UNSAFE */ declare interface ProjectResourceReference { reference: ProjectResourceReferenceUnion; } export declare namespace ProjectResourceReferences { export { list_14 as list, add_7 as add, remove_7 as remove } } /** * A type of resource that has been referenced. A FILESYSTEM resource is anything that you can find in a Foundry file tree within a project. An EXTERNAL resource exists outside of the Foundry filesystem, such as a spark profile or an LLM model. * * Log Safety: SAFE */ declare type ProjectResourceReferenceType = "EXTERNAL" | "FILESYSTEM"; /** * A reference represents a resource from outside of the current project that has been imported to the given project. * * Log Safety: UNSAFE */ declare type ProjectResourceReferenceUnion = ({ type: "external"; } & ProjectExternalResourceReference) | ({ type: "filesystem"; } & ProjectFilesystemResourceReference); /** * The unique resource identifier (RID) of a Project. * * Log Safety: SAFE */ declare type ProjectRid = LooselyBrandedString_7<"ProjectRid">; /** * Identifier of the project that scoped a checkpoint. * * Log Safety: SAFE */ declare type ProjectRid_2 = LooselyBrandedString_11<"ProjectRid">; export declare namespace Projects { export { get_15 as get, create_6 as create, createFromTemplate, addOrganizations, removeOrganizations, organizations } } /** * The schedule will only build resources in the following projects. * * Log Safety: SAFE */ declare interface ProjectScope { projectRids: Array<_Filesystem.ProjectRid>; } /** * The project template RID referenced cannot be found. * * Log Safety: SAFE */ declare interface ProjectTemplateNotFound { errorCode: "NOT_FOUND"; errorName: "ProjectTemplateNotFound"; errorDescription: "The project template RID referenced cannot be found."; errorInstanceId: string; parameters: { projectTemplateRid: unknown; }; } /** * The unique resource identifier (RID) of a project template. * * Log Safety: SAFE */ declare type ProjectTemplateRid = LooselyBrandedString_7<"ProjectTemplateRid">; /** * An identifier for a variable used in a project template. * * Log Safety: UNSAFE */ declare type ProjectTemplateVariableId = LooselyBrandedString_7<"ProjectTemplateVariableId">; /** * The value assigned to a variable used in a project template. * * Log Safety: UNSAFE */ declare type ProjectTemplateVariableValue = LooselyBrandedString_7<"ProjectTemplateVariableValue">; /* Excluded from this release type: promoteVersion */ /** * Could not promoteVersion the Model. * * Log Safety: SAFE */ declare interface PromoteVersionModelPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PromoteVersionModelPermissionDenied"; errorDescription: "Could not promoteVersion the Model."; errorInstanceId: string; parameters: { modelRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface PromoteVersionModelRequest { sourceModelVersionRid: ModelVersionRid; branch?: _Core.BranchName; } /** * Properties used in ordering must have the same ids. * * Log Safety: UNSAFE */ declare interface PropertiesHaveDifferentIds { errorCode: "INVALID_ARGUMENT"; errorName: "PropertiesHaveDifferentIds"; errorDescription: "Properties used in ordering must have the same ids."; errorInstanceId: string; parameters: { properties: unknown; }; } /** * Results could not be filtered by the requested properties. Please mark the properties as Searchable and Selectable in the Ontology Manager to be able to filter on those properties. There may be a short delay between the time a property is marked Searchable and Selectable and when it can be used. * * Log Safety: UNSAFE */ declare interface PropertiesNotFilterable { errorCode: "INVALID_ARGUMENT"; errorName: "PropertiesNotFilterable"; errorDescription: "Results could not be filtered by the requested properties. Please mark the properties as Searchable and Selectable in the Ontology Manager to be able to filter on those properties. There may be a short delay between the time a property is marked Searchable and Selectable and when it can be used."; errorInstanceId: string; parameters: { properties: unknown; }; } /** * The requested properties are not found on the object type. * * Log Safety: UNSAFE */ declare interface PropertiesNotFound { errorCode: "NOT_FOUND"; errorName: "PropertiesNotFound"; errorDescription: "The requested properties are not found on the object type."; errorInstanceId: string; parameters: { objectType: unknown; properties: unknown; }; } /** * Search is not enabled on the specified properties. Please mark the properties as Searchable in the Ontology Manager to enable search on them. There may be a short delay between the time a property is marked Searchable and when it can be used. * * Log Safety: UNSAFE */ declare interface PropertiesNotSearchable { errorCode: "INVALID_ARGUMENT"; errorName: "PropertiesNotSearchable"; errorDescription: "Search is not enabled on the specified properties. Please mark the properties as Searchable in the Ontology Manager to enable search on them. There may be a short delay between the time a property is marked Searchable and when it can be used."; errorInstanceId: string; parameters: { propertyApiNames: unknown; }; } /** * Results could not be ordered by the requested properties. Please mark the properties as Searchable and Sortable in the Ontology Manager to enable their use in orderBy parameters. There may be a short delay between the time a property is set to Searchable and Sortable and when it can be used. * * Log Safety: UNSAFE */ declare interface PropertiesNotSortable { errorCode: "INVALID_ARGUMENT"; errorName: "PropertiesNotSortable"; errorDescription: "Results could not be ordered by the requested properties. Please mark the properties as Searchable and Sortable in the Ontology Manager to enable their use in orderBy parameters. There may be a short delay between the time a property is set to Searchable and Sortable and when it can be used."; errorInstanceId: string; parameters: { properties: unknown; }; } /** * Details about some property of an object. * * Log Safety: UNSAFE */ declare interface Property { description?: string; displayName?: _Core.DisplayName; baseType: ValueType; legacyPropertyId?: LegacyPropertyId; } /** * @deprecated Use `PropertyApiName` in the `foundry.ontologies` package * * The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager. * * Log Safety: UNSAFE */ declare type PropertyApiName = LooselyBrandedString<"PropertyApiName">; /** * The name of the property in the API. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager. * * Log Safety: UNSAFE */ declare type PropertyApiName_2 = LooselyBrandedString_5<"PropertyApiName">; /** * A property that was required to have an API name, such as a primary key, is missing one. You can set an API name for it using the Ontology Manager. * * Log Safety: UNSAFE */ declare interface PropertyApiNameNotFound { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyApiNameNotFound"; errorDescription: "A property that was required to have an API name, such as a primary key, is missing one. You can set an API name for it using the Ontology Manager."; errorInstanceId: string; parameters: { propertyId: unknown; propertyBaseType: unknown; }; } /** * @deprecated Use `PropertyApiNameSelector` in the `foundry.ontologies` package * * A property api name that references properties to query on. * * Log Safety: UNSAFE */ declare interface PropertyApiNameSelector { apiName: PropertyApiName; } /** * A property api name that references properties to query on. * * Log Safety: UNSAFE */ declare interface PropertyApiNameSelector_2 { apiName: PropertyApiName_2; } /** * The type of the requested property is not currently supported by this API. If you need support for this, please reach out to Palantir Support. * * Log Safety: UNSAFE */ declare interface PropertyBaseTypeNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyBaseTypeNotSupported"; errorDescription: "The type of the requested property is not currently supported by this API. If you need support for this, please reach out to Palantir Support."; errorInstanceId: string; parameters: { objectType: unknown; property: unknown; propertyBaseType: unknown; }; } /** * Formatting configuration for boolean property values. * * Log Safety: UNSAFE */ declare interface PropertyBooleanFormattingRule { valueIfTrue: string; valueIfFalse: string; } /** * The specified property cannot be blank. * * Log Safety: SAFE */ declare interface PropertyCannotBeBlank { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyCannotBeBlank"; errorDescription: "The specified property cannot be blank."; errorInstanceId: string; parameters: { propertyName: unknown; }; } /** * The specified property cannot be empty. * * Log Safety: SAFE */ declare interface PropertyCannotBeEmpty { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyCannotBeEmpty"; errorDescription: "The specified property cannot be empty."; errorInstanceId: string; parameters: { propertyName: unknown; }; } /** * Formatting configuration for date property values. * * Log Safety: UNSAFE */ declare interface PropertyDateFormattingRule { format: DatetimeFormat; } /** * A property that does not support exact matching is used in a setting that requires exact matching. * * Log Safety: UNSAFE */ declare interface PropertyExactMatchingNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyExactMatchingNotSupported"; errorDescription: "A property that does not support exact matching is used in a setting that requires exact matching."; errorInstanceId: string; parameters: { propertyBaseType: unknown; propertyTypeRid: unknown; }; } /** * Represents a filter used on properties. Endpoints that accept this supports optional parameters that have the form: properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString} to filter the returned objects. For instance, you may use properties.firstName.eq=John to find objects that contain a property called "firstName" that has the exact value of "John". The following are a list of supported property filters: properties.{propertyApiName}.contains - supported on arrays and can be used to filter array properties that have at least one of the provided values. If multiple query parameters are provided, then objects that have any of the given values for the specified property will be matched. properties.{propertyApiName}.eq - used to filter objects that have the exact value for the provided property. If multiple query parameters are provided, then objects that have any of the given values will be matched. For instance, if the user provides a request by doing ?properties.firstName.eq=John&properties.firstName.eq=Anna, then objects that have a firstName property of either John or Anna will be matched. This filter is supported on all property types except Arrays. properties.{propertyApiName}.neq - used to filter objects that do not have the provided property values. Similar to the eq filter, if multiple values are provided, then objects that have any of the given values will be excluded from the result. properties.{propertyApiName}.lt, properties.{propertyApiName}.lte, properties.{propertyApiName}.gt properties.{propertyApiName}.gte - represent less than, less than or equal to, greater than, and greater than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal. properties.{propertyApiName}.isNull - used to filter objects where the provided property is (or is not) null. This filter is supported on all property types. * * Log Safety: SAFE */ declare type PropertyFilter = LooselyBrandedString_5<"PropertyFilter">; /** * At least one of the requested property filters are not supported. See the documentation of PropertyFilter for a list of supported property filters. * * Log Safety: UNSAFE */ declare interface PropertyFiltersNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyFiltersNotSupported"; errorDescription: "At least one of the requested property filters are not supported. See the documentation of PropertyFilter for a list of supported property filters."; errorInstanceId: string; parameters: { propertyFilters: unknown; property: unknown; }; } /** * The immutable ID of a property. Property IDs are only used to identify properties in the Ontology Manager application and assign them API names. In every other case, API names should be used instead of property IDs. * * Log Safety: UNSAFE */ declare type PropertyId = LooselyBrandedString_5<"PropertyId">; /** * @deprecated Use `PropertyIdentifier` in the `foundry.ontologies` package * * An identifier used to select properties or struct fields. * * Log Safety: UNSAFE */ declare type PropertyIdentifier = ({ type: "property"; } & PropertyApiNameSelector) | ({ type: "structField"; } & StructFieldSelector); /** * An identifier used to select properties or struct fields. * * Log Safety: UNSAFE */ declare type PropertyIdentifier_2 = ({ type: "property"; } & PropertyApiNameSelector_2) | ({ type: "structField"; } & StructFieldSelector_2) | ({ type: "propertyWithLoadLevel"; } & PropertyWithLoadLevelSelector) | ({ type: "titleProperty"; } & TitlePropertySelector) | ({ type: "primaryKeyProperty"; } & PrimaryKeyPropertySelector); /** * Log Safety: UNSAFE */ declare interface PropertyImplementation { propertyApiName: PropertyApiName_2; } /** * Formatting configuration for known Foundry types. * * Log Safety: SAFE */ declare interface PropertyKnownTypeFormattingRule { knownType: KnownType; } /** * The load level of the property: APPLY_REDUCERS: Returns a single value of an array as configured in the ontology. EXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology. APPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value. NO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value. * * Log Safety: UNSAFE */ declare type PropertyLoadLevel = ({ type: "applyReducersAndExtractMainValue"; } & ApplyReducersAndExtractMainValueLoadLevel) | ({ type: "applyReducers"; } & ApplyReducersLoadLevel) | ({ type: "extractMainValue"; } & ExtractMainValueLoadLevel) | ({ type: "noLoadLevel"; } & NoLoadLevel); /** * All marking requirements applicable to a property value. * * Log Safety: UNSAFE */ declare interface PropertyMarkingSummary { conjunctive?: ConjunctiveMarkingSummary; disjunctive?: DisjunctiveMarkingSummary; containerConjunctive?: ContainerConjunctiveMarkingSummary; containerDisjunctive?: ContainerDisjunctiveMarkingSummary; } /** * Failed to find a provided property for a given object. * * Log Safety: SAFE */ declare interface PropertyNotFound { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyNotFound"; errorDescription: "Failed to find a provided property for a given object."; errorInstanceId: string; parameters: {}; } /** * Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly. * * Log Safety: SAFE */ declare interface PropertyNotFoundOnObject { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyNotFoundOnObject"; errorDescription: "Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly."; errorInstanceId: string; parameters: { objectTypeRid: unknown; objectRid: unknown; objectPropertyRid: unknown; }; } /** * Wrapper for numeric formatting options. * * Log Safety: UNSAFE */ declare interface PropertyNumberFormattingRule { numberType: PropertyNumberFormattingRuleType; } /** * Log Safety: UNSAFE */ declare type PropertyNumberFormattingRuleType = ({ type: "standard"; } & NumberFormatStandard) | ({ type: "duration"; } & NumberFormatDuration) | ({ type: "fixedValues"; } & NumberFormatFixedValues) | ({ type: "affix"; } & NumberFormatAffix) | ({ type: "scale"; } & NumberFormatScale) | ({ type: "currency"; } & NumberFormatCurrency) | ({ type: "standardUnit"; } & NumberFormatStandardUnit) | ({ type: "customUnit"; } & NumberFormatCustomUnit) | ({ type: "ratio"; } & NumberFormatRatio); /** * Log Safety: UNSAFE */ declare type PropertyOrStructFieldOfPropertyImplementation = ({ type: "structFieldOfProperty"; } & StructFieldOfPropertyImplementation) | ({ type: "property"; } & PropertyImplementation); /** * A disjunctive set of security results for a property value. * * Log Safety: UNSAFE */ declare interface PropertySecurities { disjunction: Array; } /** * Log Safety: UNSAFE */ declare type PropertySecurity = ({ type: "propertyMarkingSummary"; } & PropertyMarkingSummary) | ({ type: "unsupportedPolicy"; } & UnsupportedPolicy) | ({ type: "errorComputingSecurity"; } & ErrorComputingSecurity); /** * Formatting configuration for timestamp property values. * * Log Safety: UNSAFE */ declare interface PropertyTimestampFormattingRule { format: DatetimeFormat; displayTimezone: DatetimeTimezone; } /** * Log Safety: UNSAFE */ declare type PropertyTypeApiName = LooselyBrandedString_5<"PropertyTypeApiName">; /** * The provided propertyIdentifier is not configured with an embedding model in the ontology. * * Log Safety: SAFE */ declare interface PropertyTypeDoesNotSupportNearestNeighbors { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyTypeDoesNotSupportNearestNeighbors"; errorDescription: "The provided propertyIdentifier is not configured with an embedding model in the ontology."; errorInstanceId: string; parameters: {}; } /** * Describes how a single object type property is bound to its backing tabular datasource. A property may be backed by a single column, by a struct (with nested field mappings), or be edit-only (no backing column even though it is permissioned to the tabular datasource). * * Log Safety: UNSAFE */ declare type PropertyTypeMappingInfo = ({ type: "struct"; } & StructPropertyMapping) | ({ type: "column"; } & ColumnPropertyMapping) | ({ type: "editOnly"; } & EditOnlyPropertyMapping); /** * The requested property type is not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface PropertyTypeNotFound { errorCode: "NOT_FOUND"; errorName: "PropertyTypeNotFound"; errorDescription: "The requested property type is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { objectTypeApiName: unknown; propertyApiName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface PropertyTypeReference { propertyApiName: string; } /** * Log Safety: UNSAFE */ declare type PropertyTypeReferenceOrStringConstant = ({ type: "constant"; } & StringConstant) | ({ type: "propertyType"; } & PropertyTypeReference); /** * @deprecated Use `PropertyTypeRid` in the `foundry.ontologies` package * * The RID for a property type from an ontology object. * * Log Safety: SAFE */ declare type PropertyTypeRid = LooselyBrandedString<"PropertyTypeRid">; /** * The unique resource identifier of a property. * * Log Safety: SAFE */ declare type PropertyTypeRid_2 = LooselyBrandedString_5<"PropertyTypeRid">; /** * The requested property type RID is not found, or the client token does not have access to it. * * Log Safety: SAFE */ declare interface PropertyTypeRidNotFound { errorCode: "NOT_FOUND"; errorName: "PropertyTypeRidNotFound"; errorDescription: "The requested property type RID is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { propertyTypeRid: unknown; }; } /** * The search on the property types are not supported. See the Search Objects documentation for a list of supported search queries on different property types. * * Log Safety: UNSAFE */ declare interface PropertyTypesSearchNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "PropertyTypesSearchNotSupported"; errorDescription: "The search on the property types are not supported. See the Search Objects documentation for a list of supported search queries on different property types."; errorInstanceId: string; parameters: { parameters: unknown; }; } /** * The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example. * * Log Safety: UNSAFE */ declare type PropertyTypeStatus = ({ type: "deprecated"; } & DeprecatedPropertyTypeStatus) | ({ type: "active"; } & ActivePropertyTypeStatus) | ({ type: "experimental"; } & ExperimentalPropertyTypeStatus) | ({ type: "example"; } & ExamplePropertyTypeStatus); /** * Log Safety: SAFE */ declare type PropertyTypeVisibility = "NORMAL" | "PROMINENT" | "HIDDEN"; /** * Details about some property of an object. * * Log Safety: UNSAFE */ declare interface PropertyV2 { description?: string; displayName?: _Core.DisplayName; dataType: ObjectPropertyType; rid: PropertyTypeRid_2; status?: PropertyTypeStatus; visibility?: PropertyTypeVisibility; valueTypeApiName?: ValueTypeApiName; valueFormatting?: PropertyValueFormattingRule; typeClasses: Array; } /** * @deprecated Use `PropertyValue` in the `foundry.ontologies` package * * Represents the value of a property in the following format. | Type | JSON encoding | Example | |----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| | Array | array | ["alpha", "bravo", "charlie"] | | Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} | | Boolean | boolean | true | | Byte | number | 31 | | CipherText | string | "CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER" | | Date | ISO 8601 extended local date string |"2021-05-01"| | Decimal | string |"2.718281828"| | Double | number |3.14159265| | Float | number |3.14159265| | GeoPoint | geojson |{"type":"Point","coordinates":[102.0,0.5]}| | GeoShape | geojson |{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}| | Integer | number |238940| | Long | string |"58319870951433"| | Short | number |8739| | String | string |"Call me Ishmael"| | Timestamp | ISO 8601 extended offset date-time string in UTC zone |"2021-01-04T05:00:00Z"` | Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. * * Log Safety: UNSAFE */ declare type PropertyValue = any; /** * Represents the value of a property in the following format. | Type | JSON encoding | Example | |---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------| | Array | array | ["alpha", "bravo", "charlie"] | | Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} | | Boolean | boolean | true | | Byte | number | 31 | | CipherText | string | "CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER" | | Date | ISO 8601 extended local date string | "2021-05-01" | | Decimal | string | "2.718281828" | | Double | number | 3.14159265 | | Float | number | 3.14159265 | | GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} | | GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} | | Integer | number | 238940 | | Long | string | "58319870951433" | | MediaReference| JSON encoded MediaReference object | {"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}} | | Secured Property Value | JSON encoded SecuredPropertyValue object | {"value": 10, "propertySecurityIndex" : 5} | | Short | number | 8739 | | String | string | "Call me Ishmael" | | Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} | | Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" | | Timeseries | JSON encoded TimeseriesProperty object or seriesId string | {"seriesId": "wellPressureSeriesId", "syncRid": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df"} or {"templateRid": "ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9", "templateVersion": "0.0.0"} or "wellPressureSeriesId"| | | Vector | array | [0.1, 0.3, 0.02, 0.05 , 0.8, 0.4] | Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. * * Log Safety: UNSAFE */ declare type PropertyValue_2 = any; /** * Represents the value of a property in string format. This is used in URL parameters. * * Log Safety: UNSAFE */ declare type PropertyValueEscapedString = LooselyBrandedString_5<"PropertyValueEscapedString">; /** * This feature is experimental and may change in a future release. Comprehensive formatting configuration for displaying property values in user interfaces. Supports different value types including numbers, dates, timestamps, booleans, and known Foundry types. Each formatter type provides specific options tailored to that data type: Numbers: Support for percentages, currencies, units, scaling, and custom formatting Dates/Timestamps: Localized and custom formatting patterns Booleans: Custom true/false display text Known types: Special formatting for Foundry-specific identifiers * * Log Safety: UNSAFE */ declare type PropertyValueFormattingRule = ({ type: "date"; } & PropertyDateFormattingRule) | ({ type: "number"; } & PropertyNumberFormattingRule) | ({ type: "boolean"; } & PropertyBooleanFormattingRule) | ({ type: "knownType"; } & PropertyKnownTypeFormattingRule) | ({ type: "timestamp"; } & PropertyTimestampFormattingRule); /** * A combination of a property identifier and the load level to apply to the property. You can select a reduced value for arrays and the main value for structs. If the provided load level cannot be applied to the property type, then it will be ignored. This selector is experimental and may not work in filters or sorts. * * Log Safety: UNSAFE */ declare interface PropertyWithLoadLevelSelector { propertyIdentifier: PropertyIdentifier_2; loadLevel: PropertyLoadLevel; } /** * Protocol to establish a connection with another system. * * Log Safety: SAFE */ declare type Protocol = "HTTP" | "HTTPS"; /** * A value that uniquely identifies a User or Group in an external authentication provider. This value is determined by the external authentication provider and must be unique per Realm. * * Log Safety: UNSAFE */ declare type ProviderId = LooselyBrandedString_3<"ProviderId">; /** * PTTML (Palantir Timed Text Markup Language) transcription output format. * * Log Safety: SAFE */ declare interface Pttml { } export declare namespace PublicApis { export { ApiDefinition, ApiDefinitionDeprecated, ApiDefinitionName, ApiDefinitionRid, ApiVersion, IrVersion, OpenApiDefinition, OpenApiDefinitionDeprecated, OpenApiDefinitionValue, ApiDefinitionNotFound, GetOpenApiDefinitionAsYamlPermissionDenied, OpenApiDefinitionNotFound, ApiDefinitions, OpenApiDefinitions } } declare namespace _PublicApis { export { LooselyBrandedString_20 as LooselyBrandedString, ApiDefinition, ApiDefinitionDeprecated, ApiDefinitionName, ApiDefinitionRid, ApiVersion, IrVersion, OpenApiDefinition, OpenApiDefinitionDeprecated, OpenApiDefinitionValue } } /* Excluded from this release type: publish */ /** * Publish a single binary record to the stream. The stream's schema must be a single binary field. * * @public * * Required Scopes: [api:streams-write] * URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord */ declare function publishBinaryRecord($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, streamBranchName: _Core.BranchName, $body: Blob, $queryParams?: { viewRid?: _Streams.ViewRid | undefined; } ]): Promise; /** * Could not publishBinaryRecord the Stream. * * Log Safety: UNSAFE */ declare interface PublishBinaryRecordToStreamPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PublishBinaryRecordToStreamPermissionDenied"; errorDescription: "Could not publishBinaryRecord the Stream."; errorInstanceId: string; parameters: { datasetRid: unknown; streamBranchName: unknown; }; } /** * Publish a single record to the stream. The record will be validated against the stream's schema, and * rejected if it is invalid. * * @public * * Required Scopes: [api:streams-write] * URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord */ declare function publishRecord($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, streamBranchName: _Core.BranchName, $body: _Streams.PublishRecordToStreamRequest ]): Promise; /** * Publish a batch of records to the stream. The records will be validated against the stream's schema, and * the batch will be rejected if one or more of the records are invalid. * * @public * * Required Scopes: [api:streams-write] * URL: /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords */ declare function publishRecords($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, streamBranchName: _Core.BranchName, $body: _Streams.PublishRecordsToStreamRequest ]): Promise; /** * Could not publishRecords the Stream. * * Log Safety: UNSAFE */ declare interface PublishRecordsToStreamPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PublishRecordsToStreamPermissionDenied"; errorDescription: "Could not publishRecords the Stream."; errorInstanceId: string; parameters: { datasetRid: unknown; streamBranchName: unknown; }; } /** * Log Safety: DO_NOT_LOG */ declare interface PublishRecordsToStreamRequest { records: Array<_Record_2>; viewRid?: ViewRid; } /** * Could not publishRecord the Stream. * * Log Safety: UNSAFE */ declare interface PublishRecordToStreamPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PublishRecordToStreamPermissionDenied"; errorDescription: "Could not publishRecord the Stream."; errorInstanceId: string; parameters: { datasetRid: unknown; streamBranchName: unknown; }; } /** * Log Safety: DO_NOT_LOG */ declare interface PublishRecordToStreamRequest { record: _Record_2; viewRid?: ViewRid; } /** * Could not publish the Repository. * * Log Safety: SAFE */ declare interface PublishReleasePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PublishReleasePermissionDenied"; errorDescription: "Could not publish the Repository."; errorInstanceId: string; parameters: { repositoryRid: unknown; }; } /** * Could not putSchema the Dataset. * * Log Safety: SAFE */ declare interface PutDatasetSchemaPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PutDatasetSchemaPermissionDenied"; errorDescription: "Could not putSchema the Dataset."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface PutDatasetSchemaRequest { branchName?: _Core.BranchName; dataframeReader?: DataframeReader; endTransactionRid?: TransactionRid; schema: _Core.DatasetSchema; } /** * Log Safety: SAFE */ declare interface PutMediaItemResponse { mediaItemRid: _Core.MediaItemRid; mediaSetViewRid: _Core.MediaSetViewRid; } /** * Adds a schema on an existing dataset using a PUT request. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/{datasetRid}/putSchema */ declare function putSchema($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, $body: _Datasets_2.PutDatasetSchemaRequest ]): Promise<_Datasets_2.GetDatasetSchemaResponse>; /** * todo * * Log Safety: UNSAFE */ declare interface PutSchemaPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "PutSchemaPermissionDenied"; errorDescription: "todo"; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; }; } /** * An error indicating that the subscribe request should be attempted on a different node. * * Log Safety: SAFE */ declare interface QosError { } /** * The representation of a time series property backed by multiple time series syncs. * * Log Safety: UNSAFE */ declare interface QualifiedTimeseriesProperty { seriesId: SeriesId; syncRid: TimeseriesSyncRid; } export declare namespace Queries { export { execute } } export declare namespace Queries_2 { export { } } /** * Log Safety: UNSAFE */ declare type Query = LooselyBrandedString_5<"Query">; /** * Log Safety: UNSAFE */ declare interface Query_2 { apiName: QueryApiName_2; description?: string; displayName?: _Core.DisplayName; parameters: Record; output: QueryDataType_2; rid: FunctionRid_2; version: FunctionVersion_2; typeReferences?: Record; } /** * Log Safety: UNSAFE */ declare interface QueryAggregation { key: any; value: any; } /** * A union of all the types supported by query aggregation keys. * * Log Safety: UNSAFE */ declare type QueryAggregationKeyType = ({ type: "date"; } & _Core.DateType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "string"; } & _Core.StringType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "range"; } & QueryAggregationRangeType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * A union of all the types supported by query aggregation keys. * * Log Safety: SAFE */ declare type QueryAggregationKeyType_2 = ({ type: "date"; } & _Core.DateType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "string"; } & _Core.StringType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "range"; } & QueryAggregationRangeType_2) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * Specifies a range from an inclusive start value to an exclusive end value. * * Log Safety: UNSAFE */ declare interface QueryAggregationRange { startValue?: any; endValue?: any; } /** * A union of all the types supported by query aggregation ranges. * * Log Safety: UNSAFE */ declare type QueryAggregationRangeSubType = ({ type: "date"; } & _Core.DateType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * A union of all the types supported by query aggregation ranges. * * Log Safety: SAFE */ declare type QueryAggregationRangeSubType_2 = ({ type: "date"; } & _Core.DateType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * Log Safety: UNSAFE */ declare interface QueryAggregationRangeType { subType: QueryAggregationRangeSubType; } /** * Log Safety: SAFE */ declare interface QueryAggregationRangeType_2 { subType: QueryAggregationRangeSubType_2; } /** * A union of all the types supported by query aggregation keys. * * Log Safety: UNSAFE */ declare type QueryAggregationValueType = ({ type: "date"; } & _Core.DateType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * A union of all the types supported by query aggregation keys. * * Log Safety: SAFE */ declare type QueryAggregationValueType_2 = ({ type: "date"; } & _Core.DateType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * The name of the Query in the API. * * Log Safety: UNSAFE */ declare type QueryApiName = LooselyBrandedString_5<"QueryApiName">; /** * The name of the Query in the API. * * Log Safety: UNSAFE */ declare type QueryApiName_2 = LooselyBrandedString_9<"QueryApiName">; /** * Log Safety: UNSAFE */ declare interface QueryArrayType { subType: QueryDataType; } /** * Log Safety: UNSAFE */ declare interface QueryArrayType_2 { subType: QueryDataType_2; } /** * The query was canceled. * * Log Safety: SAFE */ declare interface QueryCanceled { errorCode: "INVALID_ARGUMENT"; errorName: "QueryCanceled"; errorDescription: "The query was canceled."; errorInstanceId: string; parameters: {}; } /** * A union of all the types supported by Ontology Query parameters or outputs. * * Log Safety: UNSAFE */ declare type QueryDataType = ({ type: "date"; } & _Core.DateType) | ({ type: "interfaceObject"; } & OntologyInterfaceObjectType) | ({ type: "struct"; } & QueryStructType) | ({ type: "string"; } & _Core.StringType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "threeDimensionalAggregation"; } & ThreeDimensionalAggregation) | ({ type: "float"; } & _Core.FloatType) | ({ type: "long"; } & _Core.LongType) | ({ type: "unsupported"; } & _Core.UnsupportedType) | ({ type: "attachment"; } & _Core.AttachmentType) | ({ type: "array"; } & QueryArrayType) | ({ type: "objectSet"; } & OntologyObjectSetType) | ({ type: "twoDimensionalAggregation"; } & TwoDimensionalAggregation) | ({ type: "typeReference"; } & QueryTypeReferenceType) | ({ type: "timestamp"; } & _Core.TimestampType) | ({ type: "set"; } & QuerySetType) | ({ type: "void"; } & _Core.VoidType) | ({ type: "entrySet"; } & EntrySetType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "union"; } & QueryUnionType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "mediaReference"; } & _Core.MediaReferenceType) | ({ type: "null"; } & _Core.NullType) | ({ type: "interfaceObjectSet"; } & OntologyInterfaceObjectSetType) | ({ type: "object"; } & OntologyObjectType); /** * A union of all the types supported by Query parameters or outputs. * * Log Safety: UNSAFE */ declare type QueryDataType_2 = ({ type: "date"; } & _Core.DateType) | ({ type: "struct"; } & QueryStructType_2) | ({ type: "set"; } & QuerySetType_2) | ({ type: "void"; } & _Core.VoidType) | ({ type: "string"; } & _Core.StringType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "threeDimensionalAggregation"; } & ThreeDimensionalAggregation_2) | ({ type: "union"; } & QueryUnionType_2) | ({ type: "float"; } & _Core.FloatType) | ({ type: "long"; } & _Core.LongType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "unsupported"; } & _Core.UnsupportedType) | ({ type: "attachment"; } & _Core.AttachmentType) | ({ type: "mediaReference"; } & _Core.MediaReferenceType) | ({ type: "null"; } & _Core.NullType) | ({ type: "array"; } & QueryArrayType_2) | ({ type: "twoDimensionalAggregation"; } & TwoDimensionalAggregation_2) | ({ type: "valueTypeReference"; } & ValueTypeReference) | ({ type: "typeReference"; } & QueryTypeReferenceType_2) | ({ type: "timestamp"; } & _Core.TimestampType); /** * The authored Query failed to execute because of a user induced error. The message argument is meant to be displayed to the user. * * Log Safety: UNSAFE */ declare interface QueryEncounteredUserFacingError { errorCode: "CONFLICT"; errorName: "QueryEncounteredUserFacingError"; errorDescription: "The authored Query failed to execute because of a user induced error. The message argument is meant to be displayed to the user."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; }; } /** * The authored Query failed to execute because of a user induced error. The message argument is meant to be displayed to the user. * * Log Safety: UNSAFE */ declare interface QueryEncounteredUserFacingError_2 { errorCode: "CONFLICT"; errorName: "QueryEncounteredUserFacingError"; errorDescription: "The authored Query failed to execute because of a user induced error. The message argument is meant to be displayed to the user."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; }; } /** * The query failed. * * Log Safety: UNSAFE */ declare interface QueryFailed { errorCode: "INTERNAL"; errorName: "QueryFailed"; errorDescription: "The query failed."; errorInstanceId: string; parameters: { errorMessage: unknown; }; } /** * Memory limits were exceeded for the Query execution. * * Log Safety: UNSAFE */ declare interface QueryMemoryExceededLimit { errorCode: "TIMEOUT"; errorName: "QueryMemoryExceededLimit"; errorDescription: "Memory limits were exceeded for the Query execution."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * Memory limits were exceeded for the Query execution. * * Log Safety: UNSAFE */ declare interface QueryMemoryExceededLimit_2 { errorCode: "TIMEOUT"; errorName: "QueryMemoryExceededLimit"; errorDescription: "Memory limits were exceeded for the Query execution."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * The query is not found, or the user does not have access to it. * * Log Safety: UNSAFE */ declare interface QueryNotFound { errorCode: "NOT_FOUND"; errorName: "QueryNotFound"; errorDescription: "The query is not found, or the user does not have access to it."; errorInstanceId: string; parameters: { query: unknown; }; } /** * The given Query could not be found. * * Log Safety: UNSAFE */ declare interface QueryNotFound_2 { errorCode: "NOT_FOUND"; errorName: "QueryNotFound"; errorDescription: "The given Query could not be found."; errorInstanceId: string; parameters: { queryApiName: unknown; }; } /** * Details about the output of a query. * * Log Safety: UNSAFE */ declare interface QueryOutputV2 { dataType: QueryDataType; required: boolean; } /** * Log Safety: UNSAFE */ declare interface QueryParameterApiKey { queryParameterName: string; } /** * Details about a parameter of a query. * * Log Safety: UNSAFE */ declare interface QueryParameterV2 { description?: string; dataType: QueryDataType; required: boolean; } /** * The query cannot be parsed. * * Log Safety: UNSAFE */ declare interface QueryParseError { errorCode: "INVALID_ARGUMENT"; errorName: "QueryParseError"; errorDescription: "The query cannot be parsed."; errorInstanceId: string; parameters: { errorMessage: unknown; }; } /** * The provided token does not have permission to access the given query. * * Log Safety: SAFE */ declare interface QueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "QueryPermissionDenied"; errorDescription: "The provided token does not have permission to access the given query."; errorInstanceId: string; parameters: {}; } /** * The query is running. * * Log Safety: SAFE */ declare interface QueryRunning { errorCode: "INVALID_ARGUMENT"; errorName: "QueryRunning"; errorDescription: "The query is running."; errorInstanceId: string; parameters: {}; } /** * The authored Query failed to execute because of a runtime error. * * Log Safety: UNSAFE */ declare interface QueryRuntimeError { errorCode: "INVALID_ARGUMENT"; errorName: "QueryRuntimeError"; errorDescription: "The authored Query failed to execute because of a runtime error."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; stacktrace: unknown; parameters: unknown; }; } /** * The authored Query failed to execute because of a runtime error. * * Log Safety: UNSAFE */ declare interface QueryRuntimeError_2 { errorCode: "INVALID_ARGUMENT"; errorName: "QueryRuntimeError"; errorDescription: "The authored Query failed to execute because of a runtime error."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; message: unknown; stacktrace: unknown; parameters: unknown; }; } /** * Log Safety: UNSAFE */ declare type QueryRuntimeErrorParameter = LooselyBrandedString_5<"QueryRuntimeErrorParameter">; /** * Log Safety: UNSAFE */ declare type QueryRuntimeErrorParameter_2 = LooselyBrandedString_9<"QueryRuntimeErrorParameter">; /** * Log Safety: UNSAFE */ declare interface QuerySetType { subType: QueryDataType; } /** * Log Safety: UNSAFE */ declare interface QuerySetType_2 { subType: QueryDataType_2; } /** * Log Safety: DO_NOT_LOG */ declare type QueryStatus = ({ type: "running"; } & RunningQueryStatus) | ({ type: "canceled"; } & CanceledQueryStatus) | ({ type: "failed"; } & FailedQueryStatus) | ({ type: "succeeded"; } & SucceededQueryStatus); /** * Log Safety: UNSAFE */ declare interface QueryStructField { name: _Core.StructFieldName; fieldType: QueryDataType; } /** * Log Safety: UNSAFE */ declare interface QueryStructField_2 { name: StructFieldName_2; fieldType: QueryDataType_2; } /** * Log Safety: UNSAFE */ declare interface QueryStructType { fields: Array; } /** * Log Safety: UNSAFE */ declare interface QueryStructType_2 { fields: Array; } /** * Log Safety: UNSAFE */ declare interface QueryThreeDimensionalAggregation { groups: Array; } /** * Time limits were exceeded for the Query execution. * * Log Safety: UNSAFE */ declare interface QueryTimeExceededLimit { errorCode: "INVALID_ARGUMENT"; errorName: "QueryTimeExceededLimit"; errorDescription: "Time limits were exceeded for the Query execution."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * Time limits were exceeded for the Query execution. * * Log Safety: UNSAFE */ declare interface QueryTimeExceededLimit_2 { errorCode: "INVALID_ARGUMENT"; errorName: "QueryTimeExceededLimit"; errorDescription: "Time limits were exceeded for the Query execution."; errorInstanceId: string; parameters: { functionRid: unknown; functionVersion: unknown; }; } /** * Log Safety: UNSAFE */ declare interface QueryTwoDimensionalAggregation { groups: Array; } /** * Represents a query type in the Ontology. * * Log Safety: UNSAFE */ declare interface QueryType { apiName: QueryApiName; description?: string; displayName?: _Core.DisplayName; parameters: Record; output?: OntologyDataType; rid: FunctionRid; version: FunctionVersion; } /** * A reference to a type that is defined in the typeReferences map of the enclosing Query. This enables support for recursive type definitions where a type may reference itself. * * Log Safety: SAFE */ declare interface QueryTypeReferenceType { typeId: TypeReferenceIdentifier; } /** * A reference to a type that is defined in the typeReferences map of the enclosing Query. This enables support for recursive type definitions where a type may reference itself. * * Log Safety: SAFE */ declare interface QueryTypeReferenceType_2 { typeId: TypeReferenceIdentifier_2; } export declare namespace QueryTypes { export { list_27 as list, get_34 as get } } /** * Represents a query type in the Ontology. * * Log Safety: UNSAFE */ declare interface QueryTypeV2 { apiName: QueryApiName; description?: string; displayName?: _Core.DisplayName; parameters: Record; output: QueryDataType; rid: FunctionRid; version: FunctionVersion; typeReferences: Record; } /** * Log Safety: UNSAFE */ declare interface QueryUnionType { unionTypes: Array; } /** * Log Safety: UNSAFE */ declare interface QueryUnionType_2 { unionTypes: Array; } /** * The query could not be found at the provided version. * * Log Safety: UNSAFE */ declare interface QueryVersionNotFound { errorCode: "NOT_FOUND"; errorName: "QueryVersionNotFound"; errorDescription: "The query could not be found at the provided version."; errorInstanceId: string; parameters: { apiName: unknown; version: unknown; }; } /** * The query could not be found at the provided version. * * Log Safety: UNSAFE */ declare interface QueryVersionNotFound_2 { errorCode: "NOT_FOUND"; errorName: "QueryVersionNotFound"; errorDescription: "The query could not be found at the provided version."; errorInstanceId: string; parameters: { apiName: unknown; version: unknown; }; } /* Excluded from this release type: ragContext */ /** * The parameter value must fall within the specified numeric range. * * Log Safety: UNSAFE */ declare interface RangeAllowedValues { gt?: ParameterConstraintValue; gte?: ParameterConstraintValue; lt?: ParameterConstraintValue; lte?: ParameterConstraintValue; } /** * The parameter value must be within the defined range. * * Log Safety: UNSAFE */ declare interface RangeConstraint { lt?: any; lte?: any; gt?: any; gte?: any; } /** * Log Safety: UNSAFE */ declare interface RangesConstraint { minimumValue?: PropertyValue_2; maximumValue?: PropertyValue_2; } /** * Log Safety: SAFE */ declare interface RangesConstraint_2 { minimumValue?: any; maximumValue?: any; } /** * Failed to generate a response as the model rate limits were exceeded. Clients should wait and retry. * * Log Safety: UNSAFE */ declare interface RateLimitExceeded { errorCode: "CUSTOM_CLIENT"; errorName: "RateLimitExceeded"; errorDescription: "Failed to generate a response as the model rate limits were exceeded. Clients should wait and retry."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached. * * Log Safety: SAFE */ declare interface RateLimitReached { errorCode: "PERMISSION_DENIED"; errorName: "RateLimitReached"; errorDescription: "Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached."; errorInstanceId: string; parameters: { cipherChannel: unknown; }; } /** * Get the content of an attachment. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/attachments/{attachmentRid}/content */ declare function read($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [attachmentRid: _Ontologies_2.AttachmentRid]): Promise; /** * Gets the content of a media item. * * @public * * Required Scopes: [api:mediasets-read] * URL: /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/content */ declare function read_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ mediaSetRid: _Core.MediaSetRid, mediaItemRid: _Core.MediaItemRid, $headerParams?: { ReadToken?: _Core.MediaItemReadToken | undefined; } ]): Promise; /** * Get the content of an attachment. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content */ declare function readAttachment($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, property: _Ontologies_2.PropertyApiName, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise; /** * Get the content of an attachment by its RID. * * The RID must exist in the attachment array of the property. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content */ declare function readAttachmentByRid($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, property: _Ontologies_2.PropertyApiName, attachmentRid: _Ontologies_2.AttachmentRid, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise; /** * Gets the content of an original file uploaded to the media item, even if it was transformed on upload due to being an additional input format. * * @public * * Required Scopes: [api:mediasets-read] * URL: /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/original */ declare function readOriginal($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ mediaSetRid: _Core.MediaSetRid, mediaItemRid: _Core.MediaItemRid, $headerParams?: { ReadToken?: _Core.MediaItemReadToken | undefined; } ]): Promise; /** * Position to start reading from when registering a subscriber or resetting offsets. earliest: Start reading from the beginning of each partition (offset 0). Use this to reprocess all historical data in the stream. latest: Start reading from the current end of each partition. Use this to skip historical data and only process new records arriving after registration. specific: Start reading from explicit offsets for each partition. Use this for precise replay scenarios or to resume from a known checkpoint. * * Log Safety: SAFE */ declare type ReadPosition = ({ type: "specific"; } & SpecificPosition) | ({ type: "earliest"; } & EarliestPosition) | ({ type: "latest"; } & LatestPosition); /** * The provided token does not have permission to access the inputs to the query. * * Log Safety: SAFE */ declare interface ReadQueryInputsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReadQueryInputsPermissionDenied"; errorDescription: "The provided token does not have permission to access the inputs to the query."; errorInstanceId: string; parameters: { rids: unknown; }; } /* Excluded from this release type: readRecords */ /** * Could not readRecords the Subscriber. * * Log Safety: UNSAFE */ declare interface ReadRecordsFromSubscriberPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReadRecordsFromSubscriberPermissionDenied"; errorDescription: "Could not readRecords the Subscriber."; errorInstanceId: string; parameters: { datasetRid: unknown; subscriberSubscriberId: unknown; streamBranchName: unknown; }; } /** * Log Safety: SAFE */ declare interface ReadRecordsFromSubscriberRequest { viewRid?: ViewRid; limit?: number; partitionIds?: Array; autoCommit?: boolean; } /** * Response containing records grouped by partition ID. * * Log Safety: DO_NOT_LOG */ declare interface ReadSubscriberRecordsResponse { recordsByPartition: Record; } /** * Gets the content of a dataset as a table in the specified format. * * This endpoint currently does not support views (virtual datasets composed of other datasets). * * @public * * Required Scopes: [api:datasets-read] * URL: /v2/datasets/{datasetRid}/readTable */ declare function readTable($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, $queryParams: { branchName?: _Core.BranchName | undefined; startTransactionRid?: _Datasets_2.TransactionRid | undefined; endTransactionRid?: _Datasets_2.TransactionRid | undefined; format: _Datasets_2.TableExportFormat; columns: Array; rowLimit?: number | undefined; } ]): Promise; /** * The provided token does not have permission to read the given dataset as a table. * * Log Safety: SAFE */ declare interface ReadTableDatasetPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReadTableDatasetPermissionDenied"; errorDescription: "The provided token does not have permission to read the given dataset as a table."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * An error occurred while reading the table. Refer to the message for more details. * * Log Safety: UNSAFE */ declare interface ReadTableError { errorCode: "INTERNAL"; errorName: "ReadTableError"; errorDescription: "An error occurred while reading the table. Refer to the message for more details."; errorInstanceId: string; parameters: { datasetRid: unknown; message: unknown; }; } /** * The request to read the table generates a result that exceeds the allowed number of rows. For datasets not stored as Parquet there is a limit of 1 million rows. For datasets stored as Parquet there is no limit. * * Log Safety: SAFE */ declare interface ReadTableRowLimitExceeded { errorCode: "INVALID_ARGUMENT"; errorName: "ReadTableRowLimitExceeded"; errorDescription: "The request to read the table generates a result that exceeds the allowed number of rows. For datasets not stored as Parquet there is a limit of 1 million rows. For datasets stored as Parquet there is no limit."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * The request to read the table timed out. * * Log Safety: SAFE */ declare interface ReadTableTimeout { errorCode: "TIMEOUT"; errorName: "ReadTableTimeout"; errorDescription: "The request to read the table timed out."; errorInstanceId: string; parameters: { datasetRid: unknown; }; } /** * Identifies which Realm a User or Group is a member of. The palantir-internal-realm is used for Users or Groups that are created in Foundry by administrators and not associated with any SSO provider. * * Log Safety: SAFE */ declare type Realm = LooselyBrandedString<"Realm">; /** * Log Safety: SAFE */ declare interface Reason { reason: ReasonType; } /** * Represents the reason a subscription was closed. * * Log Safety: SAFE */ declare type ReasonType = "USER_CLOSED" | "CHANNEL_CLOSED"; /** * Checkpoint justification that requires the user to reauthenticate with the platform. * * Log Safety: UNSAFE */ declare interface ReauthenticationJustification { reauthenticationId: string; prompt: string; description?: string; title: string; } /** * The maximum number of recently viewed resources to return. Validation rules: must be greater than or equal to 1 * * Log Safety: SAFE */ declare type RecentlyViewedLimit = number; /** * RecentlyViewedLimit must be greater than or equal to 1 * * Log Safety: SAFE */ declare interface RecentlyViewedLimitBelowMinimum { errorCode: "INVALID_ARGUMENT"; errorName: "RecentlyViewedLimitBelowMinimum"; errorDescription: "RecentlyViewedLimit must be greater than or equal to 1"; errorInstanceId: string; parameters: { value: unknown; minInclusive: unknown; }; } /** * A resource that was recently viewed by the calling user, along with when it was last viewed. * * Log Safety: UNSAFE */ declare interface RecentlyViewedResource { resource: Resource; lastViewed: string; } /** * Log Safety: UNSAFE */ declare interface _Record { rid: RecordRid; configRid?: ConfigRid; type: CheckpointType; scope: Scope; actingUser: ActingUser; delegateUserId?: _Core.UserId; createdAt: RecordCreatedAt; checkpointedItems: Array; justification: Justification; projectRid?: ProjectRid_2; organizationRid?: OrganizationRid_2; namespaceRid?: NamespaceRid; interactionRid?: InteractionRid; approvalsMetadata?: ApprovalsMetadata; } /** * A record to be published to a stream. * * Log Safety: DO_NOT_LOG */ declare type _Record_2 = Record; /** * The time at which the checkpoint record was created. * * Log Safety: SAFE */ declare type RecordCreatedAt = string; /** * A record model definition with named fields. * * Log Safety: UNSAFE */ declare interface RecordDef { key: ModelTypeKey; name: string; description?: string; fields: Array; } /** * A provided record does not match the stream schema * * Log Safety: UNSAFE */ declare interface RecordDoesNotMatchStreamSchema { errorCode: "INVALID_ARGUMENT"; errorName: "RecordDoesNotMatchStreamSchema"; errorDescription: "A provided record does not match the stream schema"; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; viewRid: unknown; }; } /** * The given Record could not be found. * * Log Safety: SAFE */ declare interface RecordNotFound { errorCode: "NOT_FOUND"; errorName: "RecordNotFound"; errorDescription: "The given Record could not be found."; errorInstanceId: string; parameters: { recordRid: unknown; }; } /** * Identifier of a checkpoint record. * * Log Safety: SAFE */ declare type RecordRid = LooselyBrandedString_11<"RecordRid">; export declare namespace Records { export { } } /** * A record is too large to be published to the stream. On most enrollments, the maximum record size is 1MB. * * Log Safety: SAFE */ declare interface RecordTooLarge { errorCode: "REQUEST_ENTITY_TOO_LARGE"; errorName: "RecordTooLarge"; errorDescription: "A record is too large to be published to the stream. On most enrollments, the maximum record size is 1MB."; errorInstanceId: string; parameters: {}; } /** * A record retrieved from a stream, including its offset within the partition. * * Log Safety: DO_NOT_LOG */ declare interface RecordWithOffset { offset: string; value: _Record_2; } /** * A string value that may be redacted for privacy reasons. * * Log Safety: UNSAFE */ declare interface RedactableString { value?: string; redactionType?: RedactionType; } /** * Indicates why a string value was redacted. * * Log Safety: SAFE */ declare type RedactionType = "USER_REDACTED" | "RESOURCE_REDACTED"; /** * A union of the types supported by media reference properties. * * Log Safety: UNSAFE */ declare type Reference = { type: "mediaSetViewItem"; } & MediaSetViewItemWrapper; /* Excluded from this release type: reference */ /** * Options for signing references in the response. * * Log Safety: SAFE */ declare interface ReferenceSigningOptions { signMediaReferences?: boolean; } /** * The updated data value associated with an object instance's external reference. The object instance is uniquely identified by an object type and a primary key. Note that the value of the property field returns a dereferenced value rather than the reference itself. * * Log Safety: UNSAFE */ declare interface ReferenceUpdate { objectType: ObjectTypeApiName; primaryKey: ObjectPrimaryKey; property: PropertyApiName_2; value: ReferenceValue; } /** * Resolved data values pointed to by a reference. * * Log Safety: UNSAFE */ declare type ReferenceValue = { type: "geotimeSeriesValue"; } & GeotimeSeriesValue; /** * Indicates that the link types cannot be incrementally updated and must be refreshed. * * Log Safety: UNSAFE */ declare interface RefreshLinks { id: SubscriptionId; linkTypes: LinkTypeApiNames; } /** * The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service. * * Log Safety: UNSAFE */ declare interface RefreshObjectSet { id: SubscriptionId; objectType: ObjectTypeApiName; } /** * Log Safety: UNSAFE */ declare interface RegexConstraint { pattern: string; partialMatch: boolean; } /** * Log Safety: UNSAFE */ declare interface RegexConstraint_2 { pattern: string; partialMatch: boolean; } /** * Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed form of text fields. Supported operators: . matches any character. ? repeats the previous character 0 or 1 times. + repeats the previous character 1 or more times. * repeats the previous character 0 or more times. {} defines the minimum and maximum number of times the preceding character can repeat. {2} means the previous character must repeat only twice, {2,} means the previous character must repeat at least twice, and {2,4} means the previous character must repeat between 2-4 times. | is the OR operator. () forms a group within an expression such that the group can be treated as a single character. [] matches a single one of the characters contained inside the brackets, meaning [abc] matches a, b or c. Unless - is the first character or escaped with \ (in which case it is treated as a normal character), - can be used inside the bracket to create a range of characters, meaning [a-c] matches a, b, or c. If the character sequence inside the brackets begins with ^, the set of characters is negated, meaning [^abc] does not match a, b, or c. Otherwise, ^ is treated as a normal character. " creates groups of string literals. \ is used as an escape character. However, \d and \D match digit and non-digit characters respectively, \s and \S match whitespace and non whitespace characters respectively, and \w and \W match word and non word characters respectively. Either field or propertyIdentifier can be supplied, but not both. * * Log Safety: UNSAFE */ declare interface RegexQuery { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: string; } /** * The region of the external system. * * Log Safety: UNSAFE */ declare type Region = LooselyBrandedString_12<"Region">; /* Excluded from this release type: register */ /** * Request to register a media item from a federated store. * * Log Safety: UNSAFE */ declare interface RegisterMediaItemRequest { physicalItemName: string; mediaItemPath?: _Core.MediaItemPath; } /** * Response after successfully registering a media item. * * Log Safety: SAFE */ declare interface RegisterMediaItemResponse { mediaItemRid: _Core.MediaItemRid; mediaType: _Core.MediaType; } /** * Specifies a bound for a relative date range query. * * Log Safety: UNSAFE */ declare type RelativeDateRangeBound = { type: "relativePoint"; } & RelativePointInTime; /** * Returns objects where the specified date or timestamp property falls within a relative date range. The bounds are calculated relative to query execution time and rounded to midnight in the specified timezone. * * Log Safety: UNSAFE */ declare interface RelativeDateRangeQuery { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; relativeStartTime?: RelativeDateRangeBound; relativeEndTime?: RelativeDateRangeBound; timeZoneId: string; } /** * The magnitude of a relative datetime offset. * * Log Safety: SAFE */ declare type RelativeDatetimeDuration = string; /** * Direction of a relative datetime offset. * * Log Safety: SAFE */ declare type RelativeDatetimeTense = "FUTURE" | "PAST"; /** * Time unit for relative datetime offsets. * * Log Safety: SAFE */ declare type RelativeDatetimeUnit = "SECOND" | "MINUTE" | "HOUR" | "DAY" | "WEEK"; /** * A datetime expressed as an offset from the current time. * * Log Safety: SAFE */ declare interface RelativeDatetimeValue { duration: RelativeDatetimeDuration; unit: RelativeDatetimeUnit; tense: RelativeDatetimeTense; } /** * A point in time specified relative to query execution time. * * Log Safety: UNSAFE */ declare interface RelativePointInTime { value: number; timeUnit: RelativeTimeUnit; } /** * A relative time, such as "3 days before" or "2 hours after" the current moment. * * Log Safety: UNSAFE */ declare interface RelativeTime { when: RelativeTimeRelation; value: number; unit: RelativeTimeSeriesTimeUnit; } /** * A relative time range for a time series query. * * Log Safety: UNSAFE */ declare interface RelativeTimeRange { startTime?: RelativeTime; endTime?: RelativeTime; } /** * Log Safety: SAFE */ declare type RelativeTimeRelation = "BEFORE" | "AFTER"; /** * Log Safety: SAFE */ declare type RelativeTimeSeriesTimeUnit = "MILLISECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS"; /** * Units for relative time calculations. * * Log Safety: SAFE */ declare type RelativeTimeUnit = "DAY" | "WEEK" | "MONTH" | "YEAR"; /** * Log Safety: UNSAFE */ declare interface Release { widgetSetRid: WidgetSetRid; version: ReleaseVersion; locator: ReleaseLocator; description?: string; } /** * A locator for where the backing files of a release are stored. * * Log Safety: UNSAFE */ declare interface ReleaseLocator { repositoryRid: RepositoryRid; repositoryVersion: RepositoryVersion; } /** * The given Release could not be found. * * Log Safety: UNSAFE */ declare interface ReleaseNotFound { errorCode: "NOT_FOUND"; errorName: "ReleaseNotFound"; errorDescription: "The given Release could not be found."; errorInstanceId: string; parameters: { widgetSetRid: unknown; releaseVersion: unknown; }; } export declare namespace Releases { export { } } /** * The release status of the entity. * * Log Safety: SAFE */ declare type ReleaseStatus = "ACTIVE" | "ENDORSED" | "EXPERIMENTAL" | "DEPRECATED"; /** * The semantic version of the widget set. * * Log Safety: UNSAFE */ declare type ReleaseVersion = LooselyBrandedString_24<"ReleaseVersion">; /* Excluded from this release type: remove */ /** * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/groups/{groupId}/groupMembers/remove */ declare function remove_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [groupId: _Core.GroupId, $body: _Admin.RemoveGroupMembersRequest]): Promise; /** * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/markings/{markingId}/markingMembers/remove */ declare function remove_3($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ markingId: _Core.MarkingId, $body: _Admin.RemoveMarkingMembersRequest ]): Promise; /** * Removes role assignments for the given Marking. For Organization markings, only the USE and DECLASSIFY * roles are supported; the ADMINISTER role must be managed via the Organization Role Assignment endpoints. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/markings/{markingId}/roleAssignments/remove */ declare function remove_4($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ markingId: _Core.MarkingId, $body: _Admin.RemoveMarkingRoleAssignmentsRequest ]): Promise; /* Excluded from this release type: remove_5 */ /** * Remove roles from principals for the given Organization. At most 100 role assignments can be removed in a single request. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/organizations/{organizationRid}/roleAssignments/remove */ declare function remove_6($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ organizationRid: _Core.OrganizationRid, $body: _Admin.RemoveOrganizationRoleAssignmentsRequest ]): Promise; /** * Remove references from the given project * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/projects/{projectRid}/references/remove */ declare function remove_7($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ projectRid: _Filesystem_2.ProjectRid, $body: _Filesystem_2.RemoveProjectResourceReferencesRequest ]): Promise; /** * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/resources/{resourceRid}/roles/remove */ declare function remove_8($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ resourceRid: _Filesystem_2.ResourceRid, $body: _Filesystem_2.RemoveResourceRolesRequest ]): Promise; /* Excluded from this release type: remove_9 */ /** * Removes specified backing datasets from a View. Removing a dataset triggers a * [SNAPSHOT](https://www.palantir.com/docs/foundry/data-integration/datasets#snapshot) transaction on the next update. If a * specified dataset does not exist, no error is thrown. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/views/{viewDatasetRid}/removeBackingDatasets */ declare function removeBackingDatasets($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ viewDatasetRid: _Core.DatasetRid, $body: _Datasets_2.RemoveBackingDatasetsRequest ]): Promise<_Datasets_2.View>; /** * Could not removeBackingDatasets the View. * * Log Safety: SAFE */ declare interface RemoveBackingDatasetsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveBackingDatasetsPermissionDenied"; errorDescription: "Could not removeBackingDatasets the View."; errorInstanceId: string; parameters: { viewDatasetRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface RemoveBackingDatasetsRequest { branch?: _Core.BranchName; backingDatasets: Array; } /** * Could not remove the EnrollmentRoleAssignment. * * Log Safety: SAFE */ declare interface RemoveEnrollmentRoleAssignmentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveEnrollmentRoleAssignmentsPermissionDenied"; errorDescription: "Could not remove the EnrollmentRoleAssignment."; errorInstanceId: string; parameters: { enrollmentRid: unknown; }; } /** * Log Safety: SAFE */ declare interface RemoveEnrollmentRoleAssignmentsRequest { roleAssignments: Array<_Core.RoleAssignmentUpdate>; } /** * Could not remove the GroupMember. * * Log Safety: SAFE */ declare interface RemoveGroupMembersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveGroupMembersPermissionDenied"; errorDescription: "Could not remove the GroupMember."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * Log Safety: SAFE */ declare interface RemoveGroupMembersRequest { principalIds: Array<_Core.PrincipalId>; } /** * Could not remove the MarkingMember. * * Log Safety: UNSAFE */ declare interface RemoveMarkingMembersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveMarkingMembersPermissionDenied"; errorDescription: "Could not remove the MarkingMember."; errorInstanceId: string; parameters: { markingId: unknown; }; } /** * Log Safety: SAFE */ declare interface RemoveMarkingMembersRequest { principalIds: Array<_Core.PrincipalId>; } /** * Could not remove the MarkingRoleAssignment. * * Log Safety: UNSAFE */ declare interface RemoveMarkingRoleAssignmentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveMarkingRoleAssignmentsPermissionDenied"; errorDescription: "Could not remove the MarkingRoleAssignment."; errorInstanceId: string; parameters: { markingId: unknown; }; } /** * You cannot remove all administrators from a marking. * * Log Safety: UNSAFE */ declare interface RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed { errorCode: "INVALID_ARGUMENT"; errorName: "RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed"; errorDescription: "You cannot remove all administrators from a marking."; errorInstanceId: string; parameters: { markingId: unknown; currentAdministrators: unknown; }; } /** * Log Safety: SAFE */ declare interface RemoveMarkingRoleAssignmentsRequest { roleAssignments: Array; } /** * Removes Markings from a resource. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/resources/{resourceRid}/removeMarkings */ declare function removeMarkings($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ resourceRid: _Filesystem_2.ResourceRid, $body: _Filesystem_2.RemoveMarkingsRequest ]): Promise; /** * Could not removeMarkings the Resource. * * Log Safety: UNSAFE */ declare interface RemoveMarkingsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveMarkingsPermissionDenied"; errorDescription: "Could not removeMarkings the Resource."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface RemoveMarkingsRequest { markingIds: Array<_Core.MarkingId>; } /** * Could not remove the OrganizationGuestMember. * * Log Safety: SAFE */ declare interface RemoveOrganizationGuestMembersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveOrganizationGuestMembersPermissionDenied"; errorDescription: "Could not remove the OrganizationGuestMember."; errorInstanceId: string; parameters: { organizationRid: unknown; }; } /** * Log Safety: SAFE */ declare interface RemoveOrganizationGuestMembersRequest { principalIds: Array<_Core.PrincipalId>; } /** * Could not remove the OrganizationRoleAssignment. * * Log Safety: SAFE */ declare interface RemoveOrganizationRoleAssignmentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveOrganizationRoleAssignmentsPermissionDenied"; errorDescription: "Could not remove the OrganizationRoleAssignment."; errorInstanceId: string; parameters: { organizationRid: unknown; }; } /** * Log Safety: SAFE */ declare interface RemoveOrganizationRoleAssignmentsRequest { roleAssignments: Array<_Core.RoleAssignmentUpdate>; } /** * Removes Organizations from a Project. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/projects/{projectRid}/removeOrganizations */ declare function removeOrganizations($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ projectRid: _Filesystem_2.ProjectRid, $body: _Filesystem_2.RemoveOrganizationsRequest ]): Promise; /** * Could not removeOrganizations the Project. * * Log Safety: SAFE */ declare interface RemoveOrganizationsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveOrganizationsPermissionDenied"; errorDescription: "Could not removeOrganizations the Project."; errorInstanceId: string; parameters: { projectRid: unknown; }; } /** * Log Safety: SAFE */ declare interface RemoveOrganizationsRequest { organizationRids: Array<_Core.OrganizationRid>; } /** * Could not remove the ProjectResourceReference. * * Log Safety: SAFE */ declare interface RemoveProjectResourceReferencesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveProjectResourceReferencesPermissionDenied"; errorDescription: "Could not remove the ProjectResourceReference."; errorInstanceId: string; parameters: { projectRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface RemoveProjectResourceReferencesRequest { resources: Array; } /** * Could not remove the ResourceRole. * * Log Safety: UNSAFE */ declare interface RemoveResourceRolesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveResourceRolesPermissionDenied"; errorDescription: "Could not remove the ResourceRole."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Log Safety: SAFE */ declare interface RemoveResourceRolesRequest { roles: Array; } /** * Could not remove the ResourceTag. * * Log Safety: UNSAFE */ declare interface RemoveResourceTagsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RemoveResourceTagsPermissionDenied"; errorDescription: "Could not remove the ResourceTag."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Log Safety: SAFE */ declare interface RemoveResourceTagsRequest { tagRids: Array; } /** * Renders a frame of a DICOM file as an image. If only one dimension is specified, the other is calculated to preserve aspect ratio. * * Log Safety: SAFE */ declare interface RenderImageLayerOperation { layerNumber?: number; height?: number; width?: number; } /** * Renders a PDF page as an image. If only one dimension is specified, the other is calculated to preserve aspect ratio. * * Log Safety: SAFE */ declare interface RenderPageOperation { pageNumber?: number; height?: number; width?: number; } /** * Renders a PDF page to maximally fit within a bounding box while preserving aspect ratio. * * Log Safety: SAFE */ declare interface RenderPageToFitBoundingBoxOperation { pageNumber?: number; width: number; height: number; } /** * When replacing groups, you must send all attributes that begin with `multipass:` exactly as they appear when calling the Get Group endpoint. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/groups/{groupId} */ declare function replace($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [groupId: _Core.GroupId, $body: _Admin.ReplaceGroupRequest]): Promise<_Admin.Group>; /* Excluded from this release type: replace_10 */ /* Excluded from this release type: replace_11 */ /** * Replace the FileImport with the specified rid. * * @public * * Required Scopes: [api:connectivity-file-import-write] * URL: /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} */ declare function replace_12($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, fileImportRid: _Connectivity.FileImportRid, $body: _Connectivity.ReplaceFileImportRequest ]): Promise<_Connectivity.FileImport>; /** * Replace the TableImport with the specified rid. * * @public * * Required Scopes: [api:connectivity-table-import-write] * URL: /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid} */ declare function replace_13($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, tableImportRid: _Connectivity.TableImportRid, $body: _Connectivity.ReplaceTableImportRequest ]): Promise<_Connectivity.TableImport>; /* Excluded from this release type: replace_14 */ /* Excluded from this release type: replace_15 */ /* Excluded from this release type: replace_16 */ /* Excluded from this release type: replace_2 */ /** * Replace the GroupProviderInfo. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/groups/{groupId}/providerInfo */ declare function replace_3($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ groupId: _Core.GroupId, $body: _Admin.ReplaceGroupProviderInfoRequest ]): Promise<_Admin.GroupProviderInfo>; /** * Replace the Marking with the specified id. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/markings/{markingId} */ declare function replace_4($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [markingId: _Core.MarkingId, $body: _Admin.ReplaceMarkingRequest]): Promise<_Admin.Marking>; /* Excluded from this release type: replace_5 */ /** * Replace the Organization with the specified rid. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/organizations/{organizationRid} */ declare function replace_6($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ organizationRid: _Core.OrganizationRid, $body: _Admin.ReplaceOrganizationRequest ]): Promise<_Admin.Organization>; /** * Replace the UserProviderInfo. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/users/{userId}/providerInfo */ declare function replace_7($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [userId: _Core.UserId, $body: _Admin.ReplaceUserProviderInfoRequest]): Promise<_Admin.UserProviderInfo>; /* Excluded from this release type: replace_8 */ /* Excluded from this release type: replace_9 */ /** * Log Safety: UNSAFE */ declare interface ReplaceAllowedColumnValuesCheckConfig { allowedValues: Array; severity: SeverityLevel; allowNull?: boolean; } /** * Log Safety: SAFE */ declare interface ReplaceApproximateUniquePercentageCheckConfig { percentageCheckConfig: ReplacePercentageCheckConfig; } /** * Replaces the backing datasets for a View. Removing any backing dataset triggers a * [SNAPSHOT](https://www.palantir.com/docs/foundry/data-integration/datasets#snapshot) transaction the next time the View is updated. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/views/{viewDatasetRid}/replaceBackingDatasets */ declare function replaceBackingDatasets($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ viewDatasetRid: _Core.DatasetRid, $body: _Datasets_2.ReplaceBackingDatasetsRequest ]): Promise<_Datasets_2.View>; /** * Could not replaceBackingDatasets the View. * * Log Safety: SAFE */ declare interface ReplaceBackingDatasetsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceBackingDatasetsPermissionDenied"; errorDescription: "Could not replaceBackingDatasets the View."; errorInstanceId: string; parameters: { viewDatasetRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceBackingDatasetsRequest { branch?: _Core.BranchName; backingDatasets: Array; } /** * Log Safety: SAFE */ declare interface ReplaceBuildDurationCheckConfig { timeCheckConfig: TimeCheckConfig; } /** * Log Safety: UNSAFE */ declare interface ReplaceBuildStatusCheckConfig { statusCheckConfig: StatusCheckConfig; } /** * Configuration of a check. * * Log Safety: UNSAFE */ declare type ReplaceCheckConfig = ({ type: "numericColumnRange"; } & ReplaceNumericColumnRangeCheckConfig) | ({ type: "jobStatus"; } & ReplaceJobStatusCheckConfig) | ({ type: "numericColumnMean"; } & ReplaceNumericColumnMeanCheckConfig) | ({ type: "dateColumnRange"; } & ReplaceDateColumnRangeCheckConfig) | ({ type: "jobDuration"; } & ReplaceJobDurationCheckConfig) | ({ type: "approximateUniquePercentage"; } & ReplaceApproximateUniquePercentageCheckConfig) | ({ type: "buildStatus"; } & ReplaceBuildStatusCheckConfig) | ({ type: "columnType"; } & ReplaceColumnTypeCheckConfig) | ({ type: "allowedColumnValues"; } & ReplaceAllowedColumnValuesCheckConfig) | ({ type: "timeSinceLastUpdated"; } & ReplaceTimeSinceLastUpdatedCheckConfig) | ({ type: "scheduleStatus"; } & ReplaceScheduleStatusCheckConfig) | ({ type: "nullPercentage"; } & ReplaceNullPercentageCheckConfig) | ({ type: "scheduleDuration"; } & ReplaceScheduleDurationCheckConfig) | ({ type: "totalColumnCount"; } & ReplaceTotalColumnCountCheckConfig) | ({ type: "numericColumnMedian"; } & ReplaceNumericColumnMedianCheckConfig) | ({ type: "buildDuration"; } & ReplaceBuildDurationCheckConfig) | ({ type: "schemaComparison"; } & ReplaceSchemaComparisonCheckConfig) | ({ type: "primaryKey"; } & ReplacePrimaryKeyCheckConfig); /** * Could not replace the Check. * * Log Safety: SAFE */ declare interface ReplaceCheckPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceCheckPermissionDenied"; errorDescription: "Could not replace the Check."; errorInstanceId: string; parameters: { checkRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceCheckRequest { config: ReplaceCheckConfig; intent?: CheckIntent; } /** * Log Safety: SAFE */ declare interface ReplaceColumnTypeCheckConfig { columnTypeConfig: ReplaceColumnTypeConfig; } /** * Log Safety: SAFE */ declare interface ReplaceColumnTypeConfig { severity: SeverityLevel; expectedType?: _Core.SchemaFieldType; } /** * Log Safety: SAFE */ declare interface ReplaceDateColumnRangeCheckConfig { dateBoundsConfig: DateBoundsConfig; } /** * Could not replace the FileImport. * * Log Safety: SAFE */ declare interface ReplaceFileImportPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceFileImportPermissionDenied"; errorDescription: "Could not replace the FileImport."; errorInstanceId: string; parameters: { fileImportRid: unknown; connectionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceFileImportRequest { importMode: FileImportMode; displayName: FileImportDisplayName; subfolder?: string; fileImportFilters: Array; } /** * Could not replace the Folder. * * Log Safety: SAFE */ declare interface ReplaceFolderPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceFolderPermissionDenied"; errorDescription: "Could not replace the Folder."; errorInstanceId: string; parameters: { folderRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceFolderRequest { parentFolderRid: FolderRid_2; displayName: ResourceDisplayName; } /** * Could not replace the GroupMembershipExpirationPolicy. * * Log Safety: SAFE */ declare interface ReplaceGroupMembershipExpirationPolicyPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceGroupMembershipExpirationPolicyPermissionDenied"; errorDescription: "Could not replace the GroupMembershipExpirationPolicy."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * Log Safety: SAFE */ declare interface ReplaceGroupMembershipExpirationPolicyRequest { maximumDuration?: _Core.DurationSeconds; maximumValue?: GroupMembershipExpiration; } /** * Could not replace the Group. * * Log Safety: SAFE */ declare interface ReplaceGroupPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceGroupPermissionDenied"; errorDescription: "Could not replace the Group."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * Could not replace the GroupProviderInfo. * * Log Safety: SAFE */ declare interface ReplaceGroupProviderInfoPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceGroupProviderInfoPermissionDenied"; errorDescription: "Could not replace the GroupProviderInfo."; errorInstanceId: string; parameters: { groupId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceGroupProviderInfoRequest { providerId: ProviderId; } /** * Log Safety: UNSAFE */ declare interface ReplaceGroupRequest { name: GroupName_2; organizations: Array<_Core.OrganizationRid>; description?: string; attributes: Record; } /** * Log Safety: SAFE */ declare interface ReplaceJobDurationCheckConfig { timeCheckConfig: TimeCheckConfig; } /** * Log Safety: UNSAFE */ declare interface ReplaceJobStatusCheckConfig { statusCheckConfig: StatusCheckConfig; } /** * Could not replace the LiveDeployment. * * Log Safety: SAFE */ declare interface ReplaceLiveDeploymentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceLiveDeploymentPermissionDenied"; errorDescription: "Could not replace the LiveDeployment."; errorInstanceId: string; parameters: { liveDeploymentRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceLiveDeploymentRequest { runtimeConfiguration: LiveDeploymentRuntimeConfiguration; } /** * Could not replace the MarkingCategory. * * Log Safety: UNSAFE */ declare interface ReplaceMarkingCategoryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceMarkingCategoryPermissionDenied"; errorDescription: "Could not replace the MarkingCategory."; errorInstanceId: string; parameters: { markingCategoryId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceMarkingCategoryRequest { name: MarkingCategoryName; description: MarkingCategoryDescription; } /** * Could not replace the Marking. * * Log Safety: UNSAFE */ declare interface ReplaceMarkingPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceMarkingPermissionDenied"; errorDescription: "Could not replace the Marking."; errorInstanceId: string; parameters: { markingId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceMarkingRequest { name: MarkingName; description?: string; } /** * Could not replace the ModelFunction. * * Log Safety: SAFE */ declare interface ReplaceModelFunctionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceModelFunctionPermissionDenied"; errorDescription: "Could not replace the ModelFunction."; errorInstanceId: string; parameters: { modelRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceModelFunctionRequest { apiName: ModelFunctionApiName; ontologyBinding?: _Ontologies.OntologyRid; isRowWise: ModelFunctionIsRowWise; } /** * Log Safety: SAFE */ declare interface ReplaceNullPercentageCheckConfig { percentageCheckConfig: ReplacePercentageCheckConfig; } /** * Log Safety: SAFE */ declare interface ReplaceNumericColumnCheckConfig { numericBounds?: NumericBoundsConfig; trend?: TrendConfig; } /** * Log Safety: SAFE */ declare interface ReplaceNumericColumnMeanCheckConfig { numericColumnCheckConfig: ReplaceNumericColumnCheckConfig; } /** * Log Safety: SAFE */ declare interface ReplaceNumericColumnMedianCheckConfig { numericColumnCheckConfig: ReplaceNumericColumnCheckConfig; } /** * Log Safety: SAFE */ declare interface ReplaceNumericColumnRangeCheckConfig { numericBoundsConfig: NumericBoundsConfig; } /** * Could not replace the Organization. * * Log Safety: SAFE */ declare interface ReplaceOrganizationPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceOrganizationPermissionDenied"; errorDescription: "Could not replace the Organization."; errorInstanceId: string; parameters: { organizationRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceOrganizationRequest { name: OrganizationName; host?: HostName; description?: string; } /** * Log Safety: SAFE */ declare interface ReplacePercentageCheckConfig { medianDeviation?: MedianDeviationConfig; percentageBounds?: PercentageBoundsConfig; } /** * Log Safety: SAFE */ declare interface ReplacePrimaryKeyCheckConfig { primaryKeyConfig: ReplacePrimaryKeyConfig; } /** * Log Safety: SAFE */ declare interface ReplacePrimaryKeyConfig { severity: SeverityLevel; } /** * Could not replace the Project. * * Log Safety: SAFE */ declare interface ReplaceProjectPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceProjectPermissionDenied"; errorDescription: "Could not replace the Project."; errorInstanceId: string; parameters: { projectRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceProjectRequest { displayName: ResourceDisplayName; description?: string; } /** * Log Safety: SAFE */ declare interface ReplaceScheduleDurationCheckConfig { timeCheckConfig: TimeCheckConfig; } /** * Could not replace the Schedule. * * Log Safety: SAFE */ declare interface ReplaceSchedulePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceSchedulePermissionDenied"; errorDescription: "Could not replace the Schedule."; errorInstanceId: string; parameters: { scheduleRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleRequest { displayName?: string; description?: string; action: ReplaceScheduleRequestAction; trigger?: Trigger; scopeMode?: ReplaceScheduleRequestScopeMode; } /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleRequestAction { abortOnFailure?: AbortOnFailure; forceBuild?: ForceBuild; retryBackoffDuration?: RetryBackoffDuration; retryCount?: RetryCount; fallbackBranches?: FallbackBranches; branchName?: _Core.BranchName; notificationsEnabled?: NotificationsEnabled; target: ReplaceScheduleRequestBuildTarget; } /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleRequestAndTrigger { triggers: Array; } /** * The targets of the build. * * Log Safety: SAFE */ declare type ReplaceScheduleRequestBuildTarget = ({ type: "upstream"; } & ReplaceScheduleRequestUpstreamTarget) | ({ type: "manual"; } & ReplaceScheduleRequestManualTarget) | ({ type: "connecting"; } & ReplaceScheduleRequestConnectingTarget); /** * Log Safety: SAFE */ declare interface ReplaceScheduleRequestConnectingTarget { ignoredRids?: Array; targetRids: Array; inputRids: Array; } /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleRequestDatasetUpdatedTrigger { datasetRid: _Core.DatasetRid; branchName?: _Core.BranchName; } /** * Log Safety: SAFE */ declare interface ReplaceScheduleRequestDuration { unit: _Core.TimeUnit; value: number; } /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleRequestJobSucceededTrigger { datasetRid: _Core.DatasetRid; branchName?: _Core.BranchName; } /** * Log Safety: SAFE */ declare interface ReplaceScheduleRequestManualTarget { targetRids: Array; } /** * Log Safety: SAFE */ declare interface ReplaceScheduleRequestManualTrigger { } /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleRequestMediaSetUpdatedTrigger { branchName?: _Core.BranchName; mediaSetRid: _Core.MediaSetRid; } /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleRequestNewLogicTrigger { datasetRid: _Core.DatasetRid; branchName?: _Core.BranchName; } /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleRequestOrTrigger { triggers: Array; } /** * Log Safety: SAFE */ declare interface ReplaceScheduleRequestProjectScope { projectRids: Array<_Filesystem.ProjectRid>; } /** * Log Safety: SAFE */ declare interface ReplaceScheduleRequestScheduleSucceededTrigger { scheduleRid: _Core.ScheduleRid; } /** * The boundaries for the schedule build. * * Log Safety: SAFE */ declare type ReplaceScheduleRequestScopeMode = ({ type: "project"; } & ReplaceScheduleRequestProjectScope) | ({ type: "user"; } & ReplaceScheduleRequestUserScope); /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleRequestTableUpdatedTrigger { branchName?: _Core.BranchName; tableRid: _Core.TableRid; } /** * Log Safety: SAFE */ declare interface ReplaceScheduleRequestTimeTrigger { cronExpression: CronExpression; timeZone?: _Core.ZoneId; } /** * Log Safety: UNSAFE */ declare type ReplaceScheduleRequestTrigger = ({ type: "jobSucceeded"; } & ReplaceScheduleRequestJobSucceededTrigger) | ({ type: "or"; } & ReplaceScheduleRequestOrTrigger) | ({ type: "newLogic"; } & ReplaceScheduleRequestNewLogicTrigger) | ({ type: "tableUpdated"; } & ReplaceScheduleRequestTableUpdatedTrigger) | ({ type: "and"; } & ReplaceScheduleRequestAndTrigger) | ({ type: "datasetUpdated"; } & ReplaceScheduleRequestDatasetUpdatedTrigger) | ({ type: "scheduleSucceeded"; } & ReplaceScheduleRequestScheduleSucceededTrigger) | ({ type: "mediaSetUpdated"; } & ReplaceScheduleRequestMediaSetUpdatedTrigger) | ({ type: "time"; } & ReplaceScheduleRequestTimeTrigger) | ({ type: "manual"; } & ReplaceScheduleRequestManualTrigger); /** * Log Safety: SAFE */ declare interface ReplaceScheduleRequestUpstreamTarget { ignoredRids?: Array; targetRids: Array; } /** * Log Safety: SAFE */ declare interface ReplaceScheduleRequestUserScope { } /** * Log Safety: UNSAFE */ declare interface ReplaceScheduleStatusCheckConfig { statusCheckConfig: StatusCheckConfig; } /** * Log Safety: UNSAFE */ declare interface ReplaceSchemaComparisonCheckConfig { schemaComparisonConfig: SchemaComparisonConfig; } /** * Could not replace the Space. * * Log Safety: SAFE */ declare interface ReplaceSpacePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceSpacePermissionDenied"; errorDescription: "Could not replace the Space."; errorInstanceId: string; parameters: { spaceRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceSpaceRequest { usageAccountRid?: UsageAccountRid; displayName: ResourceDisplayName; description?: string; defaultRoleSetId?: _Core.RoleSetId; } /** * Could not replace the TableImport. * * Log Safety: SAFE */ declare interface ReplaceTableImportPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceTableImportPermissionDenied"; errorDescription: "Could not replace the TableImport."; errorInstanceId: string; parameters: { tableImportRid: unknown; connectionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequest { importMode: TableImportMode; displayName: TableImportDisplayName; allowSchemaChanges?: TableImportAllowSchemaChanges; config: ReplaceTableImportRequestTableImportConfig; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestDatabricksTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestDateColumnInitialIncrementalState { currentValue: string; columnName: string; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestDecimalColumnInitialIncrementalState { currentValue: string; columnName: string; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestIntegerColumnInitialIncrementalState { currentValue: number; columnName: string; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestJdbcTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestLongColumnInitialIncrementalState { currentValue: string; columnName: string; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestMicrosoftAccessTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestMicrosoftSqlServerTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestOracleTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestPostgreSqlTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestSnowflakeTableImportConfig { initialIncrementalState?: TableImportInitialIncrementalState; query: TableImportQuery; } /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestStringColumnInitialIncrementalState { currentValue: string; columnName: string; } /** * The import configuration for a specific connector type. * * Log Safety: UNSAFE */ declare type ReplaceTableImportRequestTableImportConfig = ({ type: "databricksImportConfig"; } & ReplaceTableImportRequestDatabricksTableImportConfig) | ({ type: "jdbcImportConfig"; } & ReplaceTableImportRequestJdbcTableImportConfig) | ({ type: "microsoftSqlServerImportConfig"; } & ReplaceTableImportRequestMicrosoftSqlServerTableImportConfig) | ({ type: "postgreSqlImportConfig"; } & ReplaceTableImportRequestPostgreSqlTableImportConfig) | ({ type: "microsoftAccessImportConfig"; } & ReplaceTableImportRequestMicrosoftAccessTableImportConfig) | ({ type: "snowflakeImportConfig"; } & ReplaceTableImportRequestSnowflakeTableImportConfig) | ({ type: "oracleImportConfig"; } & ReplaceTableImportRequestOracleTableImportConfig); /** * The incremental configuration for a table import enables append-style transactions from the same table without duplication of data. You must provide a monotonically increasing column such as a timestamp or id and an initial value for this column. An incremental table import will import rows where the value is greater than the largest already imported. You can use the '?' character to reference the incremental state value when constructing your query. Normally this would be used in a WHERE clause or similar filter applied in order to only sync data with an incremental column value larger than the previously observed maximum value stored in the incremental state. * * Log Safety: UNSAFE */ declare type ReplaceTableImportRequestTableImportInitialIncrementalState = ({ type: "stringColumnInitialIncrementalState"; } & ReplaceTableImportRequestStringColumnInitialIncrementalState) | ({ type: "dateColumnInitialIncrementalState"; } & ReplaceTableImportRequestDateColumnInitialIncrementalState) | ({ type: "integerColumnInitialIncrementalState"; } & ReplaceTableImportRequestIntegerColumnInitialIncrementalState) | ({ type: "timestampColumnInitialIncrementalState"; } & ReplaceTableImportRequestTimestampColumnInitialIncrementalState) | ({ type: "longColumnInitialIncrementalState"; } & ReplaceTableImportRequestLongColumnInitialIncrementalState) | ({ type: "decimalColumnInitialIncrementalState"; } & ReplaceTableImportRequestDecimalColumnInitialIncrementalState); /** * Log Safety: UNSAFE */ declare interface ReplaceTableImportRequestTimestampColumnInitialIncrementalState { currentValue: string; columnName: string; } /** * Log Safety: SAFE */ declare interface ReplaceTimeSinceLastUpdatedCheckConfig { timeCheckConfig: TransactionTimeCheckConfig; } /** * Log Safety: SAFE */ declare interface ReplaceTotalColumnCountCheckConfig { columnCountConfig: ColumnCountConfig; } /** * Could not replace the UserProviderInfo. * * Log Safety: SAFE */ declare interface ReplaceUserProviderInfoPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ReplaceUserProviderInfoPermissionDenied"; errorDescription: "Could not replace the UserProviderInfo."; errorInstanceId: string; parameters: { userId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ReplaceUserProviderInfoRequest { providerId: ProviderId; } export declare namespace Repositories { export { } } /** * Log Safety: SAFE */ declare interface Repository { rid: RepositoryRid; widgetSetRid?: WidgetSetRid; } /** * The given Repository could not be found. * * Log Safety: SAFE */ declare interface RepositoryNotFound { errorCode: "NOT_FOUND"; errorName: "RepositoryNotFound"; errorDescription: "The given Repository could not be found."; errorInstanceId: string; parameters: { repositoryRid: unknown; }; } /** * A Resource Identifier (RID) identifying a repository. * * Log Safety: SAFE */ declare type RepositoryRid = LooselyBrandedString_24<"RepositoryRid">; /** * A semantic version of a repository storing backing files. * * Log Safety: UNSAFE */ declare type RepositoryVersion = LooselyBrandedString_24<"RepositoryVersion">; /** * Unique request id * * Log Safety: SAFE */ declare type RequestId = string; /** * Required input field is null or missing. * * Log Safety: UNSAFE */ declare interface RequiredValueMissingError { fieldName: string; } /** * The spaceRid provided is for a reserved space in Foundry which cannot be replaced. * * Log Safety: SAFE */ declare interface ReservedSpaceCannotBeReplaced { errorCode: "INVALID_ARGUMENT"; errorName: "ReservedSpaceCannotBeReplaced"; errorDescription: "The spaceRid provided is for a reserved space in Foundry which cannot be replaced."; errorInstanceId: string; parameters: {}; } /* Excluded from this release type: reset */ /* Excluded from this release type: resetOffsets */ /** * Could not reset the Stream. * * Log Safety: UNSAFE */ declare interface ResetStreamPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ResetStreamPermissionDenied"; errorDescription: "Could not reset the Stream."; errorInstanceId: string; parameters: { datasetRid: unknown; streamBranchName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ResetStreamRequest { schema?: _Core.StreamSchema; partitionsCount?: PartitionsCount; streamType?: StreamType; compressed?: Compressed; } /** * Could not resetOffsets the Subscriber. * * Log Safety: UNSAFE */ declare interface ResetSubscriberOffsetsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ResetSubscriberOffsetsPermissionDenied"; errorDescription: "Could not resetOffsets the Subscriber."; errorInstanceId: string; parameters: { datasetRid: unknown; subscriberSubscriberId: unknown; streamBranchName: unknown; }; } /** * Log Safety: SAFE */ declare interface ResetSubscriberOffsetsRequest { position: ReadPosition; } /** * Resizes an image to the specified dimensions. If only one dimension is specified, the other is calculated to preserve aspect ratio. * * Log Safety: SAFE */ declare interface ResizeImageOperation { height?: number; width?: number; autoOrient?: boolean; } /** * Resizes an image to maximally fit within a bounding box while preserving aspect ratio. * * Log Safety: SAFE */ declare interface ResizeToFitBoundingBoxOperation { width: number; height: number; } /** * Image resizing strategy. * * Log Safety: SAFE */ declare type ResizingMode = "RESIZING" | "FIT_INTO_BOUNDING_BOX"; /* Excluded from this release type: resolveApplication */ /** * Could not resolveApplication the Document. * * Log Safety: SAFE */ declare interface ResolveApplicationDocumentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ResolveApplicationDocumentPermissionDenied"; errorDescription: "Could not resolveApplication the Document."; errorInstanceId: string; parameters: { documentId: unknown; }; } /** * An interface property type with additional fields to indicate constraints that need to be satisfied by implementing object property types. * * Log Safety: UNSAFE */ declare interface ResolvedInterfacePropertyType { rid: InterfacePropertyTypeRid; apiName: InterfacePropertyApiName; displayName: _Core.DisplayName; description?: string; dataType: ObjectPropertyType; valueTypeApiName?: ValueTypeApiName; valueFormatting?: PropertyValueFormattingRule; requireImplementation: boolean; } /** * The application that owns a PACK Document, resolved via the document's type metadata. * * Log Safety: UNSAFE */ declare interface ResolveDocumentApplicationResponse { owningApplicationId?: string; } /** * Log Safety: UNSAFE */ declare interface Resource { rid: ResourceRid; displayName: ResourceDisplayName; description?: string; documentation?: string; path: ResourcePath; type: ResourceType; createdBy: _Core.CreatedBy; updatedBy: _Core.UpdatedBy; createdTime: _Core.CreatedTime; updatedTime: _Core.UpdatedTime; trashStatus: TrashStatus; parentFolderRid: FolderRid_2; projectRid: ProjectRid; spaceRid: SpaceRid; } /** * Compute resource configuration for training runs. * * Log Safety: SAFE */ declare interface ResourceConfiguration { memory: string; cpu: string; gpu?: GpuType; } /** * The display name of the resource * * Log Safety: UNSAFE */ declare type ResourceDisplayName = LooselyBrandedString_7<"ResourceDisplayName">; /** * The provided resource name is already in use by another resource in the same folder. * * Log Safety: UNSAFE */ declare interface ResourceNameAlreadyExists { errorCode: "CONFLICT"; errorName: "ResourceNameAlreadyExists"; errorDescription: "The provided resource name is already in use by another resource in the same folder."; errorInstanceId: string; parameters: { parentFolderRid: unknown; resourceName: unknown; }; } /** * The provided resource name is already in use by another resource in the same folder. * * Log Safety: UNSAFE */ declare interface ResourceNameAlreadyExists_2 { errorCode: "CONFLICT"; errorName: "ResourceNameAlreadyExists"; errorDescription: "The provided resource name is already in use by another resource in the same folder."; errorInstanceId: string; parameters: { parentFolderRid: unknown; displayName: unknown; }; } /** * The resource is not directly trashed. * * Log Safety: UNSAFE */ declare interface ResourceNotDirectlyTrashed { errorCode: "INVALID_ARGUMENT"; errorName: "ResourceNotDirectlyTrashed"; errorDescription: "The resource is not directly trashed."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * The given Resource could not be found. * * Log Safety: UNSAFE */ declare interface ResourceNotFound { errorCode: "NOT_FOUND"; errorName: "ResourceNotFound"; errorDescription: "The given Resource could not be found."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * The resource should be directly trashed before being permanently deleted. * * Log Safety: UNSAFE */ declare interface ResourceNotTrashed { errorCode: "INVALID_ARGUMENT"; errorName: "ResourceNotTrashed"; errorDescription: "The resource should be directly trashed before being permanently deleted."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * The full path to the resource, including the resource name itself * * Log Safety: UNSAFE */ declare type ResourcePath = LooselyBrandedString_7<"ResourcePath">; /** * The unique resource identifier (RID) of a resource. * * Log Safety: UNSAFE */ declare type ResourceRid = LooselyBrandedString_7<"ResourceRid">; /** * Log Safety: SAFE */ declare interface ResourceRole { resourceRolePrincipal: ResourceRolePrincipal; roleId: _Core.RoleId; } /** * A role grant on a resource for add/remove operations that doesn't require specifying the principal type. * * Log Safety: SAFE */ declare interface ResourceRoleIdentifier { resourceRolePrincipal: ResourceRolePrincipalIdentifier; roleId: _Core.RoleId; } /** * Log Safety: SAFE */ declare type ResourceRolePrincipal = ({ type: "principalWithId"; } & PrincipalWithId) | ({ type: "everyone"; } & Everyone); /** * A principal for resource role operations that doesn't require specifying the principal type. * * Log Safety: SAFE */ declare type ResourceRolePrincipalIdentifier = ({ type: "principalIdOnly"; } & PrincipalIdOnly) | ({ type: "everyone"; } & Everyone); export declare namespace ResourceRoles { export { list_15 as list, add_8 as add, remove_8 as remove } } export declare namespace Resources { export { deleteResource, get_16 as get, getBatch_6 as getBatch, getByPath, getByPathBatch, restore, permanentlyDelete, addMarkings, removeMarkings, getAccessRequirements, markings } } /** * Log Safety: UNSAFE */ declare interface ResourceTag { tagRid: TagRid; displayName: ResourceTagDisplayName; } /** * The display name of the tag, qualified by its category as {category}:{tag}. * * Log Safety: UNSAFE */ declare type ResourceTagDisplayName = LooselyBrandedString_7<"ResourceTagDisplayName">; export declare namespace ResourceTags { export { } } /** * The type of the resource derived from the Resource Identifier (RID). * * Log Safety: SAFE */ declare type ResourceType = "AIP_PROFILE" | "AIP_AGENTS_AGENT" | "AIP_AGENTS_SESSION" | "AIP_ASSIST_FLOW_CAPTURE" | "AIP_ASSIST_WALKTHROUGH" | "ARTIFACTS_REPOSITORY" | "BELLASO_CIPHER_CHANNEL" | "BELLASO_CIPHER_LICENSE" | "BLACKSMITH_DOCUMENT" | "BLOBSTER_ARCHIVE" | "BLOBSTER_AUDIO" | "BLOBSTER_BLOB" | "BLOBSTER_CODE" | "BLOBSTER_CONFIGURATION" | "BLOBSTER_DOCUMENT" | "BLOBSTER_IMAGE" | "BLOBSTER_JUPYTERNOTEBOOK" | "BLOBSTER_PDF" | "BLOBSTER_PRESENTATION" | "BLOBSTER_SPREADSHEET" | "BLOBSTER_VIDEO" | "BLOBSTER_XML" | "CARBON_WORKSPACE" | "COMPASS_FOLDER" | "COMPASS_WEB_LINK" | "CONTOUR_ANALYSIS" | "DATA_HEALTH_MONITORING_VIEW" | "DECISIONS_EXPLORATION" | "DREDDIE_PIPELINE" | "EDDIE_LOGIC" | "EDDIE_PIPELINE" | "FFORMS_FORM" | "FLOW_WORKFLOW" | "FOUNDRY_DATASET" | "FOUNDRY_DEPLOYED_APP" | "FOUNDRY_ACADEMY_TUTORIAL" | "FOUNDRY_CONTAINER_SERVICE_CONTAINER" | "FOUNDRY_ML_OBJECTIVE" | "FOUNDRY_TEMPLATES_TEMPLATE" | "FUSION_DOCUMENT" | "GEOTIME_CATALOG_INTEGRATION" | "GPS_VIEW" | "HUBBLE_EXPLORATION_LAYOUT" | "HYPERAUTO_INTEGRATION" | "LOGIC_FLOWS_CONNECTED_FLOW" | "MACHINERY_DOCUMENT" | "MAGRITTE_AGENT" | "MAGRITTE_DRIVER" | "MAGRITTE_EXPORT" | "MAGRITTE_SOURCE" | "MARKETPLACE_BLOCK_SET_INSTALLATION" | "MARKETPLACE_BLOCK_SET_REPO" | "MARKETPLACE_LOCAL" | "MARKETPLACE_REMOTE_STORE" | "MIO_MEDIA_SET" | "MODELS_MODEL" | "MODELS_MODEL_VERSION" | "MONOCLE_GRAPH" | "NOTEPAD_NOTEPAD" | "NOTEPAD_NOTEPAD_TEMPLATE" | "OBJECT_SENTINEL_MONITOR" | "OBJECT_SET_VERSIONED_OBJECT_SET" | "OPUS_GRAPH" | "OPUS_GRAPH_TEMPLATE" | "OPUS_MAP" | "OPUS_MAP_LAYER" | "OPUS_MAP_TEMPLATE" | "OPUS_SEARCH_AROUND" | "QUIVER_ANALYSIS" | "QUIVER_ARTIFACT" | "QUIVER_DASHBOARD" | "QUIVER_FUNCTION" | "QUIVER_OBJECT_SET_PATH" | "REPORT_REPORT" | "SLATE_DOCUMENT" | "SOLUTION_DESIGN_DIAGRAM" | "STEMMA_REPOSITORY" | "TABLES_TABLE" | "TAURUS_WORKFLOW" | "THIRD_PARTY_APPLICATIONS_APPLICATION" | "TIME_SERIES_CATALOG_SYNC" | "VECTOR_TEMPLATE" | "VECTOR_WORKBOOK" | "WORKSHOP_MODULE" | "WORKSHOP_STATE"; /** * Checkpoint justification that requires the user to input a free-text response. * * Log Safety: UNSAFE */ declare interface ResponseJustification { response: string; prompt: string; description?: string; title: string; } /** * The method of authentication for connecting to an external REST system. * * Log Safety: DO_NOT_LOG */ declare type RestAuthenticationMode = ({ type: "bearerToken"; } & BearerToken) | ({ type: "apiKey"; } & ApiKeyAuthentication) | ({ type: "basic"; } & BasicCredentials) | ({ type: "oauth2"; } & RestConnectionOAuth2); /** * When creating or updating additional secrets, use SecretsWithPlaintextValues. When fetching the RestConnectionConfiguration, SecretsNames will be provided. * * Log Safety: DO_NOT_LOG */ declare type RestConnectionAdditionalSecrets = ({ type: "asSecretsWithPlaintextValues"; } & SecretsWithPlaintextValues) | ({ type: "asSecretsNames"; } & SecretsNames); /** * The configuration needed to connect to a REST external system. * * Log Safety: DO_NOT_LOG */ declare interface RestConnectionConfiguration { domains: Array; additionalSecrets?: RestConnectionAdditionalSecrets; oauth2ClientRid?: string; } /** * In order to use OAuth2 you must have an Outbound application configured in the Foundry Control Panel Organization settings. The RID of the Outbound application must be configured in the RestConnectionConfiguration in the oauth2ClientRid field. * * Log Safety: SAFE */ declare interface RestConnectionOAuth2 { } /** * Restore the given resource and any directly trashed ancestors from the trash. If the resource is not * trashed, this operation will be ignored. * * @public * * Required Scopes: [api:filesystem-write] * URL: /v2/filesystem/resources/{resourceRid}/restore */ declare function restore($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [resourceRid: _Filesystem_2.ResourceRid]): Promise; /** * Could not restore the Resource. * * Log Safety: UNSAFE */ declare interface RestoreResourcePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RestoreResourcePermissionDenied"; errorDescription: "Could not restore the Resource."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * The location of the API key in the request. * * Log Safety: UNSAFE */ declare type RestRequestApiKeyLocation = ({ type: "header"; } & HeaderApiKey) | ({ type: "queryParameter"; } & QueryParameterApiKey); /** * The RID of a Foundry restricted view. * * Log Safety: SAFE */ declare type RestrictedViewRid = LooselyBrandedString_5<"RestrictedViewRid">; /* Excluded from this release type: retrieve */ /** * Failed to generate a response after retrying up to the configured number of retry attempts. Clients should wait and retry. * * Log Safety: UNSAFE */ declare interface RetryAttemptsExceeded { errorCode: "CUSTOM_CLIENT"; errorName: "RetryAttemptsExceeded"; errorDescription: "Failed to generate a response after retrying up to the configured number of retry attempts. Clients should wait and retry."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * The duration to wait before retrying after a Job fails. * * Log Safety: SAFE */ declare type RetryBackoffDuration = _Core.Duration; /** * The number of retry attempts for failed Jobs within the Build. A Job's failure is not considered final until all retries have been attempted or an error occurs indicating that retries cannot be performed. Be aware, not all types of failures can be retried. * * Log Safety: SAFE */ declare type RetryCount = number; /** * Failed to generate a response after retrying up to the configured retry deadline. Clients should wait and retry. * * Log Safety: UNSAFE */ declare interface RetryDeadlineExceeded { errorCode: "CUSTOM_CLIENT"; errorName: "RetryDeadlineExceeded"; errorDescription: "Failed to generate a response after retrying up to the configured retry deadline. Clients should wait and retry."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; details: unknown; }; } /** * If not specified, defaults to NONE. * * Log Safety: SAFE */ declare type ReturnEditsMode = "ALL" | "ALL_V2_WITH_DELETIONS" | "NONE"; /** * Returns action types based on whether they are revertible. * * Log Safety: SAFE */ declare interface RevertActionEnabledActionTypesQueryV2 { value: boolean; } /** * A unique incrementing identifier that represents the order of edits applied by the server. * * Log Safety: SAFE */ declare type RevisionId = string; /** * Revoke all active authentication tokens for the user including active browser sessions and long-lived * development tokens. If the user has active sessions in a browser, this will force re-authentication. * * The caller must have permission to manage users for the target user's organization. * * @public * * Required Scopes: [api:admin-write] * URL: /v2/admin/users/{userId}/revokeAllTokens */ declare function revokeAllTokens($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [userId: _Core.UserId]): Promise; /** * Could not revokeAllTokens the User. * * Log Safety: SAFE */ declare interface RevokeAllTokensUserPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RevokeAllTokensUserPermissionDenied"; errorDescription: "Could not revokeAllTokens the User."; errorInstanceId: string; parameters: { userId: unknown; }; } /** * The string must be a valid RID (Resource Identifier). * * Log Safety: SAFE */ declare interface RidConstraint { } /** * Log Safety: SAFE */ declare interface RidConstraint_2 { } /** * A Resource Identifier (RID) that was passed as input to a tool. * * Log Safety: UNSAFE */ declare interface RidToolInputValue { rid: string; } /** * A Resource Identifier (RID) value that was returned from a tool. * * Log Safety: UNSAFE */ declare interface RidToolOutputValue { rid: string; } /** * A set of permissions that can be assigned to a principal for a specific resource type. * * Log Safety: UNSAFE */ declare interface Role { id: RoleId; roleSetId: RoleSetId; name: string; description: string; isDefault: boolean; type: RoleContext; operations: Array; } /** * Log Safety: UNSAFE */ declare interface Role_2 { id: _Core.RoleId; displayName: RoleDisplayName; description: RoleDescription; operations: Array; canAssigns: Array<_Core.RoleId>; } /** * Log Safety: SAFE */ declare interface RoleAssignmentUpdate { roleId: RoleId; principalId: PrincipalId; } /** * Log Safety: SAFE */ declare type RoleContext = "ORGANIZATION"; /** * Log Safety: UNSAFE */ declare type RoleDescription = LooselyBrandedString_3<"RoleDescription">; /** * Log Safety: UNSAFE */ declare type RoleDisplayName = LooselyBrandedString_3<"RoleDisplayName">; /** * The unique ID for a Role. Roles are sets of permissions that grant different levels of access to resources. The default roles in Foundry are: Owner, Editor, Viewer, and Discoverer. See more about roles in the user documentation. * * Log Safety: SAFE */ declare type RoleId = LooselyBrandedString<"RoleId">; /** * The given Role could not be found. * * Log Safety: SAFE */ declare interface RoleNotFound { errorCode: "NOT_FOUND"; errorName: "RoleNotFound"; errorDescription: "The given Role could not be found."; errorInstanceId: string; parameters: { roleId: unknown; }; } export declare namespace Roles { export { } } /** * Log Safety: SAFE */ declare type RoleSetId = LooselyBrandedString<"RoleSetId">; /** * The role set provided in the request to create or replace a space could not be found. * * Log Safety: SAFE */ declare interface RoleSetNotFound { errorCode: "NOT_FOUND"; errorName: "RoleSetNotFound"; errorDescription: "The role set provided in the request to create or replace a space could not be found."; errorInstanceId: string; parameters: { roleSetRid: unknown; }; } /** * Number of points in each window. * * Log Safety: SAFE */ declare interface RollingAggregateWindowPoints { count: number; } /** * Rotates an image clockwise by the specified angle. * * Log Safety: SAFE */ declare interface RotateImageOperation { angle: RotationAngle; } /** * The rotation angle from EXIF orientation. * * Log Safety: SAFE */ declare type RotationAngle = "DEGREE_90" | "DEGREE_180" | "DEGREE_270" | "UNKNOWN"; /** * @public * * Required Scopes: [api:orchestration-write] * URL: /v2/orchestration/schedules/{scheduleRid}/run */ declare function run($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [scheduleRid: _Core.ScheduleRid]): Promise<_Orchestration_2.ScheduleRun>; /** * A unique identifier for a Model Studio run, derived from the studio, config, and build. * * Log Safety: SAFE */ declare type RunId = LooselyBrandedString_15<"RunId">; /** * The query execution is still in progress. * * Log Safety: SAFE */ declare interface RunningExecution { } /** * Log Safety: DO_NOT_LOG */ declare interface RunningQueryStatus { queryId: SqlQueryId; } /** * Get the most recent runs of a Schedule. If no page size is provided, a page size of 100 will be used. * * @public * * Required Scopes: [api:orchestration-read] * URL: /v2/orchestration/schedules/{scheduleRid}/runs */ declare function runs($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ scheduleRid: _Core.ScheduleRid, $queryParams?: { pageSize?: _Core.PageSize | undefined; pageToken?: _Core.PageToken | undefined; } ]): Promise<_Orchestration_2.ListRunsOfScheduleResponse>; /** * Could not run the Schedule. * * Log Safety: SAFE */ declare interface RunSchedulePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "RunSchedulePermissionDenied"; errorDescription: "Could not run the Schedule."; errorInstanceId: string; parameters: { scheduleRid: unknown; }; } /** * Log Safety: DO_NOT_LOG */ declare type S3AuthenticationMode = ({ type: "awsAccessKey"; } & AwsAccessKey) | ({ type: "cloudIdentity"; } & CloudIdentity) | ({ type: "oidc"; } & AwsOidcAuthentication); /** * The configuration needed to connect to an AWS S3 external system (or any other S3-like external systems that implement the s3a protocol). * * Log Safety: DO_NOT_LOG */ declare interface S3ConnectionConfiguration { bucketUrl: string; s3Endpoint?: string; region?: Region; authenticationMode?: S3AuthenticationMode; s3EndpointSigningRegion?: Region; clientKmsConfiguration?: S3KmsConfiguration; stsRoleConfiguration?: StsRoleConfiguration; proxyConfiguration?: S3ProxyConfiguration; maxConnections?: number; connectionTimeoutMillis?: string; socketTimeoutMillis?: string; maxErrorRetry?: number; matchSubfolderExactly?: boolean; enableRequesterPays?: boolean; } /** * Log Safety: UNSAFE */ declare interface S3KmsConfiguration { kmsKey: string; kmsRegion?: Region; } /** * Log Safety: DO_NOT_LOG */ declare interface S3ProxyConfiguration { host: string; port: number; nonProxyHosts?: Array; protocol?: Protocol; credentials?: BasicCredentials; } /** * Log Safety: UNSAFE */ declare interface SamlAuthenticationProtocol { serviceProviderMetadata: SamlServiceProviderMetadata; } /** * Information that describes a Foundry Authentication Provider as a SAML service provider. All information listed here is generated by Foundry. * * Log Safety: UNSAFE */ declare interface SamlServiceProviderMetadata { entityId: string; metadataUrl: string; acsUrls: Array; logoutUrls: Array; certificates: Array; } /* Excluded from this release type: saveDocument */ /** * Could not saveDocument the GenerationJob. * * Log Safety: SAFE */ declare interface SaveDocumentGenerationJobPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "SaveDocumentGenerationJobPermissionDenied"; errorDescription: "Could not saveDocument the GenerationJob."; errorInstanceId: string; parameters: { generationJobRid: unknown; templateRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface SaveDocumentGenerationJobRequest { documentName?: string; parentFolderRid: _Filesystem.FolderRid; } /** * Response for saving a document * * Log Safety: SAFE */ declare interface SaveDocumentResponse { documentRid: DocumentRid; } /** * An error occurred while scanning the website files for vulnerabilities. Please check the Website Hosting page in Developer Console for more information and try uploading again. * * Log Safety: UNSAFE */ declare interface ScanningErrored { errorCode: "CUSTOM_CLIENT"; errorName: "ScanningErrored"; errorDescription: "An error occurred while scanning the website files for vulnerabilities. Please check the Website Hosting page in Developer Console for more information and try uploading again."; errorInstanceId: string; parameters: { version: unknown; }; } /** * The website files are currently being scanned for vulnerabilities. Please wait for the scan to complete and confirm no vulnerabilities first. * * Log Safety: UNSAFE */ declare interface ScanningInProgress { errorCode: "CUSTOM_CLIENT"; errorName: "ScanningInProgress"; errorDescription: "The website files are currently being scanned for vulnerabilities. Please wait for the scan to complete and confirm no vulnerabilities first."; errorInstanceId: string; parameters: { version: unknown; }; } /** * Log Safety: SAFE */ declare interface ScenarioReferenceType { } /** * The rid of a scenario to evaluate the query against. * * Log Safety: SAFE */ declare type ScenarioRid = LooselyBrandedString_21<"ScenarioRid">; /** * The sensitivity threshold for scene detection. * * Log Safety: SAFE */ declare type SceneScore = "MORE_SENSITIVE" | "STANDARD" | "LESS_SENSITIVE"; /** * Log Safety: UNSAFE */ declare interface Schedule { rid: _Core.ScheduleRid; displayName?: string; description?: string; currentVersionRid: ScheduleVersionRid; createdTime: _Core.CreatedTime; createdBy: _Core.CreatedBy; updatedTime: _Core.UpdatedTime; updatedBy: _Core.UpdatedBy; paused: SchedulePaused; trigger?: Trigger; action: Action_2; scopeMode: ScopeMode; } /* Excluded from this release type: schedule */ /** * The target schedule is currently running. * * Log Safety: SAFE */ declare interface ScheduleAlreadyRunning { errorCode: "CONFLICT"; errorName: "ScheduleAlreadyRunning"; errorDescription: "The target schedule is currently running."; errorInstanceId: string; parameters: { scheduleRid: unknown; }; } /** * Checks the total time a schedule takes to complete. * * Log Safety: SAFE */ declare interface ScheduleDurationCheckConfig { subject: ScheduleSubject; timeCheckConfig: TimeCheckConfig; } /** * The given Schedule could not be found. * * Log Safety: SAFE */ declare interface ScheduleNotFound { errorCode: "NOT_FOUND"; errorName: "ScheduleNotFound"; errorDescription: "The given Schedule could not be found."; errorInstanceId: string; parameters: { scheduleRid: unknown; }; } /** * Log Safety: UNSAFE */ declare type SchedulePaused = boolean; /** * The RID of a Schedule. * * Log Safety: SAFE */ declare type ScheduleRid = LooselyBrandedString<"ScheduleRid">; /** * The RID of a Schedule. * * Log Safety: SAFE */ declare type ScheduleRid_2 = LooselyBrandedString_8<"ScheduleRid">; /** * Log Safety: UNSAFE */ declare interface ScheduleRun { rid: ScheduleRunRid; scheduleRid: _Core.ScheduleRid; scheduleVersionRid: ScheduleVersionRid; createdTime: _Core.CreatedTime; createdBy?: _Core.CreatedBy; result?: ScheduleRunResult; } /** * An error occurred attempting to run the schedule. * * Log Safety: UNSAFE */ declare interface ScheduleRunError { errorName: ScheduleRunErrorName; description: string; } /** * Log Safety: SAFE */ declare type ScheduleRunErrorName = "TARGETRESOLUTIONFAILURE" | "CYCLICDEPENDENCY" | "INCOMPATIBLETARGETS" | "PERMISSIONDENIED" | "JOBSPECNOTFOUND" | "SCHEDULEOWNERNOTFOUND" | "INTERNAL"; /** * The schedule is not running as all targets are up-to-date. * * Log Safety: SAFE */ declare interface ScheduleRunIgnored { } /** * The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, ignored if all targets are up-to-date or error. * * Log Safety: UNSAFE */ declare type ScheduleRunResult = ({ type: "ignored"; } & ScheduleRunIgnored) | ({ type: "submitted"; } & ScheduleRunSubmitted) | ({ type: "error"; } & ScheduleRunError); /** * The RID of a schedule run * * Log Safety: SAFE */ declare type ScheduleRunRid = LooselyBrandedString_16<"ScheduleRunRid">; /** * The schedule has been successfully triggered. * * Log Safety: SAFE */ declare interface ScheduleRunSubmitted { buildRid: _Core.BuildRid; } export declare namespace Schedules { export { deleteSchedule, run, pause, unpause, runs } } /** * Checks the status of the most recent schedule run. * * Log Safety: UNSAFE */ declare interface ScheduleStatusCheckConfig { subject: ScheduleSubject; statusCheckConfig: StatusCheckConfig; } /** * A schedule resource type. * * Log Safety: SAFE */ declare interface ScheduleSubject { scheduleRid: _Core.ScheduleRid; } /** * Trigger whenever the specified schedule completes its action successfully. * * Log Safety: SAFE */ declare interface ScheduleSucceededTrigger { scheduleRid: _Core.ScheduleRid; } /** * The given resources in the schedule trigger could not be found. * * Log Safety: SAFE */ declare interface ScheduleTriggerResourcesNotFound { errorCode: "NOT_FOUND"; errorName: "ScheduleTriggerResourcesNotFound"; errorDescription: "The given resources in the schedule trigger could not be found."; errorInstanceId: string; parameters: { resourceRids: unknown; }; } /** * The provided token does not have permission to use the given resources as a schedule trigger. * * Log Safety: SAFE */ declare interface ScheduleTriggerResourcesPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ScheduleTriggerResourcesPermissionDenied"; errorDescription: "The provided token does not have permission to use the given resources as a schedule trigger."; errorInstanceId: string; parameters: { resourceRids: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ScheduleVersion { rid: ScheduleVersionRid; scheduleRid: _Core.ScheduleRid; createdTime: _Core.CreatedTime; createdBy: _Core.CreatedBy; trigger?: Trigger; action: Action_2; scopeMode: ScopeMode; } /** * The given ScheduleVersion could not be found. * * Log Safety: SAFE */ declare interface ScheduleVersionNotFound { errorCode: "NOT_FOUND"; errorName: "ScheduleVersionNotFound"; errorDescription: "The given ScheduleVersion could not be found."; errorInstanceId: string; parameters: { scheduleVersionRid: unknown; }; } /** * The RID of a schedule version * * Log Safety: SAFE */ declare type ScheduleVersionRid = LooselyBrandedString_16<"ScheduleVersionRid">; export declare namespace ScheduleVersions { export { } } /** * Checks the dataset schema against an expected schema. * * Log Safety: UNSAFE */ declare interface SchemaComparisonCheckConfig { subject: DatasetSubject; schemaComparisonConfig: SchemaComparisonConfig; } /** * Configuration for schema comparison validation with severity settings. * * Log Safety: UNSAFE */ declare interface SchemaComparisonConfig { expectedSchema: SchemaInfo; schemaComparisonType: SchemaComparisonType; severity: SeverityLevel; } /** * The type of schema comparison to perform: EXACT_MATCH_ORDERED_COLUMNS: Schemas must have identical columns in the same order. EXACT_MATCH_UNORDERED_COLUMNS: Schemas must have identical columns but order doesn't matter. COLUMN_ADDITIONS_ALLOWED: Expected schema columns must be present, additional columns are allowed and missing column types are ignored. COLUMN_ADDITIONS_ALLOWED_STRICT: Expected schema columns must be present, additional columns are allowed. Both expected and actual columns must specify types and they must match exactly. * * Log Safety: SAFE */ declare type SchemaComparisonType = "EXACT_MATCH_ORDERED_COLUMNS" | "EXACT_MATCH_UNORDERED_COLUMNS" | "COLUMN_ADDITIONS_ALLOWED" | "COLUMN_ADDITIONS_ALLOWED_STRICT"; /** * The data type of a column in a dataset schema. * * Log Safety: SAFE */ declare type SchemaFieldType = "ARRAY" | "BINARY" | "BOOLEAN" | "BYTE" | "DATE" | "DECIMAL" | "DOUBLE" | "FLOAT" | "INTEGER" | "LONG" | "MAP" | "SHORT" | "STRING" | "STRUCT" | "TIMESTAMP"; /** * Information about a dataset schema including all columns. * * Log Safety: UNSAFE */ declare interface SchemaInfo { columns: Array; } /** * The requested schema could not be converted into a stream schema. * * Log Safety: SAFE */ declare interface SchemaIsNotStreamSchema { errorCode: "INVALID_ARGUMENT"; errorName: "SchemaIsNotStreamSchema"; errorDescription: "The requested schema could not be converted into a stream schema."; errorInstanceId: string; parameters: {}; } /** * Metadata about when a schema element was added or deprecated. * * Log Safety: UNSAFE */ declare interface SchemaMetadata { addedInVersion: SchemaVersion; deprecatedFromVersion?: SchemaVersion; deprecatedMessage?: string; } /** * A schema could not be found for the given dataset and branch, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface SchemaNotFound { errorCode: "NOT_FOUND"; errorName: "SchemaNotFound"; errorDescription: "A schema could not be found for the given dataset and branch, or the client token does not have access to it."; errorInstanceId: string; parameters: { datasetRid: unknown; branchName: unknown; transactionRid: unknown; }; } /** * The schema update could not be applied because another update was applied concurrently. Retry the operation with the latest schema version. * * Log Safety: UNSAFE */ declare interface SchemaUpdateConflict { errorCode: "CONFLICT"; errorName: "SchemaUpdateConflict"; errorDescription: "The schema update could not be applied because another update was applied concurrently. Retry the operation with the latest schema version."; errorInstanceId: string; parameters: { documentTypeName: unknown; }; } /** * A failed schema validation result containing the list of violations. * * Log Safety: UNSAFE */ declare interface SchemaValidationFailure { violations: Array; } /** * An incrementing version number for a document type schema. Each schema update increments this value by one, representing a linear history of versions. * * Log Safety: SAFE */ declare type SchemaVersion = number; /** * A single schema validation violation. * * Log Safety: UNSAFE */ declare interface SchemaViolation { fieldPath: string; message: string; violationType: SchemaViolationType; } /** * The type of schema validation violation. * * Log Safety: SAFE */ declare type SchemaViolationType = "FIELD_ADDED_WITH_INCORRECT_VERSION" | "FIELD_REMOVED" | "RECORD_REMOVED" | "UNION_VARIANT_MODIFICATION" | "UNION_REMOVED" | "INCORRECT_VERSION" | "ADDED_WITH_DEPRECATION" | "UNDEPRECATION_NOT_ALLOWED" | "FIELD_MODIFIED"; /** * Indicates whether the checkpoint was scoped to a user or resource. * * Log Safety: SAFE */ declare type Scope = "USER_SCOPED" | "RESOURCE_SCOPED"; /** * The boundaries for the schedule build. * * Log Safety: SAFE */ declare type ScopeMode = ({ type: "project"; } & ProjectScope) | ({ type: "user"; } & UserScope); /** * A script entrypoint to be loaded into the runtime environment. * * Log Safety: UNSAFE */ declare interface ScriptEntrypoint { filePath: FilePath_2; scriptType: ScriptType; } /** * Log Safety: SAFE */ declare type ScriptType = "DEFAULT" | "MODULE"; /** * Log Safety: UNSAFE */ declare type SdkPackageName = LooselyBrandedString_5<"SdkPackageName">; /** * Log Safety: SAFE */ declare type SdkPackageRid = LooselyBrandedString_5<"SdkPackageRid">; /** * Log Safety: SAFE */ declare type SdkVersion = LooselyBrandedString_5<"SdkVersion">; /** * Perform a case-insensitive prefix search for groups based on group name. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/groups/search */ declare function search($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Admin.SearchGroupsRequest]): Promise<_Admin.SearchGroupsResponse>; /** * Perform a case-insensitive prefix search for active users based on username, given name and family name. * Deleted users are not included in results. To list deleted users, use the `list` endpoint with `include=DELETED`. * * @public * * Required Scopes: [api:admin-read] * URL: /v2/admin/users/search */ declare function search_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [$body: _Admin.SearchUsersRequest]): Promise<_Admin.SearchUsersResponse>; /* Excluded from this release type: search_3 */ /* Excluded from this release type: search_4 */ /** * Search for objects in the specified ontology and object type. The request body is used * to filter objects based on the specified query. The supported queries are: * * | Query type | Description | Supported Types | * |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------| * | lt | The provided property is less than the provided value. | number, string, date, timestamp | * | gt | The provided property is greater than the provided value. | number, string, date, timestamp | * | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | * | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | * | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | * | isNull | The provided property is (or is not) null. | all | * | contains | The provided property contains the provided value. | array | * | not | The sub-query does not match. | N/A (applied on a query) | * | and | All the sub-queries match. | N/A (applied on queries) | * | or | At least one of the sub-queries match. | N/A (applied on queries) | * | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string | * | containsAllTermsInOrder | The provided property contains the provided term as a substring. | string | * | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string | * | containsAllTerms | The provided property contains all the terms separated by whitespace. | string | * | startsWith | Deprecated alias for containsAllTermsInOrderPrefixLastTerm. | string | * * Queries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'"~`). Periods (`.`) on their own are ignored. * Partial terms are not matched by terms filters except where explicitly noted. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/search */ declare function search_5($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, $body: _Ontologies_2.SearchObjectsRequestV2, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; executeInMemoryOnly?: boolean | undefined; } ]): Promise<_Ontologies_2.SearchObjectsResponseV2>; /* Excluded from this release type: search_6 */ /* Excluded from this release type: search_7 */ /* Excluded from this release type: search_8 */ /* Excluded from this release type: search_9 */ /** * 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. * * Log Safety: SAFE */ declare interface SearchActionTypesOrderByV2 { field: ActionTypeSortByV2; direction?: string; } /** * Log Safety: UNSAFE */ declare interface SearchActionTypesRequestV2 { where?: ActionTypeSearchJsonQueryV2; orderBy?: SearchActionTypesOrderByV2; fuzziness?: ActionTypeFuzziness; pageSize?: _Core.PageSize; pageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface SearchActionTypesResponseV2 { data: Array; nextPageToken?: _Core.PageToken; totalCount: _Core.TotalCount; } /** * Returns the Builds where every filter is satisfied. * * Log Safety: UNSAFE */ declare interface SearchBuildsAndFilter { items: Array; } /** * Log Safety: UNSAFE */ declare interface SearchBuildsEqualsFilter { field: SearchBuildsEqualsFilterField; value: any; } /** * Log Safety: SAFE */ declare type SearchBuildsEqualsFilterField = "CREATED_BY" | "BRANCH_NAME" | "STATUS" | "RID"; /** * Log Safety: UNSAFE */ declare type SearchBuildsFilter = ({ type: "not"; } & SearchBuildsNotFilter) | ({ type: "or"; } & SearchBuildsOrFilter) | ({ type: "and"; } & SearchBuildsAndFilter) | ({ type: "lt"; } & SearchBuildsLtFilter) | ({ type: "gte"; } & SearchBuildsGteFilter) | ({ type: "eq"; } & SearchBuildsEqualsFilter); /** * Log Safety: UNSAFE */ declare interface SearchBuildsGteFilter { field: SearchBuildsGteFilterField; value: any; } /** * Log Safety: SAFE */ declare type SearchBuildsGteFilterField = "STARTED_TIME" | "FINISHED_TIME"; /** * Log Safety: UNSAFE */ declare interface SearchBuildsLtFilter { field: SearchBuildsLtFilterField; value: any; } /** * Log Safety: SAFE */ declare type SearchBuildsLtFilterField = "STARTED_TIME" | "FINISHED_TIME"; /** * Returns the Builds where the filter is not satisfied. * * Log Safety: UNSAFE */ declare interface SearchBuildsNotFilter { value: SearchBuildsFilter; } /** * Log Safety: SAFE */ declare interface SearchBuildsOrderBy { fields: Array; } /** * Log Safety: SAFE */ declare type SearchBuildsOrderByField = "STARTED_TIME" | "FINISHED_TIME"; /** * Log Safety: SAFE */ declare interface SearchBuildsOrderByItem { field: SearchBuildsOrderByField; direction: _Core.OrderByDirection; } /** * Returns the Builds where at least one filter is satisfied. * * Log Safety: UNSAFE */ declare interface SearchBuildsOrFilter { items: Array; } /** * Could not search the Build. * * Log Safety: SAFE */ declare interface SearchBuildsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "SearchBuildsPermissionDenied"; errorDescription: "Could not search the Build."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface SearchBuildsRequest { where: SearchBuildsFilter; orderBy?: SearchBuildsOrderBy; pageToken?: _Core.PageToken; pageSize?: _Core.PageSize; } /** * Log Safety: UNSAFE */ declare interface SearchBuildsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Logical conjunction of checkpoint record filters. * * Log Safety: UNSAFE */ declare interface SearchCheckpointRecordsAndFilter { filters: Array; } /** * Filter for checkpointed item identifier matches. * * Log Safety: UNSAFE */ declare interface SearchCheckpointRecordsCheckpointedItemIdFilter { checkpointedItemId: CheckpointedItemId; } /** * Filter for exact field value matches. * * Log Safety: UNSAFE */ declare interface SearchCheckpointRecordsEqualsFilter { field: SearchCheckpointRecordsEqualsFilterField; value: string; } /** * Fields that support equality filtering. * * Log Safety: SAFE */ declare type SearchCheckpointRecordsEqualsFilterField = "recordRid" | "configRid" | "checkpointType" | "actingUserId" | "delegateUserId" | "organizationRid" | "namespaceRid" | "interactionRid" | "checkpointedItemType"; /** * Search criteria for checkpoint records. * * Log Safety: UNSAFE */ declare type SearchCheckpointRecordsFilter = ({ type: "not"; } & SearchCheckpointRecordsNotFilter) | ({ type: "or"; } & SearchCheckpointRecordsOrFilter) | ({ type: "textSearch"; } & SearchCheckpointRecordsTextSearchFilter) | ({ type: "and"; } & SearchCheckpointRecordsAndFilter) | ({ type: "lt"; } & SearchCheckpointRecordsLtFilter) | ({ type: "gte"; } & SearchCheckpointRecordsGteFilter) | ({ type: "eq"; } & SearchCheckpointRecordsEqualsFilter) | ({ type: "checkpointedItemId"; } & SearchCheckpointRecordsCheckpointedItemIdFilter); /** * Filter for greater-than-or-equal comparisons. * * Log Safety: SAFE */ declare interface SearchCheckpointRecordsGteFilter { field: SearchCheckpointRecordsGteFilterField; value: string; } /** * Fields that support greater-than-or-equal filtering. * * Log Safety: SAFE */ declare type SearchCheckpointRecordsGteFilterField = "createdAt"; /** * Filter for less-than comparisons. * * Log Safety: SAFE */ declare interface SearchCheckpointRecordsLtFilter { field: SearchCheckpointRecordsLtFilterField; value: string; } /** * Fields that support less-than filtering. * * Log Safety: SAFE */ declare type SearchCheckpointRecordsLtFilterField = "createdAt"; /** * Logical negation of a checkpoint record filter. * * Log Safety: UNSAFE */ declare interface SearchCheckpointRecordsNotFilter { filter: SearchCheckpointRecordsFilter; } /** * Logical disjunction of checkpoint record filters. * * Log Safety: UNSAFE */ declare interface SearchCheckpointRecordsOrFilter { filters: Array; } /** * Request payload for searching checkpoint records. * * Log Safety: UNSAFE */ declare interface SearchCheckpointRecordsRequest { filter: SearchCheckpointRecordsFilter; } /** * Response payload for searching checkpoint records. * * Log Safety: UNSAFE */ declare interface SearchCheckpointRecordsResponse { data: Array<_Record>; nextPageToken?: _Core.PageToken; } /** * Filter for text search on justification fields. * * Log Safety: UNSAFE */ declare interface SearchCheckpointRecordsTextSearchFilter { field: SearchCheckpointRecordsTextSearchFilterField; query: string; matchType: JustificationMatchType; } /** * Fields that support text search filtering. * * Log Safety: SAFE */ declare type SearchCheckpointRecordsTextSearchFilterField = "justificationResponse" | "justificationSelectedOption" | "justificationAdditionalResponse"; /** * Could not search the Document. * * Log Safety: SAFE */ declare interface SearchDocumentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "SearchDocumentsPermissionDenied"; errorDescription: "Could not search the Document."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface SearchDocumentsRequest { documentTypeName: DocumentTypeName; requestBody: DocumentSearchRequest; } /** * Returns experiments where every filter is satisfied. * * Log Safety: UNSAFE */ declare interface SearchExperimentsAndFilter { filters: Array; } /** * Filter for substring containment matches. * * Log Safety: UNSAFE */ declare interface SearchExperimentsContainsFilter { field: SearchExperimentsContainsFilterField; value: any; } /** * Fields that support substring containment filtering. * * Log Safety: SAFE */ declare type SearchExperimentsContainsFilterField = "EXPERIMENT_NAME" | "PARAMETER_NAME" | "SERIES_NAME"; /** * Filter for exact field value matches. * * Log Safety: UNSAFE */ declare interface SearchExperimentsEqualsFilter { field: SearchExperimentsEqualsFilterField; value: any; } /** * Fields that support equality filtering. * * Log Safety: SAFE */ declare type SearchExperimentsEqualsFilterField = "STATUS" | "BRANCH" | "EXPERIMENT_NAME" | "EXPERIMENT_RID" | "JOB_RID" | "TAG" | "PARAMETER_NAME" | "SERIES_NAME"; /** * Filter for searching experiments using operator-based composition. Supports equality, text matching, boolean combination operators, and compound filters that atomically bind a name to a value comparison. Example filters: Simple status: {"eq": {"field": "STATUS", "value": "RUNNING"}} Branch match: {"eq": {"field": "BRANCH", "value": "master"}} Parameter filter: {"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.01}} Combined: {"and": {"filters": [ {"eq": {"field": "STATUS", "value": "SUCCEEDED"}}, {"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.5}} ]}} * * Log Safety: UNSAFE */ declare type SearchExperimentsFilter = ({ type: "seriesFilter"; } & SearchExperimentsSeriesFilter) | ({ type: "contains"; } & SearchExperimentsContainsFilter) | ({ type: "not"; } & SearchExperimentsNotFilter) | ({ type: "or"; } & SearchExperimentsOrFilter) | ({ type: "and"; } & SearchExperimentsAndFilter) | ({ type: "parameterFilter"; } & SearchExperimentsParameterFilter) | ({ type: "summaryMetricFilter"; } & SearchExperimentsSummaryMetricFilter) | ({ type: "eq"; } & SearchExperimentsEqualsFilter) | ({ type: "startsWith"; } & SearchExperimentsStartsWithFilter); /** * Returns experiments where the filter is not satisfied. * * Log Safety: UNSAFE */ declare interface SearchExperimentsNotFilter { value: SearchExperimentsFilter; } /** * Comparison operator for numeric filter predicates (series and summary metrics). * * Log Safety: SAFE */ declare type SearchExperimentsNumericFilterOperator = "EQ" | "GT" | "LT"; /** * Ordering configuration for experiment search results. * * Log Safety: SAFE */ declare interface SearchExperimentsOrderBy { field: SearchExperimentsOrderByField; direction: _Core.OrderByDirection; } /** * Fields to order experiment search results by. * * Log Safety: SAFE */ declare type SearchExperimentsOrderByField = "EXPERIMENT_NAME" | "CREATED_TIME"; /** * Returns experiments where at least one filter is satisfied. * * Log Safety: UNSAFE */ declare interface SearchExperimentsOrFilter { filters: Array; } /** * Filter that atomically binds a parameter name to a value comparison, ensuring both conditions are evaluated on the same parameter. Supported combinations: EQ: boolean, double, integer, or datetime value GT/LT: double, integer, or datetime value CONTAINS: string value (substring match on the parameter's string value) * * Log Safety: UNSAFE */ declare interface SearchExperimentsParameterFilter { parameterName: ParameterName; operator: SearchExperimentsParameterFilterOperator; value: any; } /** * Comparison operator for parameter filter predicates. * * Log Safety: SAFE */ declare type SearchExperimentsParameterFilterOperator = "EQ" | "GT" | "LT" | "CONTAINS"; /** * Could not search the Experiment. * * Log Safety: SAFE */ declare interface SearchExperimentsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "SearchExperimentsPermissionDenied"; errorDescription: "Could not search the Experiment."; errorInstanceId: string; parameters: { modelRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface SearchExperimentsRequest { where?: SearchExperimentsFilter; orderBy?: SearchExperimentsOrderBy; pageSize?: _Core.PageSize; pageToken?: _Core.PageToken; } /** * Response from searching experiments. * * Log Safety: UNSAFE */ declare interface SearchExperimentsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Filter that atomically binds a series name to a metric comparison, ensuring all conditions are evaluated on the same series. * * Log Safety: UNSAFE */ declare interface SearchExperimentsSeriesFilter { seriesName: SeriesName; field: SearchExperimentsSeriesFilterField; operator: SearchExperimentsNumericFilterOperator; value: any; } /** * The series metric to filter on. * * Log Safety: SAFE */ declare type SearchExperimentsSeriesFilterField = "LENGTH" | "AGGREGATION_MIN" | "AGGREGATION_MAX" | "AGGREGATION_LAST"; /** * Filter for prefix matches. * * Log Safety: UNSAFE */ declare interface SearchExperimentsStartsWithFilter { field: SearchExperimentsStartsWithFilterField; value: any; } /** * Fields that support prefix filtering. * * Log Safety: SAFE */ declare type SearchExperimentsStartsWithFilterField = "EXPERIMENT_NAME" | "PARAMETER_NAME" | "SERIES_NAME"; /** * Filter that atomically binds a series name and aggregation type to a value comparison, ensuring all conditions are evaluated on the same summary metric. * * Log Safety: UNSAFE */ declare interface SearchExperimentsSummaryMetricFilter { seriesName: SeriesName; aggregation: SummaryMetricAggregation; operator: SearchExperimentsNumericFilterOperator; value: any; } /** * Could not search the Group. * * Log Safety: SAFE */ declare interface SearchGroupsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "SearchGroupsPermissionDenied"; errorDescription: "Could not search the Group."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface SearchGroupsRequest { where: GroupSearchFilter; pageSize?: _Core.PageSize; pageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface SearchGroupsResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare type SearchJsonQuery = ({ type: "or"; } & OrQuery) | ({ type: "prefix"; } & PrefixQuery) | ({ type: "lt"; } & LtQuery) | ({ type: "allTerms"; } & AllTermsQuery) | ({ type: "eq"; } & EqualsQuery) | ({ type: "gt"; } & GtQuery) | ({ type: "contains"; } & ContainsQuery) | ({ type: "not"; } & NotQuery) | ({ type: "phrase"; } & PhraseQuery) | ({ type: "and"; } & AndQuery) | ({ type: "isNull"; } & IsNullQuery) | ({ type: "gte"; } & GteQuery) | ({ type: "anyTerm"; } & AnyTermQuery) | ({ type: "lte"; } & LteQuery); /** * @deprecated Use `SearchJsonQueryV2` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare type SearchJsonQueryV2 = ({ type: "or"; } & OrQueryV2) | ({ type: "in"; } & InQuery) | ({ type: "doesNotIntersectPolygon"; } & DoesNotIntersectPolygonQuery) | ({ type: "lt"; } & LtQueryV2) | ({ type: "doesNotIntersectBoundingBox"; } & DoesNotIntersectBoundingBoxQuery) | ({ type: "eq"; } & EqualsQueryV2) | ({ type: "containsAllTerms"; } & ContainsAllTermsQuery) | ({ type: "gt"; } & GtQueryV2) | ({ type: "withinDistanceOf"; } & WithinDistanceOfQuery) | ({ type: "withinBoundingBox"; } & WithinBoundingBoxQuery) | ({ type: "contains"; } & ContainsQueryV2) | ({ type: "not"; } & NotQueryV2) | ({ type: "intersectsBoundingBox"; } & IntersectsBoundingBoxQuery) | ({ type: "and"; } & AndQueryV2) | ({ type: "isNull"; } & IsNullQueryV2) | ({ type: "containsAllTermsInOrderPrefixLastTerm"; } & ContainsAllTermsInOrderPrefixLastTerm) | ({ type: "containsAnyTerm"; } & ContainsAnyTermQuery) | ({ type: "gte"; } & GteQueryV2) | ({ type: "containsAllTermsInOrder"; } & ContainsAllTermsInOrderQuery) | ({ type: "withinPolygon"; } & WithinPolygonQuery) | ({ type: "intersectsPolygon"; } & IntersectsPolygonQuery) | ({ type: "lte"; } & LteQueryV2) | ({ type: "startsWith"; } & StartsWithQuery); /** * Log Safety: UNSAFE */ declare type SearchJsonQueryV2_2 = ({ type: "lt"; } & LtQueryV2_2) | ({ type: "doesNotIntersectBoundingBox"; } & DoesNotIntersectBoundingBoxQuery_2) | ({ type: "relativeDateRange"; } & RelativeDateRangeQuery) | ({ type: "wildcard"; } & WildcardQuery) | ({ type: "withinDistanceOf"; } & WithinDistanceOfQuery_2) | ({ type: "withinBoundingBox"; } & WithinBoundingBoxQuery_2) | ({ type: "not"; } & NotQueryV2_2) | ({ type: "intersectsBoundingBox"; } & IntersectsBoundingBoxQuery_2) | ({ type: "and"; } & AndQueryV2_2) | ({ type: "containsAllTermsInOrderPrefixLastTerm"; } & ContainsAllTermsInOrderPrefixLastTerm_2) | ({ type: "gte"; } & GteQueryV2_2) | ({ type: "containsAllTermsInOrder"; } & ContainsAllTermsInOrderQuery_2) | ({ type: "withinPolygon"; } & WithinPolygonQuery_2) | ({ type: "intersectsPolygon"; } & IntersectsPolygonQuery_2) | ({ type: "lte"; } & LteQueryV2_2) | ({ type: "or"; } & OrQueryV2_2) | ({ type: "in"; } & InQuery_2) | ({ type: "doesNotIntersectPolygon"; } & DoesNotIntersectPolygonQuery_2) | ({ type: "eq"; } & EqualsQueryV2_2) | ({ type: "containsAllTerms"; } & ContainsAllTermsQuery_2) | ({ type: "gt"; } & GtQueryV2_2) | ({ type: "contains"; } & ContainsQueryV2_2) | ({ type: "regex"; } & RegexQuery) | ({ type: "isNull"; } & IsNullQueryV2_2) | ({ type: "containsAnyTerm"; } & ContainsAnyTermQuery_2) | ({ type: "interval"; } & IntervalQuery) | ({ type: "geoShapeV2"; } & GeoShapeV2Query) | ({ type: "startsWith"; } & StartsWithQuery_2); /** * Log Safety: UNSAFE */ declare interface SearchObjectsForInterfaceRequest { where?: SearchJsonQueryV2_2; orderBy?: SearchOrderByV2; augmentedProperties: Record>; augmentedSharedPropertyTypes: Record>; augmentedInterfacePropertyTypes: Record>; selectedSharedPropertyTypes: Array; selectedInterfacePropertyTypes: Array; selectedObjectTypes: Array; otherInterfaceTypes: Array; pageSize?: _Core.PageSize; pageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface SearchObjectsRequest { query: SearchJsonQuery; orderBy?: SearchOrderBy; pageSize?: _Core.PageSize; pageToken?: _Core.PageToken; fields: Array; } /** * Log Safety: UNSAFE */ declare interface SearchObjectsRequestV2 { where?: SearchJsonQueryV2_2; orderBy?: SearchOrderByV2; pageSize?: _Core.PageSize; pageToken?: _Core.PageToken; select: Array; selectV2: Array; defaultLoadLevel?: PropertyLoadLevel; excludeRid?: boolean; snapshot?: boolean; referenceSigningOptions?: ReferenceSigningOptions; } /** * Log Safety: UNSAFE */ declare interface SearchObjectsResponse { data: Array; nextPageToken?: _Core.PageToken; totalCount: _Core.TotalCount; } /** * Log Safety: UNSAFE */ declare interface SearchObjectsResponseV2 { data: Array; nextPageToken?: _Core.PageToken; totalCount: _Core.TotalCount; } /** * Specifies the ordering of search results by a field and an ordering direction. * * Log Safety: UNSAFE */ declare interface SearchOrderBy { fields: Array; } /** * Log Safety: SAFE */ declare type SearchOrderByType = "fields" | "relevance"; /** * Specifies the ordering of search results by a field and an ordering direction, or by relevance. If the fields array is provided, orderType is automatically set to fields. If this object is omitted entirely, the ordering is unspecified. Setting orderType to relevance requests that results are sorted by decreasing relevance score. For queries that include text search filters (e.g. containsAllTerms, containsAnyTerm, containsAllTermsInOrder, containsAllTermsInOrderPrefixLastTerm) or nearestNeighbors, the relevance score reflects how well each object matches the query. For other queries, the ordering is unspecified. When paging through results ordered by relevance, ordering is not guaranteed to be consistent across pages: an object may appear on multiple pages or be skipped entirely. Use a single page when result completeness is required. Relevance ordering can be expensive and should only be used when required. * * Log Safety: UNSAFE */ declare interface SearchOrderByV2 { orderType?: SearchOrderByType; fields: Array; } /** * Log Safety: UNSAFE */ declare interface SearchOrdering { field: FieldNameV1; direction?: string; } /** * Log Safety: UNSAFE */ declare interface SearchOrderingV2 { field: PropertyApiName_2; direction?: string; } /** * Could not search the Record. * * Log Safety: SAFE */ declare interface SearchRecordsPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "SearchRecordsPermissionDenied"; errorDescription: "Could not search the Record."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface SearchRecordsRequest { where: SearchCheckpointRecordsRequest; pageToken?: _Core.PageToken; pageSize?: _Core.PageSize; sortDirection?: SortDirection; } /** * Could not search the User. * * Log Safety: SAFE */ declare interface SearchUsersPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "SearchUsersPermissionDenied"; errorDescription: "Could not search the User."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface SearchUsersRequest { where: UserSearchFilter; pageSize?: _Core.PageSize; pageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare interface SearchUsersResponse { data: Array; nextPageToken?: _Core.PageToken; } /** * Log Safety: UNSAFE */ declare type SecretName = LooselyBrandedString_12<"SecretName">; /** * The secret names provided do not exist on the connection. * * Log Safety: UNSAFE */ declare interface SecretNamesDoNotExist { errorCode: "INVALID_ARGUMENT"; errorName: "SecretNamesDoNotExist"; errorDescription: "The secret names provided do not exist on the connection."; errorInstanceId: string; parameters: { connectionRid: unknown; secretNames: unknown; }; } /** * A list of secret names that can be referenced in code and webhook configurations. This will be provided to the client when fetching the RestConnectionConfiguration. * * Log Safety: UNSAFE */ declare interface SecretsNames { secretNames: Array; } /** * A map representing secret name to plaintext secret value pairs. This should be used when creating or updating additional secrets for a REST connection. * * Log Safety: DO_NOT_LOG */ declare interface SecretsWithPlaintextValues { secrets: Record; } /** * Returns action types with a section matching the given section rid. * * Log Safety: SAFE */ declare interface SectionRidActionTypesQueryV2 { value: ActionSectionRid; } /** * Log Safety: UNSAFE */ declare interface SecuredPropertyValue { value?: PropertyValue_2; propertySecurityIndex?: number; } /** * By default, whenever an object is requested, all of its properties are returned, except for properties of the following types: Vector The response can be filtered to only include certain properties using the properties query parameter. Note that ontology object set endpoints refer to this parameter as select. Properties to include can be specified in one of two ways. A comma delimited list as the value for the properties query parameter properties={property1ApiName},{property2ApiName} Multiple properties query parameters. properties={property1ApiName}&properties={property2ApiName} The primary key of the object will always be returned even if it wasn't specified in the properties values. Unknown properties specified in the properties list will result in a PropertiesNotFound error. To find the API name for your property, use the Get object type endpoint or check the Ontology Manager. * * Log Safety: UNSAFE */ declare type SelectedPropertyApiName = LooselyBrandedString_5<"SelectedPropertyApiName">; /** * Computes an approximate number of distinct values for the provided field. * * Log Safety: UNSAFE */ declare interface SelectedPropertyApproximateDistinctAggregation { selectedPropertyApiName: PropertyApiName_2; } /** * Computes the approximate percentile value for the provided field. * * Log Safety: UNSAFE */ declare interface SelectedPropertyApproximatePercentileAggregation { selectedPropertyApiName: PropertyApiName_2; approximatePercentile: number; } /** * Computes the average value for the provided field. * * Log Safety: UNSAFE */ declare interface SelectedPropertyAvgAggregation { selectedPropertyApiName: PropertyApiName_2; } /** * Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default. NOTE: A separate count aggregation should be used to determine the total count of values, to account for a possible truncation of the returned list. Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property. * * Log Safety: UNSAFE */ declare interface SelectedPropertyCollectListAggregation { selectedPropertyApiName: PropertyApiName_2; limit: number; } /** * Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100. NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of values, to account for a possible truncation of the returned set. Ignores objects for which a property is absent, so the returned list will contain non-null values only. Returns an empty list when none of the objects have values for a provided property. * * Log Safety: UNSAFE */ declare interface SelectedPropertyCollectSetAggregation { selectedPropertyApiName: PropertyApiName_2; limit: number; } /** * Computes the total count of objects. * * Log Safety: SAFE */ declare interface SelectedPropertyCountAggregation { } /** * Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. * * Log Safety: UNSAFE */ declare interface SelectedPropertyExactDistinctAggregation { selectedPropertyApiName: PropertyApiName_2; } /** * Definition for a selected property over a MethodObjectSet. * * Log Safety: UNSAFE */ declare interface SelectedPropertyExpression { objectSet: MethodObjectSet; operation: SelectedPropertyOperation; } /** * Computes the maximum value for the provided field. * * Log Safety: UNSAFE */ declare interface SelectedPropertyMaxAggregation { selectedPropertyApiName: PropertyApiName_2; } /** * Computes the minimum value for the provided field. * * Log Safety: UNSAFE */ declare interface SelectedPropertyMinAggregation { selectedPropertyApiName: PropertyApiName_2; } /** * Operation on a selected property, can be an aggregation function or retrieval of a single selected property * * Log Safety: UNSAFE */ declare type SelectedPropertyOperation = ({ type: "approximateDistinct"; } & SelectedPropertyApproximateDistinctAggregation) | ({ type: "min"; } & SelectedPropertyMinAggregation) | ({ type: "avg"; } & SelectedPropertyAvgAggregation) | ({ type: "max"; } & SelectedPropertyMaxAggregation) | ({ type: "approximatePercentile"; } & SelectedPropertyApproximatePercentileAggregation) | ({ type: "get"; } & GetSelectedPropertyOperation) | ({ type: "count"; } & SelectedPropertyCountAggregation) | ({ type: "sum"; } & SelectedPropertySumAggregation) | ({ type: "collectList"; } & SelectedPropertyCollectListAggregation) | ({ type: "exactDistinct"; } & SelectedPropertyExactDistinctAggregation) | ({ type: "collectSet"; } & SelectedPropertyCollectSetAggregation); /** * Computes the sum of values for the provided field. * * Log Safety: UNSAFE */ declare interface SelectedPropertySumAggregation { selectedPropertyApiName: PropertyApiName_2; } /** * Format for SQL query result serialization. * * Log Safety: SAFE */ declare type SerializationFormat = "ARROW" | "CSV"; /** * A series of values logged over time. * * Log Safety: UNSAFE */ declare type Series = { type: "doubleV1"; } & DoubleSeriesV1; /** * Series with precomputed aggregation values. * * Log Safety: UNSAFE */ declare interface SeriesAggregations { name: SeriesName; length?: string; value: SeriesAggregationsValue; } /** * Union of aggregation values by series type. * * Log Safety: UNSAFE */ declare type SeriesAggregationsValue = { type: "double"; } & DoubleSeriesAggregations; /** * The unique codex id of a time series. * * Log Safety: UNSAFE */ declare type SeriesId = LooselyBrandedString_5<"SeriesId">; /** * The name of a series (metrics tracked over time). * * Log Safety: UNSAFE */ declare type SeriesName = LooselyBrandedString_15<"SeriesName">; /** * The name of the service that is not set-up * * Log Safety: SAFE */ declare type ServiceName = LooselyBrandedString<"ServiceName">; /** * Log Safety: UNSAFE */ declare interface Session { rid: SessionRid; metadata: SessionMetadata; agentRid: AgentRid; agentVersion: AgentVersionString; } /** * Represents an individual exchange between a user and an Agent in a conversation session. * * Log Safety: UNSAFE */ declare interface SessionExchange { userInput: UserTextInput; contexts?: SessionExchangeContexts; result: SessionExchangeResult; } /** * Retrieved context which was passed to the Agent as input for the exchange. * * Log Safety: UNSAFE */ declare interface SessionExchangeContexts { objectContexts: Array; functionRetrievedContexts: Array; } /** * The returned result from the Agent for a session exchange. * * Log Safety: UNSAFE */ declare interface SessionExchangeResult { agentMarkdownResponse: AgentMarkdownResponse; parameterUpdates: Record; totalTokensUsed?: number; interruptedOutput: boolean; sessionTraceId: SessionTraceId; } /** * Failed to generate a response for a session due to an unexpected error. * * Log Safety: UNSAFE */ declare interface SessionExecutionFailed { errorCode: "INTERNAL"; errorName: "SessionExecutionFailed"; errorDescription: "Failed to generate a response for a session due to an unexpected error."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; message: unknown; details: unknown; }; } /** * Metadata for a conversation session with an Agent. * * Log Safety: UNSAFE */ declare interface SessionMetadata { title: string; createdTime: string; updatedTime: string; messageCount: number; estimatedExpiresTime: string; } /** * The given Session could not be found. * * Log Safety: SAFE */ declare interface SessionNotFound { errorCode: "NOT_FOUND"; errorName: "SessionNotFound"; errorDescription: "The given Session could not be found."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * The Resource Identifier (RID) of the conversation session. * * Log Safety: SAFE */ declare type SessionRid = LooselyBrandedString_4<"SessionRid">; export declare namespace Sessions { export { } } /** * Log Safety: UNSAFE */ declare interface SessionTrace { id: SessionTraceId; status: SessionTraceStatus; contexts?: SessionExchangeContexts; toolCallGroups: Array; } /** * The unique identifier for a trace. The trace lists the sequence of steps that an Agent took to arrive at an answer. For example, a trace may include steps such as context retrieval and tool calls. * * Log Safety: SAFE */ declare type SessionTraceId = string; /** * The provided trace ID already exists for the session and cannot be reused. * * Log Safety: SAFE */ declare interface SessionTraceIdAlreadyExists { errorCode: "INVALID_ARGUMENT"; errorName: "SessionTraceIdAlreadyExists"; errorDescription: "The provided trace ID already exists for the session and cannot be reused."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; sessionTraceId: unknown; }; } /** * The given SessionTrace could not be found. * * Log Safety: SAFE */ declare interface SessionTraceNotFound { errorCode: "NOT_FOUND"; errorName: "SessionTraceNotFound"; errorDescription: "The given SessionTrace could not be found."; errorInstanceId: string; parameters: { sessionTraceId: unknown; agentRid: unknown; sessionRid: unknown; }; } export declare namespace SessionTraces { export { } } /** * Log Safety: SAFE */ declare type SessionTraceStatus = "IN_PROGRESS" | "COMPLETE"; /* Excluded from this release type: setWidgetSetById */ /** * Could not setWidgetSetById the DevModeSettings. * * Log Safety: SAFE */ declare interface SetWidgetSetDevModeSettingsByIdPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "SetWidgetSetDevModeSettingsByIdPermissionDenied"; errorDescription: "Could not setWidgetSetById the DevModeSettings."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface SetWidgetSetDevModeSettingsByIdRequest { widgetSetRid: WidgetSetRid; settings: WidgetSetDevModeSettingsById; } /* Excluded from this release type: setWidgetSetManifest */ /** * Could not setWidgetSetManifest the DevModeSettingsV2. * * Log Safety: SAFE */ declare interface SetWidgetSetManifestDevModeSettingsV2PermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "SetWidgetSetManifestDevModeSettingsV2PermissionDenied"; errorDescription: "Could not setWidgetSetManifest the DevModeSettingsV2."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface SetWidgetSetManifestDevModeSettingsV2Request { widgetSetRid: WidgetSetRid; manifest: any; } /** * The severity level of the check. Possible values are MODERATE or CRITICAL. * * Log Safety: SAFE */ declare type SeverityLevel = "MODERATE" | "CRITICAL"; declare interface SharedClient< T extends SharedClientContext = SharedClientContext, > { [symbolClientContext]: T; } declare interface SharedClient_2< T extends SharedClientContext_2 = SharedClientContext_2, > { [symbolClientContext_2]: T; } declare interface SharedClientContext { /** * The base origin to use for requests (e.g. `https://api.example.com`) */ baseUrl: string; /** * The fetch function to use for all requests. */ fetch: typeof globalThis.fetch; tokenProvider: () => Promise; } declare interface SharedClientContext_2 { /** * The base origin to use for requests (e.g. `https://api.example.com`) */ baseUrl: string; /** * The fetch function to use for all requests. */ fetch: typeof globalThis.fetch; tokenProvider: () => Promise; } /** * The requested shared property types are not present on every object type. * * Log Safety: UNSAFE */ declare interface SharedPropertiesNotFound { errorCode: "NOT_FOUND"; errorName: "SharedPropertiesNotFound"; errorDescription: "The requested shared property types are not present on every object type."; errorInstanceId: string; parameters: { objectType: unknown; missingSharedProperties: unknown; }; } /** * A property type that can be shared across object types. * * Log Safety: UNSAFE */ declare interface SharedPropertyType { rid: SharedPropertyTypeRid; apiName: SharedPropertyTypeApiName; displayName: _Core.DisplayName; description?: string; dataType: ObjectPropertyType; valueTypeApiName?: ValueTypeApiName; valueFormatting?: PropertyValueFormattingRule; typeClasses: Array; } /** * The name of the shared property type in the API in lowerCamelCase format. To find the API name for your shared property type, use the List shared property types endpoint or check the Ontology Manager. * * Log Safety: UNSAFE */ declare type SharedPropertyTypeApiName = LooselyBrandedString_5<"SharedPropertyTypeApiName">; /** * The requested shared property type is not found, or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface SharedPropertyTypeNotFound { errorCode: "NOT_FOUND"; errorName: "SharedPropertyTypeNotFound"; errorDescription: "The requested shared property type is not found, or the client token does not have access to it."; errorInstanceId: string; parameters: { apiName: unknown; rid: unknown; }; } /** * The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type SharedPropertyTypeRid = LooselyBrandedString_5<"SharedPropertyTypeRid">; /** * Log Safety: SAFE */ declare interface ShortType { } /** * The value of the similarity threshold must be in the range 0 <= threshold <= 1. * * Log Safety: SAFE */ declare interface SimilarityThresholdOutOfRange { errorCode: "INVALID_ARGUMENT"; errorName: "SimilarityThresholdOutOfRange"; errorDescription: "The value of the similarity threshold must be in the range 0 <= threshold <= 1."; errorInstanceId: string; parameters: { providedThreshold: unknown; }; } /** * Vulnerabilities were detected in these website files. Please check the Website Hosting page in Developer Console for more information and address these vulnerabilities before uploading again. * * Log Safety: UNSAFE */ declare interface SiteAssetHasVulnerabilities { errorCode: "CUSTOM_CLIENT"; errorName: "SiteAssetHasVulnerabilities"; errorDescription: "Vulnerabilities were detected in these website files. Please check the Website Hosting page in Developer Console for more information and address these vulnerabilities before uploading again."; errorInstanceId: string; parameters: { version: unknown; }; } /** * The size of the file or attachment in bytes. * * Log Safety: SAFE */ declare type SizeBytes = string; /** * Slices a PDF to a specified page range. * * Log Safety: SAFE */ declare interface SlicePdfRangeOperation { startPageInclusive: number; endPageExclusive: number; strictlyEnforceEndPage?: boolean; } /** * Log Safety: DO_NOT_LOG */ declare type SmbAuth = { type: "usernamePassword"; } & SmbUsernamePasswordAuth; /** * Log Safety: DO_NOT_LOG */ declare interface SmbConnectionConfiguration { hostname: string; port?: number; proxy?: SmbProxyConfiguration; share: string; baseDirectory?: string; auth: SmbAuth; requireMessageSigning?: boolean; } /** * Egress proxy to pass all traffic through. * * Log Safety: UNSAFE */ declare interface SmbProxyConfiguration { hostname: string; port: number; protocol: SmbProxyType; } /** * Log Safety: SAFE */ declare type SmbProxyType = "HTTP" | "SOCKS"; /** * Log Safety: DO_NOT_LOG */ declare interface SmbUsernamePasswordAuth { username: string; password: EncryptedProperty; domain?: string; } /** * Log Safety: DO_NOT_LOG */ declare type SnowflakeAuthenticationMode = ({ type: "externalOauth"; } & SnowflakeExternalOauth) | ({ type: "keyPair"; } & SnowflakeKeyPairAuthentication) | ({ type: "basic"; } & BasicCredentials); /** * The configuration needed to connect to a Snowflake database. * * Log Safety: DO_NOT_LOG */ declare interface SnowflakeConnectionConfiguration { accountIdentifier: string; database?: string; role?: string; schema?: string; warehouse?: string; authenticationMode: SnowflakeAuthenticationMode; jdbcProperties: JdbcProperties; } /** * Use an External OAuth security integration to connect and authenticate to Snowflake. See https://docs.snowflake.com/en/user-guide/oauth-ext-custom * * Log Safety: UNSAFE */ declare interface SnowflakeExternalOauth { audience: string; issuerUrl: string; subject: ConnectionRid; } /** * Use a key-pair to connect and authenticate to Snowflake. See https://docs.snowflake.com/en/user-guide/key-pair-auth * * Log Safety: DO_NOT_LOG */ declare interface SnowflakeKeyPairAuthentication { user: string; privateKey: EncryptedProperty; } /** * The table import configuration for a Snowflake connection. * * Log Safety: UNSAFE */ declare interface SnowflakeTableImportConfig { query: TableImportQuery; initialIncrementalState?: TableImportInitialIncrementalState; } /** * Pointer to the table in Snowflake. Uses the Snowflake table identifier of database, schema and table. * * Log Safety: UNSAFE */ declare interface SnowflakeVirtualTableConfig { database: string; schema: string; table: string; } /** * Log Safety: SAFE */ declare type SortDirection = "ASC" | "DESC"; /** * Log Safety: UNSAFE */ declare interface Space { rid: SpaceRid; displayName: ResourceDisplayName; description?: string; path: ResourcePath; fileSystemId: FileSystemId; usageAccountRid: UsageAccountRid; organizations: Array<_Core.OrganizationRid>; deletionPolicyOrganizations: Array<_Core.OrganizationRid>; defaultRoleSetId: _Core.RoleSetId; spaceMavenIdentifier?: SpaceMavenIdentifier; } /** * An internal error occurred when trying to create or replace the space. * * Log Safety: SAFE */ declare interface SpaceInternalError { errorCode: "INTERNAL"; errorName: "SpaceInternalError"; errorDescription: "An internal error occurred when trying to create or replace the space."; errorInstanceId: string; parameters: {}; } /** * An invalid argument was provided in the request to create or replace a space. * * Log Safety: SAFE */ declare interface SpaceInvalidArgument { errorCode: "INVALID_ARGUMENT"; errorName: "SpaceInvalidArgument"; errorDescription: "An invalid argument was provided in the request to create or replace a space."; errorInstanceId: string; parameters: {}; } /** * The maven identifier used as the prefix to the maven coordinate that uniquely identifies resources published from this space. * * Log Safety: UNSAFE */ declare type SpaceMavenIdentifier = LooselyBrandedString_7<"SpaceMavenIdentifier">; /** * The provided space name is invalid. It may be a reserved name or contain invalid characters. * * Log Safety: SAFE */ declare interface SpaceNameInvalid { errorCode: "INVALID_ARGUMENT"; errorName: "SpaceNameInvalid"; errorDescription: "The provided space name is invalid. It may be a reserved name or contain invalid characters."; errorInstanceId: string; parameters: {}; } /** * The space cannot be deleted because it contains resources. * * Log Safety: SAFE */ declare interface SpaceNotEmpty { errorCode: "INTERNAL"; errorName: "SpaceNotEmpty"; errorDescription: "The space cannot be deleted because it contains resources."; errorInstanceId: string; parameters: { spaceRid: unknown; }; } /** * The given Space could not be found. * * Log Safety: SAFE */ declare interface SpaceNotFound { errorCode: "NOT_FOUND"; errorName: "SpaceNotFound"; errorDescription: "The given Space could not be found."; errorInstanceId: string; parameters: { spaceRid: unknown; }; } /** * The unique resource identifier (RID) of a Space. * * Log Safety: SAFE */ declare type SpaceRid = LooselyBrandedString_7<"SpaceRid">; export declare namespace Spaces { export { list_17 as list } } /** * The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided geometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that lie within the provided geometry, and CONTAINS matches objects that contain the provided geometry. * * Log Safety: SAFE */ declare type SpatialFilterMode = "INTERSECTS" | "DISJOINT" | "WITHIN" | "CONTAINS"; /** * Start reading from specific offsets for each partition. Useful for resuming from a known checkpoint or replaying from a specific point in time. * * Log Safety: SAFE */ declare interface SpecificPosition { offsets: PartitionOffsets; } /** * The format of a spreadsheet media item. * * Log Safety: SAFE */ declare type SpreadsheetDecodeFormat = "XLSX"; /** * Metadata for spreadsheet media items. * * Log Safety: UNSAFE */ declare interface SpreadsheetMediaItemMetadata { format: SpreadsheetDecodeFormat; sheetNames: Array; sizeBytes: number; title?: string; author?: string; } /** * The operation to perform for spreadsheet to text conversion. * * Log Safety: UNSAFE */ declare type SpreadsheetToTextOperation = { type: "convertSheetToJson"; } & ConvertSheetToJsonOperation; /** * Converts spreadsheet data to text/JSON. * * Log Safety: UNSAFE */ declare interface SpreadsheetToTextTransformation { operation: SpreadsheetToTextOperation; } export declare namespace SqlQueries { export { AnyColumnType, CanceledQueryStatus, ColumnType, DecimalColumnType, ExecuteOntologySqlQueryRequest, ExecuteSqlQueryRequest, FailedQueryStatus, ListColumnType, MapColumnType, MapParameterKey, NamedParameterMapping, ParameterAnyValue, ParameterBooleanValue, ParameterDateValue, ParameterDecimalValue, ParameterDoubleValue, ParameterFloatValue, ParameterIntegerValue, ParameterListValue, ParameterLongValue, ParameterMapping, ParameterMapValue, ParameterName_2 as ParameterName, ParameterNullValue, Parameters_2 as Parameters, ParameterShortValue, ParameterStringValue, ParameterStructValue, ParameterTimestampValue, ParameterValue_3 as ParameterValue, QueryStatus, RunningQueryStatus, ScenarioRid, SerializationFormat, SqlQuery, SqlQueryId, StructColumnFieldType, StructColumnType, StructElement, StructElementName, StructFieldKeyValue, StructFieldRid, SucceededQueryStatus, TableName_2 as TableName, UnnamedParameterValues, CancelSqlQueryPermissionDenied, ColumnTypesNotSupported_2 as ColumnTypesNotSupported, ExecuteOntologySqlQueryPermissionDenied, ExecuteSqlQueryPermissionDenied, GetResultsSqlQueryPermissionDenied, GetStatusSqlQueryPermissionDenied, OntologyObjectTypeNotFound, OntologyQueryFailed, OntologyQueryInvalidObjectBackend, OntologyQueryNestedObjectSetTooLarge, OntologyQueryStringColumnTooLong, QueryCanceled, QueryFailed, QueryParseError, QueryPermissionDenied, QueryRunning, ReadQueryInputsPermissionDenied, SqlQueries_2 as SqlQueries } } declare namespace _SqlQueries { export { LooselyBrandedString_21 as LooselyBrandedString, AnyColumnType, CanceledQueryStatus, ColumnType, DecimalColumnType, ExecuteOntologySqlQueryRequest, ExecuteSqlQueryRequest, FailedQueryStatus, ListColumnType, MapColumnType, MapParameterKey, NamedParameterMapping, ParameterAnyValue, ParameterBooleanValue, ParameterDateValue, ParameterDecimalValue, ParameterDoubleValue, ParameterFloatValue, ParameterIntegerValue, ParameterListValue, ParameterLongValue, ParameterMapping, ParameterMapValue, ParameterName_2 as ParameterName, ParameterNullValue, Parameters_2 as Parameters, ParameterShortValue, ParameterStringValue, ParameterStructValue, ParameterTimestampValue, ParameterValue_3 as ParameterValue, QueryStatus, RunningQueryStatus, ScenarioRid, SerializationFormat, SqlQuery, SqlQueryId, StructColumnFieldType, StructColumnType, StructElement, StructElementName, StructFieldKeyValue, StructFieldRid, SucceededQueryStatus, TableName_2 as TableName, UnnamedParameterValues } } export declare namespace SqlQueries_2 { export { execute_5 as execute, getStatus_2 as getStatus, cancel_4 as cancel, getResults } } /** * Log Safety: DO_NOT_LOG */ declare interface SqlQuery { id: SqlQueryId; } /** * The identifier of a SQL Query. * * Log Safety: DO_NOT_LOG */ declare type SqlQueryId = LooselyBrandedString_21<"SqlQueryId">; /** * @deprecated Use `StartsWithQuery` in the `foundry.ontologies` package * * Returns objects where the specified field starts with the provided value. * * Log Safety: UNSAFE */ declare interface StartsWithQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: string; } /** * Deprecated alias for containsAllTermsInOrderPrefixLastTerm, which is preferred because the name startsWith is misleading. Returns objects where the specified field starts with the provided value. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface StartsWithQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: string; } /** * Represents a static argument in a logic rule. * * Log Safety: UNSAFE */ declare interface StaticArgument { value: DataValue; } /** * A literal constraint value. * * Log Safety: UNSAFE */ declare interface StaticConstraintValue { value: DataValue; } /** * Returns action types with the given status. * * Log Safety: SAFE */ declare interface StatusActionTypesQueryV2 { value: ActionTypeStatusFilter; } /** * Log Safety: UNSAFE */ declare interface StatusCheckConfig { severity: SeverityLevel; escalationConfig?: EscalationConfig; } /** * Log Safety: UNSAFE */ declare interface Stream { branchName: _Core.BranchName; schema: _Core.StreamSchema; viewRid: ViewRid; partitionsCount: PartitionsCount; streamType: StreamType; compressed: Compressed; } /* Excluded from this release type: streamingContinue */ /** * Could not streamingContinue the Session. * * Log Safety: SAFE */ declare interface StreamingContinueSessionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "StreamingContinueSessionPermissionDenied"; errorDescription: "Could not streamingContinue the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface StreamingContinueSessionRequest { userInput: UserTextInput; parameterInputs: Record; contextsOverride?: Array; messageId?: MessageId; sessionTraceId?: SessionTraceId; } /* Excluded from this release type: streamingExecute */ /* Excluded from this release type: streamingExecuteEvents */ /** * Could not streamingExecuteEvents the Query. * * Log Safety: UNSAFE */ declare interface StreamingExecuteEventsQueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "StreamingExecuteEventsQueryPermissionDenied"; errorDescription: "Could not streamingExecuteEvents the Query."; errorInstanceId: string; parameters: { queryApiName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface StreamingExecuteEventsQueryRequest { ontology?: _Ontologies.OntologyIdentifier; parameters: Record; version?: FunctionVersion_2; branch?: _Core.FoundryBranch; latestVersionResolution?: LatestVersionResolution; includePrerelease?: IncludePrerelease; } /** * Could not streamingExecute the Query. * * Log Safety: UNSAFE */ declare interface StreamingExecuteQueryPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "StreamingExecuteQueryPermissionDenied"; errorDescription: "Could not streamingExecute the Query."; errorInstanceId: string; parameters: { queryApiName: unknown; }; } /** * Log Safety: UNSAFE */ declare interface StreamingExecuteQueryRequest { ontology?: _Ontologies.OntologyIdentifier; parameters: Record; version?: FunctionVersion_2; branch?: _Core.FoundryBranch; latestVersionResolution?: LatestVersionResolution; includePrerelease?: IncludePrerelease; } /** * A single message in a streaming Query execution response. Each message contains either a data batch or an error. * * Log Safety: UNSAFE */ declare type StreamingExecuteQueryResponse = ({ type: "data"; } & StreamingQueryData) | ({ type: "error"; } & StreamingQueryError); /** * Which format to serialize the binary stream in. ARROW is more efficient for streaming a large sized response. * * Log Safety: SAFE */ declare type StreamingOutputFormat = "JSON" | "ARROW"; /** * A batch of query results. * * Log Safety: UNSAFE */ declare interface StreamingQueryData { value: DataValue_2; } /** * An error that occurred during query execution. * * Log Safety: UNSAFE */ declare interface StreamingQueryError { errorCode: string; errorName: string; errorInstanceId: string; errorDescription?: string; parameters: Record; } /** * Log Safety: UNSAFE */ declare type StreamMessage = ({ type: "objectSetChanged"; } & ObjectSetUpdates) | ({ type: "refreshObjectSet"; } & RefreshObjectSet) | ({ type: "subscriptionClosed"; } & SubscriptionClosed) | ({ type: "subscribeResponses"; } & ObjectSetSubscribeResponses); /** * The given Stream could not be found. * * Log Safety: UNSAFE */ declare interface StreamNotFound { errorCode: "NOT_FOUND"; errorName: "StreamNotFound"; errorDescription: "The given Stream could not be found."; errorInstanceId: string; parameters: { datasetRid: unknown; streamBranchName: unknown; }; } /** * Stream all of the points of a time series property. * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints */ declare function streamPoints($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, property: _Ontologies_2.PropertyApiName, $body: _Ontologies_2.StreamTimeSeriesPointsRequest, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; format?: _Ontologies_2.StreamingOutputFormat | undefined; } ]): Promise; /** * The RID of a Foundry stream. * * Log Safety: SAFE */ declare type StreamRid = LooselyBrandedString_5<"StreamRid">; export declare namespace Streams { export { _Record_2 as _Record, CommitSubscriberOffsetsRequest, Compressed, CreateStreamingDatasetRequest, CreateStreamRequest, CreateStreamRequestChangeDataCaptureConfiguration, CreateStreamRequestFullRowChangeDataCaptureConfiguration, CreateStreamRequestStreamSchema, CreateSubscriberRequest, CreateSubscriberRequestEarliestPosition, CreateSubscriberRequestLatestPosition, CreateSubscriberRequestReadPosition, CreateSubscriberRequestSpecificPosition, Dataset_2 as Dataset, EarliestPosition, GetEndOffsetsResponse, GetRecordsResponse, LatestPosition, PartitionId, PartitionOffsets, PartitionRecords, PartitionsCount, PublishRecordsToStreamRequest, PublishRecordToStreamRequest, ReadPosition, ReadRecordsFromSubscriberRequest, ReadSubscriberRecordsResponse, RecordWithOffset, ResetStreamRequest, ResetSubscriberOffsetsRequest, SpecificPosition, Stream, StreamType, Subscriber, SubscriberId, ViewRid, CannotCreateStreamingDatasetInUserFolder, CannotWriteToTrashedStream, CommitSubscriberOffsetsPermissionDenied, CreateStreamingDatasetPermissionDenied, CreateStreamPermissionDenied, CreateSubscriberPermissionDenied, DeleteSubscriberPermissionDenied, FailedToProcessBinaryRecord, GetEndOffsetsForStreamPermissionDenied, GetRecordsFromStreamPermissionDenied, GetSubscriberReadPositionPermissionDenied, InvalidStreamNoSchema, InvalidStreamType, PublishBinaryRecordToStreamPermissionDenied, PublishRecordsToStreamPermissionDenied, PublishRecordToStreamPermissionDenied, ReadRecordsFromSubscriberPermissionDenied, RecordDoesNotMatchStreamSchema, RecordTooLarge, ResetStreamPermissionDenied, ResetSubscriberOffsetsPermissionDenied, StreamNotFound, SubscriberAlreadyExists, SubscriberNotFound, ViewNotFound_2 as ViewNotFound, Datasets_3 as Datasets, Streams_2 as Streams, Subscribers } } declare namespace _Streams { export { LooselyBrandedString_22 as LooselyBrandedString, CommitSubscriberOffsetsRequest, Compressed, CreateStreamingDatasetRequest, CreateStreamRequest, CreateStreamRequestChangeDataCaptureConfiguration, CreateStreamRequestFullRowChangeDataCaptureConfiguration, CreateStreamRequestStreamSchema, CreateSubscriberRequest, CreateSubscriberRequestEarliestPosition, CreateSubscriberRequestLatestPosition, CreateSubscriberRequestReadPosition, CreateSubscriberRequestSpecificPosition, Dataset_2 as Dataset, EarliestPosition, GetEndOffsetsResponse, GetRecordsResponse, LatestPosition, PartitionId, PartitionOffsets, PartitionRecords, PartitionsCount, PublishRecordsToStreamRequest, PublishRecordToStreamRequest, ReadPosition, ReadRecordsFromSubscriberRequest, ReadSubscriberRecordsResponse, _Record_2 as _Record, RecordWithOffset, ResetStreamRequest, ResetSubscriberOffsetsRequest, SpecificPosition, Stream, StreamType, Subscriber, SubscriberId, ViewRid } } export declare namespace Streams_2 { export { get_67 as get, publishRecord, publishRecords, publishBinaryRecord } } /** * The schema for a Foundry stream. Records pushed to this stream must match this schema. * * Log Safety: UNSAFE */ declare interface StreamSchema { fields: Array; keyFieldNames?: Array; changeDataCapture?: ChangeDataCaptureConfiguration; } /** * Log Safety: UNSAFE */ declare interface StreamTimeSeriesPointsRequest { range?: TimeRange; aggregate?: AggregateTimeSeries; } /** * Log Safety: UNSAFE */ declare interface StreamTimeSeriesPointsResponse { data: Array; } /** * Log Safety: UNSAFE */ declare interface StreamTimeSeriesValuesRequest { range?: TimeRange; } /** * Log Safety: UNSAFE */ declare interface StreamTimeSeriesValuesResponse { data: Array; } /** * LOW_LATENCY: The default stream type. Recommended for most use cases. HIGH_THROUGHPUT: Best for streams that send large amounts of data every second. Using this stream type might introduce some non-zero latency at the expense of a higher throughput. This stream type is only recommended if you inspect your stream metrics in-platform and observe that the average batch size is equal to the max match size, or if jobs using the stream are failing due to Kafka producer batches expiring. For additional information on inspecting stream metrics, refer to the stream monitoring documentation. For more information, refer to the stream types documentation. * * Log Safety: SAFE */ declare type StreamType = "LOW_LATENCY" | "HIGH_THROUGHPUT"; /** * Stream all of the points of a time series property (this includes geotime series references). * * @public * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamValues */ declare function streamValues($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ ontology: _Ontologies_2.OntologyIdentifier, objectType: _Ontologies_2.ObjectTypeApiName, primaryKey: _Ontologies_2.PropertyValueEscapedString, property: _Ontologies_2.PropertyApiName, $body: _Ontologies_2.StreamTimeSeriesValuesRequest, $queryParams?: { sdkPackageRid?: _Ontologies_2.SdkPackageRid | undefined; sdkVersion?: _Ontologies_2.SdkVersion | undefined; branch?: _Core.FoundryBranch | undefined; } ]): Promise; /** * The state for an incremental table import using a column with a string data type. * * Log Safety: UNSAFE */ declare interface StringColumnInitialIncrementalState { columnName: string; currentValue: string; } /** * A string column value. * * Log Safety: UNSAFE */ declare interface StringColumnValue { value: string; } /** * Log Safety: UNSAFE */ declare interface StringConstant { value: string; } /** * The parameter value must have a length within the defined range. This range is always inclusive. * * Log Safety: UNSAFE */ declare interface StringLengthConstraint { lt?: any; lte?: any; gt?: any; gte?: any; } /** * Log Safety: UNSAFE */ declare interface StringParameter { defaultValue?: string; } /** * A string parameter value. * * Log Safety: UNSAFE */ declare interface StringParameter_2 { value: string; } /** * A value passed for StringParameter application variable types. * * Log Safety: UNSAFE */ declare interface StringParameterValue { value: string; } /** * The parameter value must match a predefined regular expression. * * Log Safety: UNSAFE */ declare interface StringRegexMatchConstraint { regex: string; configuredFailureMessage?: string; } /** * A string value that was passed as input to a tool. * * Log Safety: UNSAFE */ declare interface StringToolInputValue { value: string; } /** * A string value that was returned from a tool. * * Log Safety: UNSAFE */ declare interface StringToolOutputValue { value: string; } /** * Log Safety: SAFE */ declare interface StringType { } /** * Log Safety: SAFE */ declare interface StringType_2 { } /** * Log Safety: UNSAFE */ declare interface StringValue { value: string; } /** * Log Safety: UNSAFE */ declare interface StructColumnFieldType { name: string; type: ColumnType; } /** * Log Safety: UNSAFE */ declare interface StructColumnType { fields: Array; } /** * Log Safety: UNSAFE */ declare interface StructConstraint { properties: Record; } /** * Log Safety: UNSAFE */ declare interface StructConstraint_2 { fields: Record; } /** * Represents an entry in a struct. * * Log Safety: UNSAFE */ declare interface StructElement { structElementName: StructElementName; structElementValue: ParameterValue_3; } /** * The name of a struct element. * * Log Safety: UNSAFE */ declare type StructElementName = ({ type: "structFieldRid"; } & StructFieldRid) | ({ type: "structFieldKey"; } & StructFieldKeyValue); /** * Represents the validity of a singleton struct parameter. * * Log Safety: UNSAFE */ declare interface StructEvaluatedConstraint { structFields: Record; } /** * @deprecated Use `StructFieldApiName` in the `foundry.ontologies` package * * The name of a struct field in the Ontology. * * Log Safety: UNSAFE */ declare type StructFieldApiName = LooselyBrandedString<"StructFieldApiName">; /** * The name of a struct field in the Ontology. * * Log Safety: UNSAFE */ declare type StructFieldApiName_2 = LooselyBrandedString_5<"StructFieldApiName">; /** * Log Safety: UNSAFE */ declare type StructFieldApiName_3 = LooselyBrandedString_9<"StructFieldApiName">; /** * Represents an argument used for an individual struct field. * * Log Safety: UNSAFE */ declare type StructFieldArgument = ({ type: "structListParameterFieldValue"; } & StructListParameterFieldArgument) | ({ type: "structParameterFieldValue"; } & StructParameterFieldArgument); /** * A constraint that an action struct parameter field value must satisfy in order to be considered valid. Constraints can be configured on fields of struct parameters in the Ontology Manager. Applicable constraints are determined dynamically based on parameter inputs. Parameter values are evaluated against the final set of constraints. The type of the constraint. | Type | Description | |-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | oneOf | The struct parameter field has a manually predefined set of options. | | range | The struct parameter field value must be within the defined range. | | stringLength | The struct parameter field value must have a length within the defined range. | | stringRegexMatch | The struct parameter field value must match a predefined regular expression. | | objectQueryResult | The struct parameter field value must be the primary key of an object found within an object set. | * * Log Safety: UNSAFE */ declare type StructFieldEvaluatedConstraint = ({ type: "oneOf"; } & OneOfConstraint) | ({ type: "range"; } & RangeConstraint) | ({ type: "objectQueryResult"; } & ObjectQueryResultConstraint) | ({ type: "stringLength"; } & StringLengthConstraint) | ({ type: "stringRegexMatch"; } & StringRegexMatchConstraint); /** * Represents the validity of a struct parameter's fields against the configured constraints. * * Log Safety: UNSAFE */ declare interface StructFieldEvaluationResult { result: ValidationResult; evaluatedConstraints: Array; required: boolean; } /** * A string key for a struct field. * * Log Safety: UNSAFE */ declare interface StructFieldKeyValue { value: string; } /** * The name of a field in a Struct. * * Log Safety: UNSAFE */ declare type StructFieldName = LooselyBrandedString<"StructFieldName">; /** * The name of a field in a Struct. * * Log Safety: UNSAFE */ declare type StructFieldName_2 = LooselyBrandedString_9<"StructFieldName">; /** * Log Safety: UNSAFE */ declare interface StructFieldOfPropertyImplementation { propertyApiName: PropertyApiName_2; structFieldApiName: StructFieldApiName_2; } /** * A single struct field's mapping where apiName is the name of a struct field. * * Log Safety: UNSAFE */ declare interface StructFieldPropertyMapping { apiName: StructFieldApiName_2; } /** * A unique identifier for a field of a struct property type. * * Log Safety: SAFE */ declare interface StructFieldRid { value: string; } /** * @deprecated Use `StructFieldSelector` in the `foundry.ontologies` package * * A combination of a struct property api name and a struct field api name. This is used to select struct fields to query on. Note that you can still select struct properties with only a 'PropertyApiNameSelector'; the queries will then become 'OR' queries across the fields of the struct property. * * Log Safety: UNSAFE */ declare interface StructFieldSelector { propertyApiName: PropertyApiName; structFieldApiName: StructFieldApiName; } /** * A combination of a property identifier and the load level to apply to the property. You can select a reduced value for arrays and the main value for structs. If the provided load level cannot be applied to the property type, then it will be ignored. This selector is experimental and may not work in filters or sorts. * * Log Safety: UNSAFE */ declare interface StructFieldSelector_2 { propertyApiName: PropertyApiName_2; structFieldApiName: StructFieldApiName_2; } /** * Log Safety: UNSAFE */ declare interface StructFieldType { subFields: Array; } /** * Log Safety: UNSAFE */ declare interface StructFieldType_2 { apiName: StructFieldApiName_2; rid: StructFieldTypeRid; dataType: ObjectPropertyType; typeClasses: Array; } /** * The unique resource identifier of a struct field, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type StructFieldTypeRid = LooselyBrandedString_5<"StructFieldTypeRid">; /** * Represents a struct list parameter field argument in a logic rule. * * Log Safety: UNSAFE */ declare interface StructListParameterFieldArgument { parameterId: ParameterId_2; structParameterFieldApiName: StructParameterFieldApiName; } /** * The unique identifier of the struct parameter field. * * Log Safety: UNSAFE */ declare type StructParameterFieldApiName = LooselyBrandedString_5<"StructParameterFieldApiName">; /** * Represents a struct parameter field argument in a logic rule. * * Log Safety: UNSAFE */ declare interface StructParameterFieldArgument { parameterId: ParameterId_2; structParameterFieldApiName: StructParameterFieldApiName; } /** * A mapping from the backing column struct field names to a struct property's fields. * * Log Safety: UNSAFE */ declare interface StructPropertyMapping { column: ColumnName_2; fields: Record<_Core.StructFieldName, StructFieldPropertyMapping>; } /** * Log Safety: UNSAFE */ declare interface StructType { structFieldTypes: Array; mainValue?: StructTypeMainValue; } /** * Log Safety: UNSAFE */ declare interface StructTypeMainValue { mainValueType: ObjectPropertyType; fields: Array; } /** * Log Safety: UNSAFE */ declare interface StructV1Constraint { fields: Record; } /** * Log Safety: UNSAFE */ declare interface StsRoleConfiguration { roleArn: string; roleSessionName: string; roleSessionDuration?: _Core.Duration; externalId?: string; stsEndpoint?: string; } /** * A stylesheet entrypoint to be loaded into the runtime environment. * * Log Safety: UNSAFE */ declare interface StylesheetEntrypoint { filePath: FilePath_2; } /** * A subdomain from which a website is served. * * Log Safety: SAFE */ declare type Subdomain = LooselyBrandedString_23<"Subdomain">; /** * Contains the status of the submission criteria. Submission criteria are the prerequisites that need to be satisfied before an Action can be applied. These are configured in the Ontology Manager. * * Log Safety: UNSAFE */ declare interface SubmissionCriteriaEvaluation { configuredFailureMessage?: string; result: ValidationResult; } /** * Log Safety: UNSAFE */ declare interface Subscriber { subscriberId: SubscriberId; readPosition?: ReadPosition; datasetRid: _Core.DatasetRid; branchName: _Core.BranchName; viewRid: ViewRid; startOffsets: PartitionOffsets; createdTime: _Core.CreatedTime; } /** * A subscriber with this ID already exists for a different stream. * * Log Safety: UNSAFE */ declare interface SubscriberAlreadyExists { errorCode: "CONFLICT"; errorName: "SubscriberAlreadyExists"; errorDescription: "A subscriber with this ID already exists for a different stream."; errorInstanceId: string; parameters: { subscriberId: unknown; existingDatasetRid: unknown; existingBranchName: unknown; }; } /** * A unique identifier for a stream subscriber. Must be unique within the scope of a stream. * * Log Safety: SAFE */ declare type SubscriberId = LooselyBrandedString_22<"SubscriberId">; /** * No subscriber with the given ID was found. * * Log Safety: SAFE */ declare interface SubscriberNotFound { errorCode: "NOT_FOUND"; errorName: "SubscriberNotFound"; errorDescription: "No subscriber with the given ID was found."; errorInstanceId: string; parameters: { subscriberId: unknown; }; } export declare namespace Subscribers { export { } } /** * The subscription has been closed due to an irrecoverable error during its lifecycle. * * Log Safety: UNSAFE */ declare interface SubscriptionClosed { id: SubscriptionId; cause: SubscriptionClosureCause; } /** * Log Safety: UNSAFE */ declare type SubscriptionClosureCause = ({ type: "reason"; } & Reason) | ({ type: "error"; } & Error_2); /** * Log Safety: UNSAFE */ declare interface SubscriptionError { errors: Array; } /** * A unique identifier used to associate subscription requests with responses. * * Log Safety: SAFE */ declare type SubscriptionId = string; /** * Log Safety: SAFE */ declare interface SubscriptionSuccess { id: SubscriptionId; } /** * Subtracts the right numeric value from the left numeric value. * * Log Safety: UNSAFE */ declare interface SubtractPropertyExpression { left: DerivedPropertyDefinition; right: DerivedPropertyDefinition; } /** * The query execution completed successfully. * * Log Safety: UNSAFE */ declare interface SucceededExecution { value: DataValue_2; } /** * Log Safety: DO_NOT_LOG */ declare interface SucceededQueryStatus { queryId: SqlQueryId; } /** * The successful output of a tool call. * * Log Safety: UNSAFE */ declare interface SuccessToolCallOutput { output: ToolOutputValue; } /** * Computes the sum of values for the provided field. * * Log Safety: UNSAFE */ declare interface SumAggregation { field: FieldNameV1; name?: AggregationMetricName; } /** * Computes the sum of values for the provided field. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface SumAggregationV2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; name?: AggregationMetricName; direction?: OrderByDirection_2; } /** * A summary metric with series name, aggregation type, and computed value. * * Log Safety: UNSAFE */ declare interface SummaryMetric { seriesName: SeriesName; aggregation: SummaryMetricAggregation; value: number; } /** * The type of aggregation computed for a summary metric. * * Log Safety: SAFE */ declare type SummaryMetricAggregation = "MIN" | "MAX" | "LAST"; declare const symbolClientContext: "__osdkClientContext"; declare const symbolClientContext_2: unique symbol; /** * Log Safety: UNSAFE */ declare interface SyncApplyActionResponseV2 { operationId?: string; validation?: ValidateActionResponseV2; edits?: ActionResults; } /** * Represents a synchronous webhook output argument in a logic rule. * * Log Safety: UNSAFE */ declare interface SynchronousWebhookOutputArgument { webhookOutputParamName: string; } /** * Details about a table artifact. * * Log Safety: SAFE */ declare interface TableArtifactDetails { rowCount: string; } /** * Format for tabular dataset export. * * Log Safety: SAFE */ declare type TableExportFormat = "ARROW" | "CSV"; /** * Log Safety: UNSAFE */ declare interface TableImport { rid: TableImportRid; connectionRid: ConnectionRid; datasetRid: _Core.DatasetRid; branchName?: _Core.BranchName; displayName: TableImportDisplayName; importMode: TableImportMode; allowSchemaChanges: TableImportAllowSchemaChanges; config: TableImportConfig; } /** * Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports. * * Log Safety: SAFE */ declare type TableImportAllowSchemaChanges = boolean; /** * The import configuration for a specific connector type. * * Log Safety: UNSAFE */ declare type TableImportConfig = ({ type: "databricksImportConfig"; } & DatabricksTableImportConfig) | ({ type: "jdbcImportConfig"; } & JdbcTableImportConfig) | ({ type: "microsoftSqlServerImportConfig"; } & MicrosoftSqlServerTableImportConfig) | ({ type: "postgreSqlImportConfig"; } & PostgreSqlTableImportConfig) | ({ type: "microsoftAccessImportConfig"; } & MicrosoftAccessTableImportConfig) | ({ type: "snowflakeImportConfig"; } & SnowflakeTableImportConfig) | ({ type: "oracleImportConfig"; } & OracleTableImportConfig); /** * Log Safety: UNSAFE */ declare type TableImportDisplayName = LooselyBrandedString_12<"TableImportDisplayName">; /** * The incremental configuration for a table import enables append-style transactions from the same table without duplication of data. You must provide a monotonically increasing column such as a timestamp or id and an initial value for this column. An incremental table import will import rows where the value is greater than the largest already imported. You can use the '?' character to reference the incremental state value when constructing your query. Normally this would be used in a WHERE clause or similar filter applied in order to only sync data with an incremental column value larger than the previously observed maximum value stored in the incremental state. * * Log Safety: UNSAFE */ declare type TableImportInitialIncrementalState = ({ type: "stringColumnInitialIncrementalState"; } & StringColumnInitialIncrementalState) | ({ type: "dateColumnInitialIncrementalState"; } & DateColumnInitialIncrementalState) | ({ type: "integerColumnInitialIncrementalState"; } & IntegerColumnInitialIncrementalState) | ({ type: "timestampColumnInitialIncrementalState"; } & TimestampColumnInitialIncrementalState) | ({ type: "longColumnInitialIncrementalState"; } & LongColumnInitialIncrementalState) | ({ type: "decimalColumnInitialIncrementalState"; } & DecimalColumnInitialIncrementalState); /** * Import mode governs how data is read from an external system, and written into a Foundry dataset. SNAPSHOT: Defines a new dataset state consisting only of data from a particular import execution. APPEND: Purely additive and yields data from previous import executions in addition to newly added data. * * Log Safety: SAFE */ declare type TableImportMode = "SNAPSHOT" | "APPEND"; /** * The given TableImport could not be found. * * Log Safety: SAFE */ declare interface TableImportNotFound { errorCode: "NOT_FOUND"; errorName: "TableImportNotFound"; errorDescription: "The given TableImport could not be found."; errorInstanceId: string; parameters: { tableImportRid: unknown; connectionRid: unknown; }; } /** * The specified connection does not support creating or replacing a table import with the specified config. * * Log Safety: UNSAFE */ declare interface TableImportNotSupportedForConnection { errorCode: "INVALID_ARGUMENT"; errorName: "TableImportNotSupportedForConnection"; errorDescription: "The specified connection does not support creating or replacing a table import with the specified config."; errorInstanceId: string; parameters: { connectionRid: unknown; tableImportType: unknown; }; } /** * A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. * * Log Safety: UNSAFE */ declare type TableImportQuery = LooselyBrandedString_12<"TableImportQuery">; /** * The Resource Identifier (RID) of a TableImport (also known as a batch sync). * * Log Safety: SAFE */ declare type TableImportRid = LooselyBrandedString_12<"TableImportRid">; export declare namespace TableImports { export { create_16 as create, deleteTableImport, list_32 as list, get_46 as get, replace_13 as replace, execute_4 as execute } } /** * The specified table import type is not yet supported in the Platform API. * * Log Safety: UNSAFE */ declare interface TableImportTypeNotSupported { errorCode: "INTERNAL"; errorName: "TableImportTypeNotSupported"; errorDescription: "The specified table import type is not yet supported in the Platform API."; errorInstanceId: string; parameters: { tableImportType: unknown; }; } /** * The name of a VirtualTable. * * Log Safety: UNSAFE */ declare type TableName = LooselyBrandedString_12<"TableName">; /** * The name of a SQL query table. * * Log Safety: UNSAFE */ declare type TableName_2 = LooselyBrandedString_21<"TableName">; /** * The Resource Identifier (RID) of a Table. * * Log Safety: SAFE */ declare type TableRid = LooselyBrandedString<"TableRid">; /** * The RID of a Foundry table. * * Log Safety: SAFE */ declare type TableRid_2 = LooselyBrandedString_5<"TableRid">; /** * The Resource Identifier (RID) of a registered VirtualTable. * * Log Safety: SAFE */ declare type TableRid_3 = LooselyBrandedString_12<"TableRid">; /** * Trigger whenever a new transaction is committed to the table on the target branch. * * Log Safety: UNSAFE */ declare interface TableUpdatedTrigger { tableRid: _Core.TableRid; branchName: _Core.BranchName; } /** * At least one of the provided tag RIDs could not be found. * * Log Safety: SAFE */ declare interface TagNotFound { errorCode: "NOT_FOUND"; errorName: "TagNotFound"; errorDescription: "At least one of the provided tag RIDs could not be found."; errorInstanceId: string; parameters: { tagRids: unknown; }; } /** * The unique resource identifier (RID) of a Tag. * * Log Safety: SAFE */ declare type TagRid = LooselyBrandedString_7<"TagRid">; /** * TAR archive format. * * Log Safety: SAFE */ declare interface TarFormat { } /** * The schedule target is not supported. The schedule target must be either a connecting target, upstream target or list of single dataset targets. * * Log Safety: SAFE */ declare interface TargetNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "TargetNotSupported"; errorDescription: "The schedule target is not supported. The schedule target must be either a connecting target, upstream target or list of single dataset targets."; errorInstanceId: string; parameters: { scheduleRid: unknown; }; } /** * Log Safety: SAFE */ declare interface Template { rid: TemplateRid; } /** * Creating the project from template would attempt to create new groups with names conflicting either with other new groups, or existing groups. * * Log Safety: UNSAFE */ declare interface TemplateGroupNameConflict { errorCode: "CONFLICT"; errorName: "TemplateGroupNameConflict"; errorDescription: "Creating the project from template would attempt to create new groups with names conflicting either with other new groups, or existing groups."; errorInstanceId: string; parameters: { conflictingGroupNames: unknown; }; } /** * Creating the project from template would attempt to create new markings with names conflicting either with other new markings, or existing markings. * * Log Safety: UNSAFE */ declare interface TemplateMarkingNameConflict { errorCode: "CONFLICT"; errorName: "TemplateMarkingNameConflict"; errorDescription: "Creating the project from template would attempt to create new markings with names conflicting either with other new markings, or existing markings."; errorInstanceId: string; parameters: { conflictingMarkingNames: unknown; }; } /** * The requested template was not found. * * Log Safety: SAFE */ declare interface TemplateNotFound { errorCode: "NOT_FOUND"; errorName: "TemplateNotFound"; errorDescription: "The requested template was not found."; errorInstanceId: string; parameters: { templateRid: unknown; }; } /** * DateTime parameter value * * Log Safety: UNSAFE */ declare interface TemplateParameterDateTimeValue { timestamp: string; timezone: _Core.ZoneId; } /** * Date parameter value * * Log Safety: UNSAFE */ declare interface TemplateParameterDateValue { value: string; } /** * Double parameter value * * Log Safety: UNSAFE */ declare interface TemplateParameterDoubleValue { value: number; } /** * The name of a Template parameter * * Log Safety: UNSAFE */ declare type TemplateParameterName = LooselyBrandedString_17<"TemplateParameterName">; /** * Object RID parameter value * * Log Safety: SAFE */ declare interface TemplateParameterObjectRidValue { value: _Ontologies.ObjectRid; } /** * Object set RID parameter value * * Log Safety: SAFE */ declare interface TemplateParameterObjectSetRidValue { value: _Ontologies.ObjectSetRid; } /** * String parameter value * * Log Safety: UNSAFE */ declare interface TemplateParameterStringValue { value: string; } /** * A value for a template parameter * * Log Safety: UNSAFE */ declare type TemplateParameterValue = ({ type: "objectSetRid"; } & TemplateParameterObjectSetRidValue) | ({ type: "date"; } & TemplateParameterDateValue) | ({ type: "dateTime"; } & TemplateParameterDateTimeValue) | ({ type: "string"; } & TemplateParameterStringValue) | ({ type: "double"; } & TemplateParameterDoubleValue) | ({ type: "objectRid"; } & TemplateParameterObjectRidValue); /** * The unique identifier for a Template * * Log Safety: SAFE */ declare type TemplateRid = LooselyBrandedString_17<"TemplateRid">; export declare namespace Templates { export { } } /** * The version number of a Template * * Log Safety: SAFE */ declare type TemplateVersion = string; /** * Insufficient permissions to use this endpoint. This may be because that you are using a custom client instead of an official Palantir client library. If so, please try again using OSDK, Python Functions, or TypeScript Functions V2. * * Log Safety: SAFE */ declare interface TemporaryMediaUploadInsufficientPermissions { errorCode: "PERMISSION_DENIED"; errorName: "TemporaryMediaUploadInsufficientPermissions"; errorDescription: "Insufficient permissions to use this endpoint. This may be because that you are using a custom client instead of an official Palantir client library. If so, please try again using OSDK, Python Functions, or TypeScript Functions V2."; errorInstanceId: string; parameters: {}; } /** * An unknown error occurred, please try again, and if this continues please contact your Palantir representative. * * Log Safety: SAFE */ declare interface TemporaryMediaUploadUnknownFailure { errorCode: "INTERNAL"; errorName: "TemporaryMediaUploadUnknownFailure"; errorDescription: "An unknown error occurred, please try again, and if this continues please contact your Palantir representative."; errorInstanceId: string; parameters: {}; } /** * The parameter value (a string) must satisfy the configured length bounds and/or regex pattern. * * Log Safety: UNSAFE */ declare interface TextAllowedValues { gte?: number; lte?: number; regex?: string; configuredFailureMessage?: string; } /** * Log Safety: SAFE */ declare type TextLength = number; /** * Format in which to return extracted text. * * Log Safety: SAFE */ declare type TextOutputFormat = "TEXT" | "MARKDOWN" | "HTML"; /** * Log Safety: SAFE */ declare interface ThirdPartyApplication { rid: ThirdPartyApplicationRid; } /** * The given ThirdPartyApplication could not be found. * * Log Safety: SAFE */ declare interface ThirdPartyApplicationNotFound { errorCode: "NOT_FOUND"; errorName: "ThirdPartyApplicationNotFound"; errorDescription: "The given ThirdPartyApplication could not be found."; errorInstanceId: string; parameters: { thirdPartyApplicationRid: unknown; }; } /** * An RID identifying a third-party application created in Developer Console. * * Log Safety: SAFE */ declare type ThirdPartyApplicationRid = LooselyBrandedString_23<"ThirdPartyApplicationRid">; export declare namespace ThirdPartyApplications { export { DeployWebsiteRequest, ListVersionsResponse, Subdomain, ThirdPartyApplication, ThirdPartyApplicationRid, Version, VersionVersion, Website, CannotDeleteDeployedVersion, DeleteVersionPermissionDenied, DeployWebsitePermissionDenied, FileCountLimitExceeded, FileSizeLimitExceeded_2 as FileSizeLimitExceeded, InvalidVersion, ScanningErrored, ScanningInProgress, SiteAssetHasVulnerabilities, ThirdPartyApplicationNotFound, UndeployWebsitePermissionDenied, UploadSnapshotVersionPermissionDenied, UploadVersionPermissionDenied, VersionAlreadyExists, VersionLimitExceeded, VersionNotFound, WebsiteNotFound, ThirdPartyApplications_2 as ThirdPartyApplications, Versions, Websites } } declare namespace _ThirdPartyApplications { export { LooselyBrandedString_23 as LooselyBrandedString, DeployWebsiteRequest, ListVersionsResponse, Subdomain, ThirdPartyApplication, ThirdPartyApplicationRid, Version, VersionVersion, Website } } export declare namespace ThirdPartyApplications_2 { export { } } /** * The specified thread count exceeds the maximum allowed value. * * Log Safety: SAFE */ declare interface ThreadCountTooHigh { errorCode: "INVALID_ARGUMENT"; errorName: "ThreadCountTooHigh"; errorDescription: "The specified thread count exceeds the maximum allowed value."; errorInstanceId: string; parameters: { maxThreadCount: unknown; providedThreadCount: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ThreeDimensionalAggregation { keyType: QueryAggregationKeyType; valueType: TwoDimensionalAggregation; } /** * Log Safety: SAFE */ declare interface ThreeDimensionalAggregation_2 { keyType: QueryAggregationKeyType_2; valueType: TwoDimensionalAggregation_2; } /** * TIFF image format. * * Log Safety: SAFE */ declare interface TiffFormat { } /** * Generates Slippy map tiles (EPSG 3857) from a geo-embedded image. Only supported for geo-embedded TIFF and NITF images with at most 100M square pixels. * * Log Safety: UNSAFE */ declare interface TileImageOperation { zoom: number; x: number; y: number; } /** * The configuration for the range of time between which the health check is expected to succeed. * * Log Safety: SAFE */ declare interface TimeBounds { lowerBoundInSeconds?: string; upperBoundInSeconds?: string; } /** * Configuration for time bounds check with severity settings. * * Log Safety: SAFE */ declare interface TimeBoundsConfig { timeBounds: TimeBounds; severity: SeverityLevel; } /** * Log Safety: SAFE */ declare interface TimeCheckConfig { timeBounds?: TimeBoundsConfig; medianDeviation?: MedianDeviationConfig; } /** * Formats the duration in a timecode format. * * Log Safety: SAFE */ declare interface TimeCodeFormat { } /** * An absolute or relative range for a time series query. * * Log Safety: UNSAFE */ declare type TimeRange = ({ type: "absolute"; } & AbsoluteTimeRange) | ({ type: "relative"; } & RelativeTimeRange); /** * The aggregation function to use for aggregating time series data. * * Log Safety: SAFE */ declare type TimeSeriesAggregationMethod = "SUM" | "MEAN" | "STANDARD_DEVIATION" | "MAX" | "MIN" | "PERCENT_CHANGE" | "DIFFERENCE" | "PRODUCT" | "COUNT" | "FIRST" | "LAST"; /** * CUMULATIVE aggregates all points up to the current point. ROLLING aggregates all points in a rolling window whose size is either the specified number of points or time duration. PERIODIC aggregates all points in specified time windows. * * Log Safety: UNSAFE */ declare type TimeSeriesAggregationStrategy = ({ type: "rolling"; } & TimeSeriesRollingAggregate) | ({ type: "periodic"; } & TimeSeriesPeriodicAggregate) | ({ type: "cumulative"; } & TimeSeriesCumulativeAggregate); /** * The cumulative aggregate is calculated progressively for each point in the input time series, considering all preceding points up to and including the current point. * * Log Safety: SAFE */ declare interface TimeSeriesCumulativeAggregate { } /** * A time and value pair. * * Log Safety: UNSAFE */ declare interface TimeseriesEntry { time: string; value: any; } /** * A union of the types supported by time series properties. * * Log Safety: UNSAFE */ declare type TimeSeriesItemType = ({ type: "string"; } & StringType) | ({ type: "double"; } & DoubleType) | ({ type: "numericOrNonNumeric"; } & NumericOrNonNumericType); /** * Aggregates values over discrete, periodic windows for a given time series. A periodic window divides the time series into windows of fixed durations. For each window, an aggregate function is applied to the points within that window. The result is a time series with values representing the aggregate for each window. Windows with no data points are not included in the output. Periodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as hourly, daily, monthly. * * Log Safety: SAFE */ declare interface TimeSeriesPeriodicAggregate { windowSize: PreciseDuration; alignmentTimestamp?: string; windowType: TimeSeriesWindowType; } /** * A time and value pair. * * Log Safety: UNSAFE */ declare interface TimeSeriesPoint { time: string; value: any; } export declare namespace TimeSeriesPropertiesV2 { export { getFirstPoint, getLastPoint, streamPoints } } /** * Log Safety: UNSAFE */ declare type TimeSeriesPropertyV2 = LooselyBrandedString_5<"TimeSeriesPropertyV2">; /** * Log Safety: UNSAFE */ declare interface TimeSeriesRollingAggregate { windowSize: TimeSeriesRollingAggregateWindow; } /** * A rolling window is a moving subset of data points that ends at the current timestamp (inclusive) and spans a specified duration (window size). As new data points are added, old points fall out of the window if they are outside the specified duration. Rolling windows are commonly used for smoothing data, detecting trends, and reducing noise in time series analysis. * * Log Safety: UNSAFE */ declare type TimeSeriesRollingAggregateWindow = ({ type: "duration"; } & PreciseDuration) | ({ type: "pointsCount"; } & RollingAggregateWindowPoints); /** * The RID identifying a time series sync. * * Log Safety: SAFE */ declare type TimeseriesSyncRid = LooselyBrandedString_5<"TimeseriesSyncRid">; /** * The RID identifying a time series codex template that resolves to a derived series. * * Log Safety: SAFE */ declare type TimeseriesTemplateRid = LooselyBrandedString_5<"TimeseriesTemplateRid">; /** * The version corresponding to a codex template. * * Log Safety: UNSAFE */ declare type TimeseriesTemplateVersion = LooselyBrandedString_5<"TimeseriesTemplateVersion">; /** * Log Safety: UNSAFE */ declare interface TimeseriesType { itemType: TimeSeriesItemType; } export declare namespace TimeSeriesValueBankProperties { export { getLatestValue, streamValues } } /** * Log Safety: UNSAFE */ declare type TimeSeriesValueBankProperty = LooselyBrandedString_5<"TimeSeriesValueBankProperty">; /** * Log Safety: SAFE */ declare type TimeSeriesWindowType = "START" | "END"; /** * Checks the total time since the dataset has updated. * * Log Safety: UNSAFE */ declare interface TimeSinceLastUpdatedCheckConfig { subject: DatasetSubject; timeCheckConfig: TransactionTimeCheckConfig; } /** * Log Safety: UNSAFE */ declare interface TimestampColumnInitialIncrementalState { columnName: string; currentValue: string; } /** * Log Safety: SAFE */ declare interface TimestampType { } /** * Log Safety: SAFE */ declare interface TimestampType_2 { } /** * Log Safety: UNSAFE */ declare interface TimestampValue { value: string; } /** * Trigger on a time based schedule. * * Log Safety: SAFE */ declare interface TimeTrigger { cronExpression: CronExpression; timeZone: _Core.ZoneId; } /** * Log Safety: SAFE */ declare type TimeUnit = "MILLISECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS"; /** * Log Safety: SAFE */ declare type TimeUnit_2 = "MILLISECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "QUARTERS"; /** * Specifies the title property of an object type which is present on all object types. * * Log Safety: SAFE */ declare interface TitlePropertySelector { } /** * A tool call with its input and output. * * Log Safety: UNSAFE */ declare interface ToolCall { toolMetadata: ToolMetadata; input: ToolCallInput; output?: ToolCallOutput; } /** * List of tool calls that were triggered at the same point in the trace for the agent response generation. * * Log Safety: UNSAFE */ declare interface ToolCallGroup { toolCalls: Array; } /** * Input parameters for a tool call. * * Log Safety: UNSAFE */ declare interface ToolCallInput { thought?: string; inputs: Record; } /** * The output of a tool call. * * Log Safety: UNSAFE */ declare type ToolCallOutput = ({ type: "success"; } & SuccessToolCallOutput) | ({ type: "failure"; } & FailureToolCallOutput); /** * The name of a tool input parameter. * * Log Safety: UNSAFE */ declare type ToolInputName = LooselyBrandedString_4<"ToolInputName">; /** * A tool input value, which can be either a string or a Resource Identifier (RID). * * Log Safety: UNSAFE */ declare type ToolInputValue = ({ type: "string"; } & StringToolInputValue) | ({ type: "rid"; } & RidToolInputValue); /** * Details about the used tool. * * Log Safety: UNSAFE */ declare interface ToolMetadata { name: string; type: ToolType; } /** * A tool output value, which can be either a string or a Resource Identifier (RID). * * Log Safety: UNSAFE */ declare type ToolOutputValue = ({ type: "string"; } & StringToolOutputValue) | ({ type: "rid"; } & RidToolOutputValue); /** * Log Safety: SAFE */ declare type ToolType = "FUNCTION" | "ACTION" | "ONTOLOGY_SEMANTIC_SEARCH" | "OBJECT_QUERY" | "UPDATE_APPLICATION_VARIABLE" | "REQUEST_CLARIFICATION" | "OBJECT_QUERY_WITH_SQL" | "CODE_EXECUTION"; /** * The value of numNeighbors must be in the range 1 <= numNeighbors <= 500. * * Log Safety: SAFE */ declare interface TooManyNearestNeighborsRequested { errorCode: "INVALID_ARGUMENT"; errorName: "TooManyNearestNeighborsRequested"; errorDescription: "The value of numNeighbors must be in the range 1 <= numNeighbors <= 500."; errorInstanceId: string; parameters: { requestedNumNeighbors: unknown; maxNumNeighbors: unknown; }; } /** * Checks the total number of columns in the dataset. * * Log Safety: UNSAFE */ declare interface TotalColumnCountCheckConfig { subject: DatasetSubject; columnCountConfig: ColumnCountConfig; } /** * The total number of items across all pages. * * Log Safety: SAFE */ declare type TotalCount = string; /** * The W3C Trace Context traceparent header value used to propagate distributed tracing information for Foundry telemetry. See https://www.w3.org/TR/trace-context/#traceparent-header for more details. Note the 16 byte trace ID encoded in the header must be derived from a time based uuid to be used within Foundry. * * Log Safety: SAFE */ declare type TraceParent = LooselyBrandedString<"TraceParent">; /** * The W3C Trace Context tracestate header value, which is used to propagate vendor specific distributed tracing information for Foundry telemetry. See https://www.w3.org/TR/trace-context/#tracestate-header for more details. * * Log Safety: SAFE */ declare type TraceState = LooselyBrandedString<"TraceState">; /** * Log Safety: SAFE */ declare interface TrackedTransformationFailedResponse { } /** * Log Safety: SAFE */ declare interface TrackedTransformationPendingResponse { } /** * Log Safety: UNSAFE */ declare type TrackedTransformationResponse = ({ type: "pending"; } & TrackedTransformationPendingResponse) | ({ type: "failed"; } & TrackedTransformationFailedResponse) | ({ type: "successful"; } & TrackedTransformationSuccessfulResponse); /** * Log Safety: SAFE */ declare interface TrackedTransformationSuccessfulResponse { } /** * Description of what a trainer does and its capabilities. * * Log Safety: UNSAFE */ declare type TrainerDescription = LooselyBrandedString_15<"TrainerDescription">; /** * The Resource Identifier (RID) of a trainer. * * Log Safety: SAFE */ declare type TrainerId = LooselyBrandedString_15<"TrainerId">; /** * Specification of the inputs required by a trainer. When creating a ModelStudioConfigVersion, the workerConfig.inputs must conform to this specification, providing entries for each required input defined here. * * Log Safety: UNSAFE */ declare type TrainerInputsSpecification = any; /** * Human-readable name of a trainer. * * Log Safety: UNSAFE */ declare type TrainerName = LooselyBrandedString_15<"TrainerName">; /** * The specified trainer does not exist. * * Log Safety: SAFE */ declare interface TrainerNotFound { errorCode: "NOT_FOUND"; errorName: "TrainerNotFound"; errorDescription: "The specified trainer does not exist."; errorInstanceId: string; parameters: { trainerId: unknown; }; } /** * Specification of the outputs produced by a trainer. When creating a ModelStudioConfigVersion, the workerConfig.outputs must conform to this specification, providing entries for each required output defined here. * * Log Safety: UNSAFE */ declare type TrainerOutputsSpecification = any; /** * JSON schema defining the custom configuration parameters for a trainer. * * Log Safety: UNSAFE */ declare type TrainerSchemaDefinition = any; /** * The category of machine learning task a trainer is designed to solve. This determines the kind of modeling problem the trainer addresses and the shape of the inputs and outputs it expects. * * Log Safety: SAFE */ declare type TrainerType = "GENERIC" | "TIME_SERIES" | "TABULAR_REGRESSION" | "TABULAR_CLASSIFICATION" | "LLM_FINETUNING" | "VLM_FINETUNING"; /** * A specific version identifier for a trainer. * * Log Safety: SAFE */ declare type TrainerVersion = LooselyBrandedString_15<"TrainerVersion">; /** * Identifies a specific version of a trainer. * * Log Safety: SAFE */ declare interface TrainerVersionLocator { trainerId: TrainerId; version: string; } /** * Log Safety: UNSAFE */ declare interface Transaction { rid: TransactionRid; transactionType: TransactionType; status: TransactionStatus; createdTime: TransactionCreatedTime; closedTime?: string; } /** * Log Safety: SAFE */ declare interface TransactionalMediaSetJobOutput { mediaSetRid: _Core.MediaSetRid; transactionId?: string; } /** * The timestamp when the transaction was created, in ISO 8601 timestamp format. * * Log Safety: UNSAFE */ declare type TransactionCreatedTime = string; /** * Log Safety: UNSAFE */ declare type TransactionEdit = ({ type: "modifyObject"; } & ModifyObjectEdit) | ({ type: "deleteObject"; } & DeleteObjectEdit) | ({ type: "addObject"; } & AddObjectEdit) | ({ type: "removeLink"; } & DeleteLinkEdit) | ({ type: "addLink"; } & AddLinkEdit); /** * The ID identifying a transaction. * * Log Safety: SAFE */ declare type TransactionId = LooselyBrandedString_9<"TransactionId">; /** * An identifier which represents a transaction on a media set. * * Log Safety: SAFE */ declare type TransactionId_2 = string; /** * The given transaction has not been committed. * * Log Safety: SAFE */ declare interface TransactionNotCommitted { errorCode: "INVALID_ARGUMENT"; errorName: "TransactionNotCommitted"; errorDescription: "The given transaction has not been committed."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; transactionStatus: unknown; }; } /** * The requested transaction could not be found on the dataset, or the client token does not have access to it. * * Log Safety: SAFE */ declare interface TransactionNotFound { errorCode: "NOT_FOUND"; errorName: "TransactionNotFound"; errorDescription: "The requested transaction could not be found on the dataset, or the client token does not have access to it."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; }; } /** * The given transaction is not open. * * Log Safety: SAFE */ declare interface TransactionNotOpen { errorCode: "INVALID_ARGUMENT"; errorName: "TransactionNotOpen"; errorDescription: "The given transaction is not open."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; transactionStatus: unknown; }; } /** * The transaction policy for a media set, determining how writes are handled. * * Log Safety: UNSAFE */ declare type TransactionPolicy = ({ type: "batchTransactions"; } & BatchTransactionsTransactionPolicy) | ({ type: "noTransactions"; } & NoTransactionsTransactionPolicy); /** * The Resource Identifier (RID) of a Transaction. * * Log Safety: SAFE */ declare type TransactionRid = LooselyBrandedString_6<"TransactionRid">; export declare namespace Transactions { export { create_11 as create, get_23 as get, commit, abort } } /* Excluded from this release type: transactions */ /* Excluded from this release type: transactions_2 */ /** * The status of a Transaction. * * Log Safety: SAFE */ declare type TransactionStatus = "ABORTED" | "COMMITTED" | "OPEN"; /** * Defines the configuration of a transaction-based time check. * * Log Safety: SAFE */ declare interface TransactionTimeCheckConfig { timeBounds?: TimeBoundsConfig; medianDeviation?: MedianDeviationConfig; ignoreEmptyTransactions?: IgnoreEmptyTransactions; } /** * The type of a Transaction. * * Log Safety: SAFE */ declare type TransactionType = "APPEND" | "UPDATE" | "SNAPSHOT" | "DELETE"; /** * Encodes video to the specified format. * * Log Safety: SAFE */ declare interface TranscodeOperation { } /** * JSON transcription output format. * * Log Safety: SAFE */ declare interface TranscribeJson { } /** * Transcribes speech in audio to text. * * Log Safety: UNSAFE */ declare interface TranscribeOperation { language?: TranscriptionLanguage; diarize?: boolean; outputFormat?: TranscribeTextEncodeFormat; performanceMode?: PerformanceMode; } /** * The output format for transcription results. * * Log Safety: UNSAFE */ declare type TranscribeTextEncodeFormat = ({ type: "plainTextNoSegmentData"; } & PlainTextNoSegmentData) | ({ type: "json"; } & TranscribeJson) | ({ type: "pttml"; } & Pttml); /** * Language codes for audio transcription. If not specified, the language will be auto-detected from the first 30 seconds of audio. * * Log Safety: SAFE */ declare type TranscriptionLanguage = "AF" | "AM" | "AR" | "AS" | "AZ" | "BA" | "BE" | "BG" | "BN" | "BO" | "BR" | "BS" | "CA" | "CS" | "CY" | "DA" | "DE" | "EL" | "EN" | "ES" | "ET" | "EU" | "FA" | "FI" | "FO" | "FR" | "GL" | "GU" | "HA" | "HAW" | "HE" | "HI" | "HR" | "HT" | "HU" | "HY" | "ID" | "IS" | "IT" | "JA" | "JW" | "KA" | "KK" | "KM" | "KN" | "KO" | "LA" | "LB" | "LN" | "LO" | "LT" | "LV" | "MG" | "MI" | "MK" | "ML" | "MN" | "MR" | "MS" | "MT" | "MY" | "NE" | "NL" | "NN" | "NO" | "OC" | "PA" | "PL" | "PS" | "PT" | "RO" | "RU" | "SA" | "SD" | "SI" | "SK" | "SL" | "SN" | "SO" | "SQ" | "SR" | "SU" | "SV" | "SW" | "TA" | "TE" | "TG" | "TH" | "TK" | "TL" | "TR" | "TT" | "UK" | "UR" | "UZ" | "VI" | "YI" | "YO" | "YUE" | "ZH" | "AFRIKAANS" | "ALBANIAN" | "AMHARIC" | "ARABIC" | "ARMENIAN" | "ASSAMESE" | "AZERBAIJANI" | "BASHKIR" | "BASQUE" | "BELARUSIAN" | "BENGALI" | "BOSNIAN" | "BRETON" | "BULGARIAN" | "BURMESE" | "CANTONESE" | "CASTILIAN" | "CATALAN" | "CHINESE" | "CROATIAN" | "CZECH" | "DANISH" | "DUTCH" | "ENGLISH" | "ESTONIAN" | "FAROESE" | "FINNISH" | "FLEMISH" | "FRENCH" | "GALICIAN" | "GEORGIAN" | "GERMAN" | "GREEK" | "GUJARATI" | "HAITIAN" | "HAITIAN_CREOLE" | "HAUSA" | "HAWAIIAN" | "HEBREW" | "HINDI" | "HUNGARIAN" | "ICELANDIC" | "INDONESIAN" | "ITALIAN" | "JAPANESE" | "JAVANESE" | "KANNADA" | "KAZAKH" | "KHMER" | "KOREAN" | "LAO" | "LATIN" | "LATVIAN" | "LETZEBURGESCH" | "LINGALA" | "LITHUANIAN" | "LUXEMBOURGISH" | "MACEDONIAN" | "MALAGASY" | "MALAY" | "MALAYALAM" | "MALTESE" | "MANDARIN" | "MAORI" | "MARATHI" | "MOLDAVIAN" | "MOLDOVAN" | "MONGOLIAN" | "MYANMAR" | "NEPALI" | "NORWEGIAN" | "NYNORSK" | "OCCITAN" | "PANJABI" | "PASHTO" | "PERSIAN" | "POLISH" | "PORTUGUESE" | "PUNJABI" | "PUSHTO" | "ROMANIAN" | "RUSSIAN" | "SANSKRIT" | "SERBIAN" | "SHONA" | "SINDHI" | "SINHALA" | "SINHALESE" | "SLOVAK" | "SLOVENIAN" | "SOMALI" | "SPANISH" | "SUNDANESE" | "SWAHILI" | "SWEDISH" | "TAGALOG" | "TAJIK" | "TAMIL" | "TATAR" | "TELUGU" | "THAI" | "TIBETAN" | "TURKISH" | "TURKMEN" | "UKRAINIAN" | "URDU" | "UZBEK" | "VALENCIAN" | "VIETNAMESE" | "WELSH" | "YIDDISH" | "YORUBA"; /* Excluded from this release type: transform */ /** * A transformation to apply to a media item. Each variant specifies the type of transformation and any parameters required for the operation. * * Log Safety: UNSAFE */ declare type Transformation = ({ type: "emailToText"; } & EmailToTextTransformation) | ({ type: "image"; } & ImageTransformation) | ({ type: "spreadsheetToText"; } & SpreadsheetToTextTransformation) | ({ type: "videoToAudio"; } & VideoToAudioTransformation) | ({ type: "audioToText"; } & AudioToTextTransformation) | ({ type: "emailToAttachment"; } & EmailToAttachmentTransformation) | ({ type: "videoToArchive"; } & VideoToArchiveTransformation) | ({ type: "videoToText"; } & VideoToTextTransformation) | ({ type: "imageToText"; } & ImageToTextTransformation) | ({ type: "videoToImage"; } & VideoToImageTransformation) | ({ type: "video"; } & VideoTransformation) | ({ type: "imageToDocument"; } & ImageToDocumentTransformation) | ({ type: "dicomToImage"; } & DicomToImageTransformation) | ({ type: "documentToDocument"; } & DocumentToDocumentTransformation) | ({ type: "documentToImage"; } & DocumentToImageTransformation) | ({ type: "imageToEmbedding"; } & ImageToEmbeddingTransformation) | ({ type: "audio"; } & AudioTransformation) | ({ type: "documentToText"; } & DocumentToTextTransformation); /** * Document extraction failed. This covers any failure during extraction, from a malformed document to a server-side error. * * Log Safety: SAFE */ declare interface TransformationDocumentExtractError { errorCode: "INTERNAL"; errorName: "TransformationDocumentExtractError"; errorDescription: "Document extraction failed. This covers any failure during extraction, from a malformed document to a server-side error."; errorInstanceId: string; parameters: {}; } /** * The image or document page dimensions exceeded the maximum supported by the OCR model. * * Log Safety: SAFE */ declare interface TransformationImageTooLargeForOcr { errorCode: "INVALID_ARGUMENT"; errorName: "TransformationImageTooLargeForOcr"; errorDescription: "The image or document page dimensions exceeded the maximum supported by the OCR model."; errorInstanceId: string; parameters: {}; } /** * The transformation input is too large for the underlying model. * * Log Safety: SAFE */ declare interface TransformationInputTooLarge { errorCode: "REQUEST_ENTITY_TOO_LARGE"; errorName: "TransformationInputTooLarge"; errorDescription: "The transformation input is too large for the underlying model."; errorInstanceId: string; parameters: {}; } /** * The supplied page range is invalid. * * Log Safety: SAFE */ declare interface TransformationInvalidPageRange { errorCode: "INVALID_ARGUMENT"; errorName: "TransformationInvalidPageRange"; errorDescription: "The supplied page range is invalid."; errorInstanceId: string; parameters: { startPageInclusive: unknown; endPageExclusive: unknown; documentLength: unknown; }; } /** * An identifier for a media item transformation job. * * Log Safety: UNSAFE */ declare type TransformationJobId = LooselyBrandedString_14<"TransformationJobId">; /** * The status of a transformation job. * * Log Safety: SAFE */ declare type TransformationJobStatus = "PENDING" | "FAILED" | "SUCCESSFUL"; /** * The media item exceeds the maximum size supported by the transformation. * * Log Safety: SAFE */ declare interface TransformationMediaSizeExceeded { errorCode: "REQUEST_ENTITY_TOO_LARGE"; errorName: "TransformationMediaSizeExceeded"; errorDescription: "The media item exceeds the maximum size supported by the transformation."; errorInstanceId: string; parameters: { sizeInBytes: unknown; maxSizeInBytes: unknown; }; } /** * The transformation input exceeded the model's maximum context window. * * Log Safety: SAFE */ declare interface TransformationModelContextWindowExceeded { errorCode: "INVALID_ARGUMENT"; errorName: "TransformationModelContextWindowExceeded"; errorDescription: "The transformation input exceeded the model's maximum context window."; errorInstanceId: string; parameters: { inputTokenCount: unknown; maxTokens: unknown; }; } /** * The requested model is not available or the caller does not have permission to use it. * * Log Safety: SAFE */ declare interface TransformationModelNotAvailable { errorCode: "INVALID_ARGUMENT"; errorName: "TransformationModelNotAvailable"; errorDescription: "The requested model is not available or the caller does not have permission to use it."; errorInstanceId: string; parameters: {}; } /** * The requested model is not supported for this transformation. * * Log Safety: UNSAFE */ declare interface TransformationModelNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "TransformationModelNotSupported"; errorDescription: "The requested model is not supported for this transformation."; errorInstanceId: string; parameters: { modelId: unknown; }; } /** * The requested transformation could not be found. * * Log Safety: SAFE */ declare interface TransformationNotFound { errorCode: "NOT_FOUND"; errorName: "TransformationNotFound"; errorDescription: "The requested transformation could not be found."; errorInstanceId: string; parameters: {}; } /** * The caller does not have permission to run this media transformation. * * Log Safety: SAFE */ declare interface TransformationPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "TransformationPermissionDenied"; errorDescription: "The caller does not have permission to run this media transformation."; errorInstanceId: string; parameters: { underlyingErrorType: unknown; code: unknown; }; } /** * The requested transformation is not currently available. * * Log Safety: SAFE */ declare interface TransformationUnavailable { errorCode: "INVALID_ARGUMENT"; errorName: "TransformationUnavailable"; errorDescription: "The requested transformation is not currently available."; errorInstanceId: string; parameters: {}; } /** * A language model call failed during a media transformation. * * Log Safety: SAFE */ declare interface TransformationVlmError { errorCode: "INVALID_ARGUMENT"; errorName: "TransformationVlmError"; errorDescription: "A language model call failed during a media transformation."; errorInstanceId: string; parameters: { underlyingErrorType: unknown; code: unknown; }; } /** * The layout or OCR model used as preprocessing for document extraction failed. * * Log Safety: SAFE */ declare interface TransformationVlmLayoutModelFailure { errorCode: "INTERNAL"; errorName: "TransformationVlmLayoutModelFailure"; errorDescription: "The layout or OCR model used as preprocessing for document extraction failed."; errorInstanceId: string; parameters: {}; } /** * Document extraction only supports a single page per request. * * Log Safety: SAFE */ declare interface TransformationVlmMultiPageRequestUnsupported { errorCode: "INVALID_ARGUMENT"; errorName: "TransformationVlmMultiPageRequestUnsupported"; errorDescription: "Document extraction only supports a single page per request."; errorInstanceId: string; parameters: { requestedPages: unknown; maxValidPageCount: unknown; }; } /** * Document extraction requires an explicit page range with both startPageInclusive and endPageExclusive set. * * Log Safety: SAFE */ declare interface TransformationVlmPageRangeRequired { errorCode: "INVALID_ARGUMENT"; errorName: "TransformationVlmPageRangeRequired"; errorDescription: "Document extraction requires an explicit page range with both startPageInclusive and endPageExclusive set."; errorInstanceId: string; parameters: {}; } /** * The model response could not be parsed during document extraction. * * Log Safety: SAFE */ declare interface TransformationVlmResponseParseError { errorCode: "INTERNAL"; errorName: "TransformationVlmResponseParseError"; errorDescription: "The model response could not be parsed during document extraction."; errorInstanceId: string; parameters: {}; } /** * The requested media item could not be found, or the client token does not have access to it. * * Log Safety: SAFE */ declare interface TransformedMediaItemNotFound { errorCode: "NOT_FOUND"; errorName: "TransformedMediaItemNotFound"; errorDescription: "The requested media item could not be found, or the client token does not have access to it."; errorInstanceId: string; parameters: { mediaSetRid: unknown; mediaItemRid: unknown; }; } /* Excluded from this release type: transformJson */ /** * Could not transformJson the LiveDeployment. * * Log Safety: SAFE */ declare interface TransformJsonLiveDeploymentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "TransformJsonLiveDeploymentPermissionDenied"; errorDescription: "Could not transformJson the LiveDeployment."; errorInstanceId: string; parameters: { liveDeploymentRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface TransformJsonLiveDeploymentRequest { input: Record; } /** * The response from transforming input data using a live deployment. * * Log Safety: UNSAFE */ declare interface TransformLiveDeploymentResponse { output: Record; } /** * Request to transform a media item. * * Log Safety: UNSAFE */ declare interface TransformMediaItemRequest { transformation: Transformation; } /** * Response from initiating a media item transformation. * * Log Safety: UNSAFE */ declare interface TransformMediaItemResponse { status: TransformationJobStatus; jobId: TransformationJobId; } /** * Auto-saved resources cannot be trashed. * * Log Safety: UNSAFE */ declare interface TrashingAutosavedResourcesNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "TrashingAutosavedResourcesNotSupported"; errorDescription: "Auto-saved resources cannot be trashed."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Hidden resources cannot be trashed. * * Log Safety: UNSAFE */ declare interface TrashingHiddenResourcesNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "TrashingHiddenResourcesNotSupported"; errorDescription: "Hidden resources cannot be trashed."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Spaces cannot be trashed. * * Log Safety: UNSAFE */ declare interface TrashingSpaceNotSupported { errorCode: "INVALID_ARGUMENT"; errorName: "TrashingSpaceNotSupported"; errorDescription: "Spaces cannot be trashed."; errorInstanceId: string; parameters: { resourceRid: unknown; }; } /** * Values: DIRECTLY_TRASHED: The resource was specifically trashed by a user. It can be restored directly. ANCESTOR_TRASHED: A folder that contains this resource was trashed by a user. Restoring this resource requires restoring the original folder. NOT_TRASHED: The default status of resources. * * Log Safety: SAFE */ declare type TrashStatus = "DIRECTLY_TRASHED" | "ANCESTOR_TRASHED" | "NOT_TRASHED"; /** * Configuration for trend-based validation with severity settings. At least one of trendType or differenceBounds must be specified. Both may be provided to validate both the trend pattern and the magnitude of change. * * Log Safety: SAFE */ declare interface TrendConfig { trendType?: TrendType; differenceBounds?: NumericBounds; severity: SeverityLevel; } /** * The type of trend to validate: NON_INCREASING: Values should not increase over time NON_DECREASING: Values should not decrease over time STRICTLY_INCREASING: Values should strictly increase over time STRICTLY_DECREASING: Values should strictly decrease over time CONSTANT: Values should remain constant over time * * Log Safety: SAFE */ declare type TrendType = "NON_INCREASING" | "NON_DECREASING" | "STRICTLY_INCREASING" | "STRICTLY_DECREASING" | "CONSTANT"; /** * Log Safety: UNSAFE */ declare type Trigger = ({ type: "jobSucceeded"; } & JobSucceededTrigger) | ({ type: "or"; } & OrTrigger) | ({ type: "newLogic"; } & NewLogicTrigger) | ({ type: "tableUpdated"; } & TableUpdatedTrigger) | ({ type: "and"; } & AndTrigger) | ({ type: "datasetUpdated"; } & DatasetUpdatedTrigger) | ({ type: "scheduleSucceeded"; } & ScheduleSucceededTrigger) | ({ type: "mediaSetUpdated"; } & MediaSetUpdatedTrigger) | ({ type: "time"; } & TimeTrigger) | ({ type: "manual"; } & ManualTrigger); /** * MPEG Transport Stream audio container format. * * Log Safety: SAFE */ declare interface TsAudioContainerFormat { } /** * MPEG Transport Stream video container format. * * Log Safety: SAFE */ declare interface TsVideoContainerFormat { } /** * Log Safety: UNSAFE */ declare interface TwoDimensionalAggregation { keyType: QueryAggregationKeyType; valueType: QueryAggregationValueType; } /** * Log Safety: SAFE */ declare interface TwoDimensionalAggregation_2 { keyType: QueryAggregationKeyType_2; valueType: QueryAggregationValueType_2; } /** * Additional metadata that can be interpreted by user applications that interact with the Ontology * * Log Safety: UNSAFE */ declare interface TypeClass { kind: string; name: string; } /** * Returns action types whose type class satisfies the given type class predicate. * * Log Safety: UNSAFE */ declare interface TypeClassesActionTypesQueryV2 { value: TypeClassPredicateV2; } /** * 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. * * Log Safety: UNSAFE */ declare interface TypeClassPredicateV2 { kind: string; name?: string; } /** * Input type does not match expected type in model API. * * Log Safety: SAFE */ declare interface TypeMismatchError { expectedType: string; actualType: string; } /** * The unique identifier of a type reference. This identifier is used to look up the type definition in the typeReferences map of the enclosing Query. * * Log Safety: SAFE */ declare type TypeReferenceIdentifier = LooselyBrandedString_5<"TypeReferenceIdentifier">; /** * The unique identifier of a type reference. This identifier is used to look up the type definition in the typeReferences map of the enclosing Query. * * Log Safety: SAFE */ declare type TypeReferenceIdentifier_2 = LooselyBrandedString_9<"TypeReferenceIdentifier">; /** * The provided token does not have permission to take a specific Cipher operation. * * Log Safety: SAFE */ declare interface UnauthorizedCipherOperation { errorCode: "PERMISSION_DENIED"; errorName: "UnauthorizedCipherOperation"; errorDescription: "The provided token does not have permission to take a specific Cipher operation."; errorInstanceId: string; parameters: { cipherChannel: unknown; }; } /** * The value intended for decryption with Cipher cannot be decrypted. Ensure it is correctly formatted (CIPHER::CIPHER). * * Log Safety: UNSAFE */ declare interface UndecryptableValue { errorCode: "INVALID_ARGUMENT"; errorName: "UndecryptableValue"; errorDescription: "The value intended for decryption with Cipher cannot be decrypted. Ensure it is correctly formatted (CIPHER::CIPHER)."; errorInstanceId: string; parameters: { value: unknown; }; } /** * Remove the currently deployed version of the Website. * * @public * * Required Scopes: [third-party-application:deploy-application-website] * URL: /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/undeploy */ declare function undeploy($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ thirdPartyApplicationRid: _ThirdPartyApplications.ThirdPartyApplicationRid ]): Promise<_ThirdPartyApplications.Website>; /** * Could not undeploy the Website. * * Log Safety: SAFE */ declare interface UndeployWebsitePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UndeployWebsitePermissionDenied"; errorDescription: "Could not undeploy the Website."; errorInstanceId: string; parameters: { thirdPartyApplicationRid: unknown; }; } /** * The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. * * Log Safety: SAFE */ declare interface UnevaluableConstraint { } /** * Received an unexpected metadata type, this particular media item may use features that are not yet fully supported in the public API. * * Log Safety: SAFE */ declare interface UnexpectedMetadataType { errorCode: "INTERNAL"; errorName: "UnexpectedMetadataType"; errorDescription: "Received an unexpected metadata type, this particular media item may use features that are not yet fully supported in the public API."; errorInstanceId: string; parameters: {}; } /** * A union model definition with variants. * * Log Safety: UNSAFE */ declare interface UnionDef { key: ModelTypeKey; discriminant: FieldKey; name: string; description?: string; variants: Record; metadata: SchemaMetadata; } /** * A key identifying a variant within a union. * * Log Safety: UNSAFE */ declare type UnionVariantKey = LooselyBrandedString_19<"UnionVariantKey">; /** * Represents a unique identifier argument in a logic rule. * * Log Safety: SAFE */ declare interface UniqueIdentifierArgument { linkId?: string; } /** * A reference to a UniqueIdentifierArgument linkId defined for this action type. * * Log Safety: SAFE */ declare type UniqueIdentifierLinkId = string; /** * One or more unique identifier link IDs specified in apply action overrides could not be found in the ActionType definition. * * Log Safety: SAFE */ declare interface UniqueIdentifierLinkIdsDoNotExistInActionType { errorCode: "INVALID_ARGUMENT"; errorName: "UniqueIdentifierLinkIdsDoNotExistInActionType"; errorDescription: "One or more unique identifier link IDs specified in apply action overrides could not be found in the ActionType definition."; errorInstanceId: string; parameters: { unknownUniqueIdentifierLinkIds: unknown; }; } /** * An override value to be used for a UniqueIdentifier action parameter, instead of the value being automatically generated. * * Log Safety: SAFE */ declare type UniqueIdentifierValue = string; /** * The unit interpretation for a band. * * Log Safety: UNSAFE */ declare interface UnitInterpretation { unit?: string; scale?: number; offset?: number; } /** * Pointer to the table in Unity Catalog. Uses the Databricks table identifier of catalog, schema and table. * * Log Safety: UNSAFE */ declare interface UnityVirtualTableConfig { catalog: string; schema: string; table: string; } /** * The provided classification banner display type is not recognized. * * Log Safety: UNSAFE */ declare interface UnknownClassificationBannerDisplayType { errorCode: "INVALID_ARGUMENT"; errorName: "UnknownClassificationBannerDisplayType"; errorDescription: "The provided classification banner display type is not recognized."; errorInstanceId: string; parameters: { displayType: unknown; }; } /** * The worker config column mapping contains an unknown column spec ID not found in the trainer's column specification. * * Log Safety: UNSAFE */ declare interface UnknownColumnSpecIdInConfigColumnMappingError { datasetRid: _Core.DatasetRid; columnTypeSpecId: ColumnTypeSpecId; } /** * An unknown distance unit was provided. * * Log Safety: UNSAFE */ declare interface UnknownDistanceUnit { errorCode: "INVALID_ARGUMENT"; errorName: "UnknownDistanceUnit"; errorDescription: "An unknown distance unit was provided."; errorInstanceId: string; parameters: { unknownUnit: unknown; knownUnits: unknown; }; } /** * Provided input name not found in model API specification. * * Log Safety: UNSAFE */ declare interface UnknownInputNameError { inputName: string; } /** * The provided parameters were not found. Please look at the knownParameters field to see which ones are available. * * Log Safety: UNSAFE */ declare interface UnknownParameter { errorCode: "INVALID_ARGUMENT"; errorName: "UnknownParameter"; errorDescription: "The provided parameters were not found. Please look at the knownParameters field to see which ones are available."; errorInstanceId: string; parameters: { unknownParameters: unknown; expectedParameters: unknown; }; } /** * The provided parameters were not found. Please look at the knownParameters field to see which ones are available. * * Log Safety: UNSAFE */ declare interface UnknownParameter_2 { errorCode: "INVALID_ARGUMENT"; errorName: "UnknownParameter"; errorDescription: "The provided parameters were not found. Please look at the knownParameters field to see which ones are available."; errorInstanceId: string; parameters: { unknownParameters: unknown; expectedParameters: unknown; }; } /** * A ConnectionWorker that is not supported in the Platform APIs. This can happen because either the ConnectionWorker configuration is malformed, or because the ConnectionWorker is a legacy one. The ConnectionWorker should be updated to use the Foundry worker with either direct egress policies or agent proxy egress policies. * * Log Safety: SAFE */ declare interface UnknownWorker { } /** * The UnknownWorker cannot be used for creating or updating connections. Please use the Foundry worker instead. * * Log Safety: SAFE */ declare interface UnknownWorkerCannotBeUsedForCreatingOrUpdatingConnections { errorCode: "INVALID_ARGUMENT"; errorName: "UnknownWorkerCannotBeUsedForCreatingOrUpdatingConnections"; errorDescription: "The UnknownWorker cannot be used for creating or updating connections. Please use the Foundry worker instead."; errorInstanceId: string; parameters: {}; } /** * An ordered list of unnamed positional parameter values. * * Log Safety: UNSAFE */ declare interface UnnamedParameterValues { values: Array; } /** * @public * * Required Scopes: [api:orchestration-write] * URL: /v2/orchestration/schedules/{scheduleRid}/unpause */ declare function unpause($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [scheduleRid: _Core.ScheduleRid]): Promise; /** * Could not unpause the Schedule. * * Log Safety: SAFE */ declare interface UnpauseSchedulePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UnpauseSchedulePermissionDenied"; errorDescription: "Could not unpause the Schedule."; errorInstanceId: string; parameters: { scheduleRid: unknown; }; } /** * A dataset field has a type that is not supported by the trainer. * * Log Safety: UNSAFE */ declare interface UnsupportedDatasetFieldTypeError { datasetRid: _Core.DatasetRid; fieldName?: string; fieldType: string; } /** * Aggregations on interface-based object sets are not supported for object sets with OSv1 objects. * * Log Safety: UNSAFE */ declare interface UnsupportedInterfaceBasedObjectSet { errorCode: "INVALID_ARGUMENT"; errorName: "UnsupportedInterfaceBasedObjectSet"; errorDescription: "Aggregations on interface-based object sets are not supported for object sets with OSv1 objects."; errorInstanceId: string; parameters: { interfaceType: unknown; }; } /** * The Agent is configured with a language model that is not supported or could not be resolved. This can surface at runtime if the model was deprecated or is not accessible to the calling token. Update the Agent's language model in AIP Chatbot Studio. * * Log Safety: SAFE */ declare interface UnsupportedLanguageModelRid { errorCode: "INVALID_ARGUMENT"; errorName: "UnsupportedLanguageModelRid"; errorDescription: "The Agent is configured with a language model that is not supported or could not be resolved. This can surface at runtime if the model was deprecated or is not accessible to the calling token. Update the Agent's language model in AIP Chatbot Studio."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; languageModelRid: unknown; modelPurpose: unknown; }; } /** * The Live Deployment type is not supported by the API. * * Log Safety: SAFE */ declare interface UnsupportedLiveDeployment { errorCode: "INVALID_ARGUMENT"; errorName: "UnsupportedLiveDeployment"; errorDescription: "The Live Deployment type is not supported by the API."; errorInstanceId: string; parameters: {}; } /** * A media item has an unsupported metadata type * * Log Safety: SAFE */ declare interface UnsupportedMetadata { errorCode: "INTERNAL"; errorName: "UnsupportedMetadata"; errorDescription: "A media item has an unsupported metadata type"; errorInstanceId: string; parameters: {}; } /** * The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API. * * Log Safety: SAFE */ declare interface UnsupportedModelSource { errorCode: "INVALID_ARGUMENT"; errorName: "UnsupportedModelSource"; errorDescription: "The Model Version has a source type that is not supported by the API. This can occur when the model was created through a legacy or internal workflow that is not exposed through the public API."; errorInstanceId: string; parameters: {}; } /** * The requested object set is not supported. * * Log Safety: SAFE */ declare interface UnsupportedObjectSet { errorCode: "INVALID_ARGUMENT"; errorName: "UnsupportedObjectSet"; errorDescription: "The requested object set is not supported."; errorInstanceId: string; parameters: {}; } /** * Indicates the property is backed by a restricted view that does not support property securities. * * Log Safety: SAFE */ declare interface UnsupportedPolicy { } /** * Log Safety: UNSAFE */ declare interface UnsupportedType { unsupportedType: string; params: Record; } /** * Log Safety: UNSAFE */ declare interface UnsupportedType_2 { unsupportedType: string; params: Record<_Core.UnsupportedTypeParamKey, _Core.UnsupportedTypeParamValue>; } /** * Input contains an unsupported data type. * * Log Safety: SAFE */ declare interface UnsupportedTypeError { unsupportedType: string; } /** * Log Safety: UNSAFE */ declare type UnsupportedTypeParamKey = LooselyBrandedString<"UnsupportedTypeParamKey">; /** * Log Safety: UNSAFE */ declare type UnsupportedTypeParamValue = LooselyBrandedString<"UnsupportedTypeParamValue">; /** * Log Safety: UNSAFE */ declare type UnsupportedTypeParamValue_2 = LooselyBrandedString_15<"UnsupportedTypeParamValue">; /** * Metadata for untyped media items (media items without a recognized type). * * Log Safety: SAFE */ declare interface UntypedMediaItemMetadata { sizeBytes: number; } /* Excluded from this release type: update */ /** * The Foundry user who last updated this resource * * Log Safety: SAFE */ declare type UpdatedBy = UserId; /** * Request to update document metadata (name, description, and/or security). * * Log Safety: UNSAFE */ declare interface UpdateDocumentMetadataRequest { name?: string; description?: string; security?: DocumentSecurity; } /** * The user does not have permission to update this document, or the document does not exist. * * Log Safety: SAFE */ declare interface UpdateDocumentNotSupported { errorCode: "PERMISSION_DENIED"; errorName: "UpdateDocumentNotSupported"; errorDescription: "The user does not have permission to update this document, or the document does not exist."; errorInstanceId: string; parameters: { documentId: unknown; }; } /** * Could not update the Document. * * Log Safety: SAFE */ declare interface UpdateDocumentPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UpdateDocumentPermissionDenied"; errorDescription: "Could not update the Document."; errorInstanceId: string; parameters: { documentId: unknown; }; } /** * Log Safety: UNSAFE */ declare interface UpdateDocumentRequest { requestBody: UpdateDocumentMetadataRequest; } /** * The time at which the resource was most recently updated. * * Log Safety: SAFE */ declare type UpdatedTime = string; /** * Updates the [export settings on the Connection.](https://www.palantir.com/docs/foundry/data-connection/export-overview/#enable-exports-for-source) * Only users with Information Security Officer role can modify the export settings. * * @public * * Required Scopes: [api:connectivity-connection-write] * URL: /v2/connectivity/connections/{connectionRid}/updateExportSettings */ declare function updateExportSettings($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, $body: _Connectivity.UpdateExportSettingsForConnectionRequest ]): Promise; /** * Could not updateExportSettings the Connection. * * Log Safety: SAFE */ declare interface UpdateExportSettingsForConnectionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UpdateExportSettingsForConnectionPermissionDenied"; errorDescription: "Could not updateExportSettings the Connection."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /** * Log Safety: SAFE */ declare interface UpdateExportSettingsForConnectionRequest { exportSettings: ConnectionExportSettings; } /* Excluded from this release type: updateSchema */ /** * Could not updateSchema the DocumentType. * * Log Safety: SAFE */ declare interface UpdateSchemaDocumentTypePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UpdateSchemaDocumentTypePermissionDenied"; errorDescription: "Could not updateSchema the DocumentType."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface UpdateSchemaDocumentTypeRequest { documentTypeName: DocumentTypeName; requestBody: UpdateSchemaRequestBody; } /** * Request to update a document type's schema. * * Log Safety: UNSAFE */ declare interface UpdateSchemaRequestBody { ontologyRid: string; schema: DocumentTypeSchema; version: SchemaVersion; forceOverwrite?: boolean; } /** * The result of an update schema request. * * Log Safety: UNSAFE */ declare type UpdateSchemaResponse = ({ type: "success"; } & UpdateSchemaSuccess) | ({ type: "validationFailure"; } & SchemaValidationFailure); /** * A successful schema update result. * * Log Safety: SAFE */ declare interface UpdateSchemaSuccess { version: SchemaVersion; } /** * Updates the secrets on the connection to the specified secret values. * Secrets that are currently configured on the connection but are omitted in the request will remain unchanged. * * Secrets are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, * they will be temporarily decrypted and remain in plaintext in memory to be processed as needed. * They will stay in plaintext in memory until the garbage collection process cleans up the memory. * The secrets are always stored encrypted on our servers. * * By using this endpoint, you acknowledge and accept any potential risks associated with the temporary * in-memory handling of secrets. If you do not want your secrets to be temporarily decrypted, you should * use the Foundry UI instead. * * @public * * Required Scopes: [api:connectivity-connection-write] * URL: /v2/connectivity/connections/{connectionRid}/updateSecrets */ declare function updateSecrets($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, $body: _Connectivity.UpdateSecretsForConnectionRequest ]): Promise; /** * Could not update secrets for the Connection. * * Log Safety: SAFE */ declare interface UpdateSecretsForConnectionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UpdateSecretsForConnectionPermissionDenied"; errorDescription: "Could not update secrets for the Connection."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /** * Log Safety: DO_NOT_LOG */ declare interface UpdateSecretsForConnectionRequest { secrets: Record; } /** * Could not updateTitle the Session. * * Log Safety: SAFE */ declare interface UpdateSessionTitlePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UpdateSessionTitlePermissionDenied"; errorDescription: "Could not updateTitle the Session."; errorInstanceId: string; parameters: { agentRid: unknown; sessionRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface UpdateSessionTitleRequest { title: string; } /* Excluded from this release type: updateTitle */ /** * Uploads a File to an existing Dataset. * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. * By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. * If the file already exists only the most recent version will be visible in the updated view. * * #### Advanced Usage * * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. * To **upload a file to a specific Branch** specify the Branch's name as `branchName`. A new transaction will * be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this * default specify `transactionType` in addition to `branchName`. * See [createBranch](https://www.palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. * To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as * `transactionRid`. This is useful for uploading multiple files in a single transaction. * See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. * * @public * * Required Scopes: [api:datasets-write] * URL: /v2/datasets/{datasetRid}/files/{filePath}/upload */ declare function upload($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ datasetRid: _Core.DatasetRid, filePath: _Core.FilePath, $body: Blob, $queryParams?: { branchName?: _Core.BranchName | undefined; transactionType?: _Datasets_2.TransactionType | undefined; transactionRid?: _Datasets_2.TransactionRid | undefined; } ]): Promise<_Datasets_2.File>; /** * Upload an attachment to use in an action. Any attachment which has not been linked to an object via * an action within one hour after upload will be removed. * Previously mapped attachments which are not connected to any object anymore are also removed on * a biweekly basis. * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. * * @public * * Required Scopes: [api:ontologies-write] * URL: /v2/ontologies/attachments/upload */ declare function upload_2($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ $body: Blob, $queryParams: { filename: _Core.Filename; }, $headerParams?: { "Content-Type"?: _Core.ContentType; } ]): Promise<_Ontologies_2.AttachmentV2>; /* Excluded from this release type: upload_3 */ /* Excluded from this release type: upload_4 */ /** * Upload a new version of the Website. * * @public * * Required Scopes: [third-party-application:deploy-application-website] * URL: /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload */ declare function upload_5($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ thirdPartyApplicationRid: _ThirdPartyApplications.ThirdPartyApplicationRid, $body: Blob, $queryParams: { version: _ThirdPartyApplications.VersionVersion; } ]): Promise<_ThirdPartyApplications.Version>; /** * Only JDBC connections support uploading custom JDBC drivers. * * Log Safety: UNSAFE */ declare interface UploadCustomJdbcDriverNotSupportForConnection { errorCode: "INVALID_ARGUMENT"; errorName: "UploadCustomJdbcDriverNotSupportForConnection"; errorDescription: "Only JDBC connections support uploading custom JDBC drivers."; errorInstanceId: string; parameters: { connectionType: unknown; }; } /** * Upload custom jdbc drivers to an existing JDBC connection. * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. * * @public * * Required Scopes: [api:connectivity-connection-write] * URL: /v2/connectivity/connections/{connectionRid}/uploadCustomJdbcDrivers */ declare function uploadCustomJdbcDrivers($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ connectionRid: _Connectivity.ConnectionRid, $body: Blob, $queryParams: { fileName: string; } ]): Promise<_Connectivity.Connection>; /** * Could not uploadCustomJdbcDrivers the Connection. * * Log Safety: SAFE */ declare interface UploadCustomJdbcDriversConnectionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UploadCustomJdbcDriversConnectionPermissionDenied"; errorDescription: "Could not uploadCustomJdbcDrivers the Connection."; errorInstanceId: string; parameters: { connectionRid: unknown; }; } /** * The provided token does not have permission to upload the given file to the given dataset and transaction. * * Log Safety: UNSAFE */ declare interface UploadFilePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UploadFilePermissionDenied"; errorDescription: "The provided token does not have permission to upload the given file to the given dataset and transaction."; errorInstanceId: string; parameters: { datasetRid: unknown; transactionRid: unknown; path: unknown; }; } /** * Uploads a temporary media item. If the media item isn't persisted within 1 hour, the item will be deleted. * * If multiple resources are attributed to, usage will be attributed to the first one in the list. * * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. * Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`. * * @public * * Required Scopes: [api:ontologies-read, api:ontologies-write] * URL: /v2/mediasets/media/upload */ declare function uploadMedia($ctx: SharedClient | SharedClientContext | SharedClient_2 | SharedClientContext_2, ...args: [ $body: Blob, $queryParams: { filename: _Core.MediaItemPath; mediaItemRid?: _Core.MediaItemRid | undefined; }, $headerParams?: { attribution?: _Core.Attribution | undefined; } ]): Promise<_Core.MediaReference>; /* Excluded from this release type: uploadSnapshot */ /** * Could not uploadSnapshot the Version. * * Log Safety: SAFE */ declare interface UploadSnapshotVersionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UploadSnapshotVersionPermissionDenied"; errorDescription: "Could not uploadSnapshot the Version."; errorInstanceId: string; parameters: { thirdPartyApplicationRid: unknown; }; } /** * Could not upload the Version. * * Log Safety: SAFE */ declare interface UploadVersionPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "UploadVersionPermissionDenied"; errorDescription: "Could not upload the Version."; errorInstanceId: string; parameters: { thirdPartyApplicationRid: unknown; }; } /* Excluded from this release type: uploadWithRid */ /** * Target the specified datasets along with all upstream datasets except the ignored datasets. * * Log Safety: SAFE */ declare interface UpstreamTarget { targetRids: Array; ignoredRids: Array; } /** * Defines supported URI schemes to be used for external connections. * * Log Safety: SAFE */ declare type UriScheme = "HTTP" | "HTTPS"; /** * The unique resource identifier (RID) of the usage account that will be used as a default on project creation. * * Log Safety: SAFE */ declare type UsageAccountRid = LooselyBrandedString_7<"UsageAccountRid">; /** * The Usage Accounts service is unexpectedly not present. * * Log Safety: SAFE */ declare interface UsageAccountServiceIsNotPresent { errorCode: "INTERNAL"; errorName: "UsageAccountServiceIsNotPresent"; errorDescription: "The Usage Accounts service is unexpectedly not present."; errorInstanceId: string; parameters: {}; } /** * Log Safety: UNSAFE */ declare interface User { id: _Core.UserId; username: UserUsername; givenName?: string; familyName?: string; email?: string; realm: _Core.Realm; organization?: _Core.OrganizationRid; status: _Core.UserStatus; attributes: Record; } /** * The user is deleted. * * Log Safety: SAFE */ declare interface UserDeleted { errorCode: "INVALID_ARGUMENT"; errorName: "UserDeleted"; errorDescription: "The user is deleted."; errorInstanceId: string; parameters: { principalId: unknown; }; } /** * A Foundry User ID. * * Log Safety: SAFE */ declare type UserId = string; /** * A Foundry User ID. * * Log Safety: SAFE */ declare type UserId_2 = string; /** * The user is an active user. * * Log Safety: SAFE */ declare interface UserIsActive { errorCode: "INVALID_ARGUMENT"; errorName: "UserIsActive"; errorDescription: "The user is an active user."; errorInstanceId: string; parameters: { principalId: unknown; }; } /** * The given User could not be found. * * Log Safety: SAFE */ declare interface UserNotFound { errorCode: "NOT_FOUND"; errorName: "UserNotFound"; errorDescription: "The given User could not be found."; errorInstanceId: string; parameters: { userId: unknown; }; } /** * A user's presence on a document * * Log Safety: SAFE */ declare type UserPresence = "PRESENT" | "NOT_PRESENT"; /** * Log Safety: UNSAFE */ declare interface UserProviderInfo { providerId: ProviderId; } /** * The given UserProviderInfo could not be found. * * Log Safety: SAFE */ declare interface UserProviderInfoNotFound { errorCode: "NOT_FOUND"; errorName: "UserProviderInfoNotFound"; errorDescription: "The given UserProviderInfo could not be found."; errorInstanceId: string; parameters: { userId: unknown; }; } export declare namespace UserProviderInfos { export { get_13 as get, replace_7 as replace } } export declare namespace Users { export { deleteUser, list_13 as list, get_12 as get, getBatch_4 as getBatch, getCurrent_2 as getCurrent, getMarkings, profilePicture, search_2 as search, revokeAllTokens } } /** * When triggered, the schedule will build all resources that the associated user is permitted to build. * * Log Safety: SAFE */ declare interface UserScope { } /** * Log Safety: UNSAFE */ declare interface UserSearchFilter { type: PrincipalFilterType; value: string; } /** * Present status of user. * * Log Safety: SAFE */ declare type UserStatus = "ACTIVE" | "DELETED"; /** * Log Safety: UNSAFE */ declare interface UserTextInput { text: string; } /** * The Foundry username of the User. This is unique within the realm. * * Log Safety: UNSAFE */ declare type UserUsername = LooselyBrandedString_3<"UserUsername">; /** * The string must be a valid UUID (Universally Unique Identifier). * * Log Safety: SAFE */ declare interface UuidConstraint { } /** * Log Safety: SAFE */ declare interface UuidConstraint_2 { } /** * Log Safety: UNSAFE */ declare interface ValidateActionRequest { parameters: Record; } /** * Log Safety: UNSAFE */ declare interface ValidateActionResponse { result: ValidationResult; submissionCriteria: Array; parameters: Record; } /** * Log Safety: UNSAFE */ declare interface ValidateActionResponseV2 { result: ValidationResult; submissionCriteria: Array; parameters: Record; } /** * Represents the state of a validation. * * Log Safety: SAFE */ declare type ValidationResult = "VALID" | "INVALID"; /** * A string indicating the type of each data value. Note that these types can be nested, for example an array of structs. | Type | JSON value | |---------------------|-------------------------------------------------------------------------------------------------------------------| | Array | Array, where T is the type of the array elements, e.g. Array. | | Attachment | Attachment | | Boolean | Boolean | | Byte | Byte | | CipherText | CipherText | | Date | LocalDate | | Decimal | Decimal | | Double | Double | | Float | Float | | Integer | Integer | | Long | Long | | Marking | Marking | | OntologyObject | OntologyObject where T is the API name of the referenced object type. | | Short | Short | | String | String | | Struct | Struct where T contains field name and type pairs, e.g. Struct<{ firstName: String, lastName: string }> | | Timeseries | TimeSeries where T is either String for an enum series or Double for a numeric series. | | Timestamp | Timestamp | * * Log Safety: UNSAFE */ declare type ValueType = LooselyBrandedString_5<"ValueType">; /** * Log Safety: UNSAFE */ declare interface ValueType_2 { rid: ValueTypeRid_2; version: ValueTypeVersion; versionId: ValueTypeVersionId_2; apiName: ValueTypeApiName_2; displayName: _Core.DisplayName; description?: ValueTypeDescription; baseType?: ValueTypeDataType; constraints: Array; } /** * The parameter value must conform to the referenced value type. * * Log Safety: UNSAFE */ declare interface ValueTypeAllowedValues { apiName: ValueTypeApiName; rid: ValueTypeRid; versionId: ValueTypeVersionId; } /** * The name of the value type in the API in camelCase format. * * Log Safety: UNSAFE */ declare type ValueTypeApiName = LooselyBrandedString_5<"ValueTypeApiName">; /** * The registered API name for the value type. * * Log Safety: UNSAFE */ declare type ValueTypeApiName_2 = LooselyBrandedString_9<"ValueTypeApiName">; /** * Log Safety: UNSAFE */ declare interface ValueTypeArrayType { subType?: ValueTypeFieldType; } /** * Log Safety: UNSAFE */ declare type ValueTypeConstraint = ({ type: "struct"; } & StructConstraint) | ({ type: "regex"; } & RegexConstraint) | ({ type: "unsupported"; } & _Core.UnsupportedType) | ({ type: "array"; } & ArrayConstraint) | ({ type: "length"; } & LengthConstraint) | ({ type: "range"; } & RangesConstraint) | ({ type: "rid"; } & RidConstraint) | ({ type: "uuid"; } & UuidConstraint) | ({ type: "enum"; } & EnumConstraint); /** * Log Safety: UNSAFE */ declare type ValueTypeConstraint_2 = ({ type: "struct"; } & StructConstraint_2) | ({ type: "structV1"; } & StructV1Constraint) | ({ type: "regex"; } & RegexConstraint_2) | ({ type: "nullable"; } & NullableConstraint) | ({ type: "array"; } & ArrayConstraint_2) | ({ type: "length"; } & LengthConstraint_2) | ({ type: "range"; } & RangesConstraint_2) | ({ type: "rid"; } & RidConstraint_2) | ({ type: "map"; } & MapConstraint) | ({ type: "uuid"; } & UuidConstraint_2) | ({ type: "enum"; } & EnumConstraint_2); /** * The underlying base type of a value type. * * Log Safety: UNSAFE */ declare type ValueTypeDataType = ({ type: "date"; } & ValueTypeDataTypeDateType) | ({ type: "struct"; } & ValueTypeDataTypeStructType) | ({ type: "string"; } & ValueTypeDataTypeStringType) | ({ type: "byte"; } & ValueTypeDataTypeByteType) | ({ type: "double"; } & ValueTypeDataTypeDoubleType) | ({ type: "optional"; } & ValueTypeDataTypeOptionalType) | ({ type: "integer"; } & ValueTypeDataTypeIntegerType) | ({ type: "union"; } & ValueTypeDataTypeUnionType) | ({ type: "float"; } & ValueTypeDataTypeFloatType) | ({ type: "long"; } & ValueTypeDataTypeLongType) | ({ type: "boolean"; } & ValueTypeDataTypeBooleanType) | ({ type: "array"; } & ValueTypeDataTypeArrayType) | ({ type: "binary"; } & ValueTypeDataTypeBinaryType) | ({ type: "valueTypeReference"; } & ValueTypeDataTypeValueTypeReference) | ({ type: "short"; } & ValueTypeDataTypeShortType) | ({ type: "decimal"; } & ValueTypeDataTypeDecimalType) | ({ type: "map"; } & ValueTypeDataTypeMapType) | ({ type: "timestamp"; } & ValueTypeDataTypeTimestampType); /** * Log Safety: UNSAFE */ declare interface ValueTypeDataTypeArrayType { subType: ValueTypeDataType; } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeBinaryType { } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeBooleanType { } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeByteType { } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeDateType { } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeDecimalType { } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeDoubleType { } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeFloatType { } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeIntegerType { } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeLongType { } /** * Log Safety: UNSAFE */ declare interface ValueTypeDataTypeMapType { keyType: ValueTypeDataType; valueType: ValueTypeDataType; } /** * Log Safety: UNSAFE */ declare interface ValueTypeDataTypeOptionalType { wrappedType: ValueTypeDataType; } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeShortType { } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeStringType { } /** * Log Safety: UNSAFE */ declare interface ValueTypeDataTypeStructElement { name: ValueTypeDataTypeStructFieldIdentifier; fieldType: ValueTypeDataType; } /** * Log Safety: UNSAFE */ declare type ValueTypeDataTypeStructFieldIdentifier = LooselyBrandedString_9<"ValueTypeDataTypeStructFieldIdentifier">; /** * Log Safety: UNSAFE */ declare interface ValueTypeDataTypeStructType { fields: Array; } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeTimestampType { } /** * Log Safety: UNSAFE */ declare interface ValueTypeDataTypeUnionType { memberTypes: Array; } /** * Log Safety: SAFE */ declare interface ValueTypeDataTypeValueTypeReference { rid: ValueTypeRid_2; versionId: ValueTypeVersionId_2; } /** * Log Safety: SAFE */ declare interface ValueTypeDecimalType { } /** * A description of the value type. * * Log Safety: UNSAFE */ declare type ValueTypeDescription = LooselyBrandedString_9<"ValueTypeDescription">; /** * Log Safety: UNSAFE */ declare type ValueTypeFieldType = ({ type: "date"; } & _Core.DateType) | ({ type: "struct"; } & ValueTypeStructType) | ({ type: "string"; } & _Core.StringType) | ({ type: "byte"; } & _Core.ByteType) | ({ type: "double"; } & _Core.DoubleType) | ({ type: "optional"; } & ValueTypeOptionalType) | ({ type: "integer"; } & _Core.IntegerType) | ({ type: "union"; } & ValueTypeUnionType) | ({ type: "float"; } & _Core.FloatType) | ({ type: "long"; } & _Core.LongType) | ({ type: "reference"; } & ValueTypeReferenceType) | ({ type: "boolean"; } & _Core.BooleanType) | ({ type: "array"; } & ValueTypeArrayType) | ({ type: "binary"; } & _Core.BinaryType) | ({ type: "short"; } & _Core.ShortType) | ({ type: "decimal"; } & ValueTypeDecimalType) | ({ type: "map"; } & ValueTypeMapType) | ({ type: "timestamp"; } & _Core.TimestampType); /** * Log Safety: UNSAFE */ declare interface ValueTypeMapType { keyType?: ValueTypeFieldType; valueType?: ValueTypeFieldType; } /** * The value type is not found, or the user does not have access to it. * * Log Safety: UNSAFE */ declare interface ValueTypeNotFound { errorCode: "NOT_FOUND"; errorName: "ValueTypeNotFound"; errorDescription: "The value type is not found, or the user does not have access to it."; errorInstanceId: string; parameters: { valueType: unknown; rid: unknown; }; } /** * The given ValueType could not be found. * * Log Safety: SAFE */ declare interface ValueTypeNotFound_2 { errorCode: "NOT_FOUND"; errorName: "ValueTypeNotFound"; errorDescription: "The given ValueType could not be found."; errorInstanceId: string; parameters: { valueTypeRid: unknown; }; } /** * Log Safety: UNSAFE */ declare interface ValueTypeOptionalType { wrappedType?: ValueTypeFieldType; } /** * A reference to a value type that has been registered in the Ontology. * * Log Safety: SAFE */ declare interface ValueTypeReference { rid: ValueTypeRid_2; versionId: ValueTypeVersionId_2; } /** * Log Safety: SAFE */ declare interface ValueTypeReferenceType { } /** * Log Safety: SAFE */ declare type ValueTypeRid = LooselyBrandedString_5<"ValueTypeRid">; /** * The RID of a value type that has been registered in the Ontology. * * Log Safety: SAFE */ declare type ValueTypeRid_2 = LooselyBrandedString_9<"ValueTypeRid">; export declare namespace ValueTypes { export { } } /** * Log Safety: SAFE */ declare type ValueTypeStatus = "ACTIVE" | "DEPRECATED"; /** * Log Safety: UNSAFE */ declare interface ValueTypeStructField { name?: _Core.StructFieldName; fieldType?: ValueTypeFieldType; } /** * Log Safety: UNSAFE */ declare interface ValueTypeStructType { fields: Array; } /** * Log Safety: UNSAFE */ declare interface ValueTypeUnionType { memberTypes: Array; } /** * The version of a value type that has been registered in the Ontology. * * Log Safety: UNSAFE */ declare type ValueTypeVersion = LooselyBrandedString_9<"ValueTypeVersion">; /** * Log Safety: SAFE */ declare type ValueTypeVersionId = string; /** * The version ID of a value type that has been registered in the Ontology. * * Log Safety: SAFE */ declare type ValueTypeVersionId_2 = string; /** * The vector similarity function to support approximate nearest neighbors search. Will result in an index specific for the function. * * Log Safety: SAFE */ declare interface VectorSimilarityFunction { value?: VectorSimilarityFunctionValue; } /** * Log Safety: SAFE */ declare type VectorSimilarityFunctionValue = "COSINE_SIMILARITY" | "DOT_PRODUCT" | "EUCLIDEAN_DISTANCE"; /** * Represents a fixed size vector of floats. These can be used for vector similarity searches. * * Log Safety: UNSAFE */ declare interface VectorType { dimension: number; supportsSearchWith: Array; embeddingModel?: EmbeddingModel; } /** * Log Safety: UNSAFE */ declare interface Version { version: VersionVersion; } /** * The given website version already exists. * * Log Safety: UNSAFE */ declare interface VersionAlreadyExists { errorCode: "CONFLICT"; errorName: "VersionAlreadyExists"; errorDescription: "The given website version already exists."; errorInstanceId: string; parameters: { version: unknown; }; } /** * The given version already exists. * * Log Safety: UNSAFE */ declare interface VersionAlreadyExists_2 { errorCode: "CONFLICT"; errorName: "VersionAlreadyExists"; errorDescription: "The given version already exists."; errorInstanceId: string; parameters: { version: unknown; }; } /** * The name of the Query in the API and an optional version identifier separated by a colon. If the API name contains a colon, then a version identifier of either "latest" or a semantic version must be included. If the API does not contain a colon, then either the version identifier must be excluded or a version identifier of a semantic version must be included. Examples: 'myGroup:myFunction:latest', 'myGroup:myFunction:1.0.0', 'myFunction', 'myFunction:2.0.0' * * Log Safety: UNSAFE */ declare type VersionedQueryTypeApiName = LooselyBrandedString_5<"VersionedQueryTypeApiName">; /** * The version identifier of a dataset schema. * * Log Safety: SAFE */ declare type VersionId = string; /** * Log Safety: UNSAFE */ declare interface VersionId_2 { rid: ValueTypeRid_2; version: ValueTypeVersion; versionId: ValueTypeVersionId_2; apiName: ValueTypeApiName_2; displayName: _Core.DisplayName; description?: ValueTypeDescription; baseType?: ValueTypeDataType; constraints: Array; } /** * The given VersionId could not be found. * * Log Safety: SAFE */ declare interface VersionIdNotFound { errorCode: "NOT_FOUND"; errorName: "VersionIdNotFound"; errorDescription: "The given VersionId could not be found."; errorInstanceId: string; parameters: { valueTypeRid: unknown; versionIdVersionId: unknown; }; } export declare namespace VersionIds { export { } } /** * The website contains too many versions. You must delete an old version before uploading a new one. * * Log Safety: SAFE */ declare interface VersionLimitExceeded { errorCode: "INVALID_ARGUMENT"; errorName: "VersionLimitExceeded"; errorDescription: "The website contains too many versions. You must delete an old version before uploading a new one."; errorInstanceId: string; parameters: { versionLimit: unknown; }; } /** * The widget set contains too many versions. You must delete an old version before uploading a new one. * * Log Safety: SAFE */ declare interface VersionLimitExceeded_2 { errorCode: "INVALID_ARGUMENT"; errorName: "VersionLimitExceeded"; errorDescription: "The widget set contains too many versions. You must delete an old version before uploading a new one."; errorInstanceId: string; parameters: { versionLimit: unknown; }; } /** * The given Version could not be found. * * Log Safety: UNSAFE */ declare interface VersionNotFound { errorCode: "NOT_FOUND"; errorName: "VersionNotFound"; errorDescription: "The given Version could not be found."; errorInstanceId: string; parameters: { thirdPartyApplicationRid: unknown; versionVersion: unknown; }; } export declare namespace Versions { export { deleteVersion, list_38 as list, get_69 as get, upload_5 as upload } } /** * The semantic version of the Website. * * Log Safety: UNSAFE */ declare type VersionVersion = LooselyBrandedString_23<"VersionVersion">; /** * Chunks video into smaller segments of the specified duration. The final chunk may be smaller than the specified duration. * * Log Safety: UNSAFE */ declare interface VideoChunkOperation { chunkDurationMilliseconds: number; chunkIndex: number; } /** * The format of a video media item. * * Log Safety: SAFE */ declare type VideoDecodeFormat = "MP4" | "MKV" | "MOV" | "TS" | "WEBM"; /** * The output format for encoding video. * * Log Safety: UNSAFE */ declare type VideoEncodeFormat = ({ type: "mp4"; } & Mp4VideoContainerFormat) | ({ type: "mov"; } & MovVideoContainerFormat) | ({ type: "mkv"; } & MkvVideoContainerFormat) | ({ type: "ts"; } & TsVideoContainerFormat); /** * Metadata for video media items. * * Log Safety: SAFE */ declare interface VideoMediaItemMetadata { format: VideoDecodeFormat; specification: VideoSpecification; sizeBytes: number; } /** * The operation to perform on the video. * * Log Safety: UNSAFE */ declare type VideoOperation = ({ type: "transcode"; } & TranscodeOperation) | ({ type: "chunk"; } & VideoChunkOperation); /** * Technical specifications for video media items. * * Log Safety: SAFE */ declare interface VideoSpecification { bitRate: number; durationSeconds: number; } /** * The operation to perform for video to archive conversion. * * Log Safety: UNSAFE */ declare type VideoToArchiveOperation = { type: "extractSceneFrames"; } & ExtractSceneFramesOperation; /** * Extracts video frames to an archive format. * * Log Safety: UNSAFE */ declare interface VideoToArchiveTransformation { encoding: ArchiveEncodeFormat; operation: VideoToArchiveOperation; } /** * The operation to perform for video to audio conversion. * * Log Safety: UNSAFE */ declare type VideoToAudioOperation = { type: "extractAudio"; } & ExtractAudioOperation; /** * Extracts audio from video. * * Log Safety: UNSAFE */ declare interface VideoToAudioTransformation { encoding: AudioEncodeFormat; operation: VideoToAudioOperation; } /** * The operation to perform for video to image conversion. * * Log Safety: UNSAFE */ declare type VideoToImageOperation = ({ type: "extractFirstFrame"; } & ExtractFirstFrameOperation) | ({ type: "extractFramesAtTimestamps"; } & ExtractFramesAtTimestampsOperation); /** * Extracts video frames as images. * * Log Safety: UNSAFE */ declare interface VideoToImageTransformation { encoding: ImageryEncodeFormat; operation: VideoToImageOperation; } /** * The operation to perform for video to text conversion. * * Log Safety: UNSAFE */ declare type VideoToTextOperation = { type: "getTimestampsForSceneFrames"; } & GetTimestampsForSceneFramesOperation; /** * Extracts metadata from video as text/JSON. * * Log Safety: UNSAFE */ declare interface VideoToTextTransformation { operation: VideoToTextOperation; } /** * Transforms video media items. * * Log Safety: UNSAFE */ declare interface VideoTransformation { encoding: VideoEncodeFormat; operation: VideoOperation; } /** * Log Safety: UNSAFE */ declare interface View { viewName: DatasetName; datasetRid: _Core.DatasetRid; parentFolderRid: _Filesystem.FolderRid; branch?: _Core.BranchName; backingDatasets: Array; primaryKey?: ViewPrimaryKey; } /** * One of the Datasets backing a View. * * Log Safety: UNSAFE */ declare interface ViewBackingDataset { branch?: _Core.BranchName; datasetRid: _Core.DatasetRid; stopPropagatingMarkingIds: Array<_Core.MarkingId>; } /** * Failed to delete dataset following View creation failure. * * Log Safety: SAFE */ declare interface ViewDatasetCleanupFailed { errorCode: "INTERNAL"; errorName: "ViewDatasetCleanupFailed"; errorDescription: "Failed to delete dataset following View creation failure."; errorInstanceId: string; parameters: { viewDatasetRid: unknown; }; } /** * The requested View could not be found. Either the view does not exist, the branch is not valid or the client token does not have access to it. * * Log Safety: UNSAFE */ declare interface ViewNotFound { errorCode: "NOT_FOUND"; errorName: "ViewNotFound"; errorDescription: "The requested View could not be found. Either the view does not exist, the branch is not valid or the client token does not have access to it."; errorInstanceId: string; parameters: { viewDatasetRid: unknown; branch: unknown; }; } /** * No view for the provided view RID provided could be found. * * Log Safety: SAFE */ declare interface ViewNotFound_2 { errorCode: "NOT_FOUND"; errorName: "ViewNotFound"; errorDescription: "No view for the provided view RID provided could be found."; errorInstanceId: string; parameters: { viewRid: unknown; }; } /** * The provided token does not have permission to view any data sources backing this object type. Ensure the object type has backing data sources configured and visible. * * Log Safety: UNSAFE */ declare interface ViewObjectPermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "ViewObjectPermissionDenied"; errorDescription: "The provided token does not have permission to view any data sources backing this object type. Ensure the object type has backing data sources configured and visible."; errorInstanceId: string; parameters: { objectType: unknown; }; } /** * The primary key of the dataset. Primary keys are treated as guarantees provided by the creator of the dataset. * * Log Safety: UNSAFE */ declare interface ViewPrimaryKey { columns: Array; resolution: ViewPrimaryKeyResolution; } /** * A primary key already exits. * * Log Safety: SAFE */ declare interface ViewPrimaryKeyCannotBeModified { errorCode: "CONFLICT"; errorName: "ViewPrimaryKeyCannotBeModified"; errorDescription: "A primary key already exits."; errorInstanceId: string; parameters: {}; } /** * The deletion column is not present in the dataset. * * Log Safety: UNSAFE */ declare interface ViewPrimaryKeyDeletionColumnNotInDatasetSchema { errorCode: "INVALID_ARGUMENT"; errorName: "ViewPrimaryKeyDeletionColumnNotInDatasetSchema"; errorDescription: "The deletion column is not present in the dataset."; errorInstanceId: string; parameters: { deletionColumn: unknown; }; } /** * No columns were provided as part of the primary key * * Log Safety: SAFE */ declare interface ViewPrimaryKeyMustContainAtLeastOneColumn { errorCode: "INVALID_ARGUMENT"; errorName: "ViewPrimaryKeyMustContainAtLeastOneColumn"; errorDescription: "No columns were provided as part of the primary key"; errorInstanceId: string; parameters: {}; } /** * Cannot add a primary key to a View that does not have any backing datasets. * * Log Safety: SAFE */ declare interface ViewPrimaryKeyRequiresBackingDatasets { errorCode: "INVALID_ARGUMENT"; errorName: "ViewPrimaryKeyRequiresBackingDatasets"; errorDescription: "Cannot add a primary key to a View that does not have any backing datasets."; errorInstanceId: string; parameters: {}; } /** * Specifies how primary key conflicts are resolved within the view. * * Log Safety: UNSAFE */ declare type ViewPrimaryKeyResolution = ({ type: "unique"; } & PrimaryKeyResolutionUnique) | ({ type: "duplicate"; } & PrimaryKeyResolutionDuplicate); /** * The resource identifier (RID) of the view that represents a stream. * * Log Safety: SAFE */ declare type ViewRid = LooselyBrandedString_22<"ViewRid">; export declare namespace Views { export { create_12 as create, get_24 as get, addBackingDatasets, replaceBackingDatasets, removeBackingDatasets, addPrimaryKey } } /** * Log Safety: UNSAFE */ declare interface VirtualTable { rid: TableRid_3; name: TableName; parentRid: _Filesystem.FolderRid; config: VirtualTableConfig; markings?: Array<_Core.MarkingId>; } /** * A VirtualTable with the same name already exists in the parent folder. * * Log Safety: UNSAFE */ declare interface VirtualTableAlreadyExists { errorCode: "CONFLICT"; errorName: "VirtualTableAlreadyExists"; errorDescription: "A VirtualTable with the same name already exists in the parent folder."; errorInstanceId: string; parameters: { parentRid: unknown; name: unknown; }; } /** * Log Safety: UNSAFE */ declare type VirtualTableConfig = ({ type: "snowflake"; } & SnowflakeVirtualTableConfig) | ({ type: "unity"; } & UnityVirtualTableConfig) | ({ type: "glue"; } & GlueVirtualTableConfig) | ({ type: "delta"; } & DeltaVirtualTableConfig) | ({ type: "iceberg"; } & IcebergVirtualTableConfig) | ({ type: "files"; } & FilesVirtualTableConfig) | ({ type: "bigquery"; } & BigQueryVirtualTableConfig); /** * User lacks permission to use the specified connection for virtual table registration. * * Log Safety: SAFE */ declare interface VirtualTableRegisterFromSourcePermissionDenied { errorCode: "PERMISSION_DENIED"; errorName: "VirtualTableRegisterFromSourcePermissionDenied"; errorDescription: "User lacks permission to use the specified connection for virtual table registration."; errorInstanceId: string; parameters: {}; } export declare namespace VirtualTables { export { create_17 as create } } /** * Format in which to return text extracted by vision language models. * * Log Safety: SAFE */ declare type VlmOutputFormat = "MARKDOWN"; /** * Preprocessing configuration for VLM extraction. * * Log Safety: UNSAFE */ declare type VlmPreprocessingConfig = ({ type: "layoutAware"; } & LayoutAwarePreprocessingWrapper) | ({ type: "extractText"; } & ExtractTextPreprocessingWrapper); /** * Log Safety: SAFE */ declare interface VoidType { } /** * Generates waveform visualization data from audio. Returns JSON with normalized doubles (0-1) representing amplitude. * * Log Safety: UNSAFE */ declare interface WaveformOperation { peaksPerSecond: number; } /** * WAV audio format with optional sample rate and channel layout. * * Log Safety: UNSAFE */ declare interface WavEncodeFormat { sampleRate?: number; audioChannelLayout?: AudioChannelLayout; } /** * The unique resource identifier of a webhook, useful for interacting with other Foundry APIs. * * Log Safety: SAFE */ declare type WebhookRid = LooselyBrandedString_5<"WebhookRid">; /** * Returns action types which reference the webhook with the given rid. * * Log Safety: SAFE */ declare interface WebhookRidActionTypesQueryV2 { value: WebhookRid; } /** * WebP image format. * * Log Safety: SAFE */ declare interface WebpFormat { } /** * Log Safety: UNSAFE */ declare interface Website { deployedVersion?: VersionVersion; subdomains: Array; } /** * The given Website could not be found. * * Log Safety: SAFE */ declare interface WebsiteNotFound { errorCode: "NOT_FOUND"; errorName: "WebsiteNotFound"; errorDescription: "The given Website could not be found."; errorInstanceId: string; parameters: { thirdPartyApplicationRid: unknown; }; } export declare namespace Websites { export { get_70 as get, deploy, undeploy } } /** * The settings for a given widget in development mode. * * Log Safety: UNSAFE */ declare interface WidgetDevModeSettings { scriptEntrypoints: Array; stylesheetEntrypoints: Array; } /** * The settings for a given widget in development mode (v2). * * Log Safety: UNSAFE */ declare interface WidgetDevModeSettingsV2 { name?: string; description?: string; scriptEntrypoints: Array; stylesheetEntrypoints: Array; } /** * Human readable ID for a widget. Must be unique within a widget set. Considered unsafe as it may contain user defined data. Must only contain the following ASCII characters: a-z, A-Z and 0-9. Must not start with a number. Must have a maximum length of 100. Must be camelCase. * * Log Safety: UNSAFE */ declare type WidgetId = LooselyBrandedString_24<"WidgetId">; /** * A non-existent widget id was provided. If creating a new widget, you must first publish your changes before previewing with developer mode. * * Log Safety: UNSAFE */ declare interface WidgetIdNotFound { errorCode: "NOT_FOUND"; errorName: "WidgetIdNotFound"; errorDescription: "A non-existent widget id was provided. If creating a new widget, you must first publish your changes before previewing with developer mode."; errorInstanceId: string; parameters: { widgetSetRid: unknown; widgetId: unknown; }; } /** * The widget set contains too many widgets. You must delete another widget before creating a new one. * * Log Safety: SAFE */ declare interface WidgetLimitExceeded { errorCode: "INVALID_ARGUMENT"; errorName: "WidgetLimitExceeded"; errorDescription: "The widget set contains too many widgets. You must delete another widget before creating a new one."; errorInstanceId: string; parameters: { widgetLimit: unknown; }; } /** * A Resource Identifier (RID) identifying a widget. * * Log Safety: SAFE */ declare type WidgetRid = LooselyBrandedString_24<"WidgetRid">; export declare namespace Widgets { export { DevModeSettings, DevModeSettingsV2, DevModeSnapshot, DevModeSnapshotId, DevModeStatus, FilePath_2 as FilePath, ListReleasesResponse, OntologySdkInputSpec, OntologySdkPackageRid, OntologySdkVersion, Release, ReleaseLocator, ReleaseVersion, Repository, RepositoryRid, RepositoryVersion, ScriptEntrypoint, ScriptType, SetWidgetSetDevModeSettingsByIdRequest, SetWidgetSetManifestDevModeSettingsV2Request, StylesheetEntrypoint, WidgetDevModeSettings, WidgetDevModeSettingsV2, WidgetId, WidgetRid, WidgetSet, WidgetSetDevModeSettings, WidgetSetDevModeSettingsById, WidgetSetDevModeSettingsV2, WidgetSetInputSpec, WidgetSetRid, DeleteReleasePermissionDenied, EnableDevModeSettingsPermissionDenied, EnableDevModeSettingsV2PermissionDenied, FileCountLimitExceeded_2 as FileCountLimitExceeded, FileSizeLimitExceeded_3 as FileSizeLimitExceeded, InvalidDevModeBaseHref, InvalidDevModeEntrypointCssCount, InvalidDevModeEntrypointJsCount, InvalidDevModeFilePath, InvalidDevModeWidgetSettingsCount, InvalidEntrypointCssCount, InvalidEntrypointJsCount, InvalidEventCount, InvalidEventDisplayName, InvalidEventId, InvalidEventParameter, InvalidEventParameterCount, InvalidEventParameterId, InvalidEventParameterUpdateId, InvalidFilePath_2 as InvalidFilePath, InvalidManifest, InvalidObjectSetEventParameterType, InvalidObjectSetParameterType, InvalidParameterCount, InvalidParameterDisplayName, InvalidParameterId, InvalidPublishRepository, InvalidReleaseDescription, InvalidReleaseWidgetsCount, InvalidVersion_2 as InvalidVersion, InvalidWidgetDescription, InvalidWidgetId, InvalidWidgetName, OntologySdkNotFound, PublishReleasePermissionDenied, ReleaseNotFound, RepositoryNotFound, SetWidgetSetDevModeSettingsByIdPermissionDenied, SetWidgetSetManifestDevModeSettingsV2PermissionDenied, VersionAlreadyExists_2 as VersionAlreadyExists, VersionLimitExceeded_2 as VersionLimitExceeded, WidgetIdNotFound, WidgetLimitExceeded, WidgetSetNotFound, WidgetsDevModeSettings, WidgetsDevModeSettingsV2, Releases, Repositories, WidgetSets } } declare namespace _Widgets { export { LooselyBrandedString_24 as LooselyBrandedString, DevModeSettings, DevModeSettingsV2, DevModeSnapshot, DevModeSnapshotId, DevModeStatus, FilePath_2 as FilePath, ListReleasesResponse, OntologySdkInputSpec, OntologySdkPackageRid, OntologySdkVersion, Release, ReleaseLocator, ReleaseVersion, Repository, RepositoryRid, RepositoryVersion, ScriptEntrypoint, ScriptType, SetWidgetSetDevModeSettingsByIdRequest, SetWidgetSetManifestDevModeSettingsV2Request, StylesheetEntrypoint, WidgetDevModeSettings, WidgetDevModeSettingsV2, WidgetId, WidgetRid, WidgetSet, WidgetSetDevModeSettings, WidgetSetDevModeSettingsById, WidgetSetDevModeSettingsV2, WidgetSetInputSpec, WidgetSetRid } } export declare namespace WidgetsDevModeSettings { export { } } export declare namespace WidgetsDevModeSettingsV2 { export { } } /** * Log Safety: SAFE */ declare interface WidgetSet { rid: WidgetSetRid; publishRepositoryRid?: RepositoryRid; } /** * The settings for a widget set in development mode, keyed by widget RID. * * Log Safety: UNSAFE */ declare interface WidgetSetDevModeSettings { baseHref: string; widgetSettings: Record; } /** * The settings for a widget set in development mode, keyed by widget ID. * * Log Safety: UNSAFE */ declare interface WidgetSetDevModeSettingsById { baseHref: string; widgetSettings: Record; } /** * The settings for a widget set in development mode (v2), keyed by widget ID. * * Log Safety: UNSAFE */ declare interface WidgetSetDevModeSettingsV2 { baseHref: string; inputSpec?: WidgetSetInputSpec; widgetSettings: Record; } /** * A specification of the Foundry data inputs that a widget set uses. This restricts the data access that a widget set has at runtime. * * Log Safety: SAFE */ declare interface WidgetSetInputSpec { sdks: Array; } /** * The given WidgetSet could not be found. * * Log Safety: SAFE */ declare interface WidgetSetNotFound { errorCode: "NOT_FOUND"; errorName: "WidgetSetNotFound"; errorDescription: "The given WidgetSet could not be found."; errorInstanceId: string; parameters: { widgetSetRid: unknown; }; } /** * A Resource Identifier (RID) identifying a widget set. * * Log Safety: SAFE */ declare type WidgetSetRid = LooselyBrandedString_24<"WidgetSetRid">; export declare namespace WidgetSets { export { } } /** * Returns objects where the specified field matches the wildcard pattern provided. Either field or propertyIdentifier can be supplied, but not both. * * Log Safety: UNSAFE */ declare interface WildcardQuery { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: string; } /** * @deprecated Use `WithinBoundingBoxPoint` in the `foundry.ontologies` package * * Log Safety: UNSAFE */ declare type WithinBoundingBoxPoint = { type: "Point"; } & _Geo.GeoPoint; /** * Log Safety: UNSAFE */ declare type WithinBoundingBoxPoint_2 = { type: "Point"; } & _Geo.GeoPoint; /** * @deprecated Use `WithinBoundingBoxQuery` in the `foundry.ontologies` package * * Returns objects where the specified field contains a point within the bounding box provided. * * Log Safety: UNSAFE */ declare interface WithinBoundingBoxQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: BoundingBoxValue; } /** * Returns objects where the specified field contains a point within the bounding box provided. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface WithinBoundingBoxQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: BoundingBoxValue_2; } /** * @deprecated Use `WithinDistanceOfQuery` in the `foundry.ontologies` package * * Returns objects where the specified field contains a point within the distance provided of the center point. * * Log Safety: UNSAFE */ declare interface WithinDistanceOfQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: CenterPoint; } /** * Returns objects where the specified field contains a point within the distance provided of the center point. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface WithinDistanceOfQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: CenterPoint_2; } /** * @deprecated Use `WithinPolygonQuery` in the `foundry.ontologies` package * * Returns objects where the specified field contains a point within the polygon provided. * * Log Safety: UNSAFE */ declare interface WithinPolygonQuery { field?: PropertyApiName; propertyIdentifier?: PropertyIdentifier; value: PolygonValue; } /** * Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both. * * Log Safety: UNSAFE */ declare interface WithinPolygonQuery_2 { field?: PropertyApiName_2; propertyIdentifier?: PropertyIdentifier_2; value: PolygonValue_2; } /** * Authenticate as a service principal using workload identity federation. This is the recommended way to connect to Databricks. Workload identity federation allows workloads running in Foundry to access Databricks APIs without the need for Databricks secrets. Refer to our OIDC documentation for an overview of how OpenID Connect is supported in Foundry. A service principal federation policy must exist in Databricks to allow Foundry to act as an identity provider. Refer to the official documentation for guidance. * * Log Safety: UNSAFE */ declare interface WorkflowIdentityFederation { servicePrincipalApplicationId?: string; issuerUrl: string; audience: string; subject: ConnectionRid; } /* Excluded from this release type: yaml */ /** * Yjs-backed schema storage. If schema is empty, the schema for this document type could not be found — this can happen for older document types that never persisted their schema; use the updateSchema endpoint to populate it. * * Log Safety: UNSAFE */ declare interface YjsSchema { schema?: DocumentTypeSchema; } /** * Log Safety: UNSAFE */ declare interface YjsUpdate { data: any; } /** * A string representation of a java.time.ZoneId * * Log Safety: SAFE */ declare type ZoneId = LooselyBrandedString<"ZoneId">; export { }