/** * Synapse REST API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { SearchSearchQuery } from './SearchSearchQuery'; /** * Async request to query a SearchIndex entity's OpenSearch index. Identifies the target index and carries the search parameters. * @export * @interface SearchIndexQuery */ export interface SearchIndexQuery { /** * * @type {string} * @memberof SearchIndexQuery */ concreteType: SearchIndexQueryConcreteTypeEnum; /** * The ID of the SearchIndex entity to query. * @type {string} * @memberof SearchIndexQuery */ searchIndexId?: string; /** * * @type {SearchSearchQuery} * @memberof SearchIndexQuery */ searchQuery?: SearchSearchQuery; /** * Optional list of additional parts to include in the SearchQueryResults beyond the default HITS + offset. Null or empty means HITS only (the default minimal payload). Requesting parts also drives the corresponding work in OpenSearch (aggregations, total-hit tracking). * @type {Set} * @memberof SearchIndexQuery */ responseParts?: Set; } /** * @export */ export declare const SearchIndexQueryConcreteTypeEnum: { readonly org_sagebionetworks_repo_model_search_table_SearchIndexQuery: "org.sagebionetworks.repo.model.search.table.SearchIndexQuery"; }; export type SearchIndexQueryConcreteTypeEnum = typeof SearchIndexQueryConcreteTypeEnum[keyof typeof SearchIndexQueryConcreteTypeEnum]; /** * @export */ export declare const SearchIndexQueryResponsePartsEnum: { readonly HITS: "HITS"; readonly TOTAL_HITS: "TOTAL_HITS"; readonly SELECT_COLUMNS: "SELECT_COLUMNS"; readonly FACETS: "FACETS"; }; export type SearchIndexQueryResponsePartsEnum = typeof SearchIndexQueryResponsePartsEnum[keyof typeof SearchIndexQueryResponsePartsEnum]; /** * Check if a given object implements the SearchIndexQuery interface. */ export declare function instanceOfSearchIndexQuery(value: object): value is SearchIndexQuery; export declare function SearchIndexQueryFromJSON(json: any): SearchIndexQuery; export declare function SearchIndexQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchIndexQuery; export declare function SearchIndexQueryToJSON(json: any): SearchIndexQuery; export declare function SearchIndexQueryToJSONTyped(value?: SearchIndexQuery | null, ignoreDiscriminator?: boolean): any;