public class SearchesClientImpl extends ApiClient implements SearchesClient
baseUrl, httpClient, objectMapper| Constructor and Description |
|---|
SearchesClientImpl(String baseUrl,
kong.unirest.UnirestInstance httpClient) |
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<ODataValueOfBoolean> |
cancelOrCloseSearch(String repoId,
String searchToken)
- Cancels a currently running search.
|
CompletableFuture<AcceptedOperation> |
createSearchOperation(String repoId,
AdvancedSearchRequest requestBody)
- Runs a search operation on the repository.
|
CompletableFuture<ODataValueContextOfIListOfContextHit> |
getSearchContextHits(String repoId,
String searchToken,
Integer rowNumber,
String prefer,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
- Returns the context hits associated with a search result entry.
|
CompletableFuture<Void> |
getSearchContextHitsForEach(Function<CompletableFuture<ODataValueContextOfIListOfContextHit>,CompletableFuture<Boolean>> callback,
Integer maxPageSize,
String repoId,
String searchToken,
Integer rowNumber,
String prefer,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
Provides the functionality to iteratively (i.e.
|
CompletableFuture<ODataValueContextOfIListOfContextHit> |
getSearchContextHitsNextLink(String nextLink,
Integer maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
CompletableFuture<ODataValueContextOfIListOfEntry> |
getSearchResults(String repoId,
String searchToken,
Boolean groupByEntryType,
Boolean refresh,
String[] fields,
Boolean formatFields,
String prefer,
String culture,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
- Returns a search result listing if the search is completed.
|
CompletableFuture<Void> |
getSearchResultsForEach(Function<CompletableFuture<ODataValueContextOfIListOfEntry>,CompletableFuture<Boolean>> callback,
Integer maxPageSize,
String repoId,
String searchToken,
Boolean groupByEntryType,
Boolean refresh,
String[] fields,
Boolean formatFields,
String prefer,
String culture,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
Provides the functionality to iteratively (i.e.
|
CompletableFuture<ODataValueContextOfIListOfEntry> |
getSearchResultsNextLink(String nextLink,
Integer maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
CompletableFuture<OperationProgress> |
getSearchStatus(String repoId,
String searchToken)
- Returns search status.
|
decideErrorMessage, deserializeToProblemDetails, getHeadersMap, getNonNullParameters, mergeMaxSizeIntoPrefer, toJsonpublic SearchesClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient)
public CompletableFuture<OperationProgress> getSearchStatus(String repoId, String searchToken)
SearchesClientgetSearchStatus in interface SearchesClientrepoId - The requested repository ID.searchToken - The requested searchToken.public CompletableFuture<ODataValueOfBoolean> cancelOrCloseSearch(String repoId, String searchToken)
SearchesClientcancelOrCloseSearch in interface SearchesClientrepoId - The requested repository ID.searchToken - The requested searchToken.public CompletableFuture<ODataValueContextOfIListOfContextHit> getSearchContextHits(String repoId, String searchToken, Integer rowNumber, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)
SearchesClientgetSearchContextHits in interface SearchesClientrepoId - The requested repository ID.searchToken - The requested searchToken.rowNumber - The search result listing row number to get context hits for.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<ODataValueContextOfIListOfContextHit> getSearchContextHitsNextLink(String nextLink, Integer maxPageSize)
SearchesClientgetSearchContextHitsNextLink in interface SearchesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.public CompletableFuture<Void> getSearchContextHitsForEach(Function<CompletableFuture<ODataValueContextOfIListOfContextHit>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, String searchToken, Integer rowNumber, String prefer, String select, String orderby, Integer top, Integer skip, Boolean count)
SearchesClientgetSearchContextHitsForEach in interface SearchesClientcallback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.repoId - The requested repository ID.searchToken - The requested searchToken.rowNumber - The search result listing row number to get context hits for.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<AcceptedOperation> createSearchOperation(String repoId, AdvancedSearchRequest requestBody)
SearchesClientcreateSearchOperation in interface SearchesClientrepoId - The requested repository ID.requestBody - The Laserfiche search command to run, optionally include fuzzy search settings.public CompletableFuture<ODataValueContextOfIListOfEntry> getSearchResults(String repoId, String searchToken, Boolean groupByEntryType, Boolean refresh, String[] fields, Boolean formatFields, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)
SearchesClientgetSearchResults in interface SearchesClientrepoId - The requested repository ID.searchToken - The requested searchToken.groupByEntryType - An optional query parameter used to indicate if the result should be grouped by entry type or not.refresh - If the search listing should be refreshed to show updated values.fields - Optional array of field names. Field values corresponding to the given field names will be returned for each search result.formatFields - Boolean for if field values should be formatted. Only applicable if Fields are specified.prefer - An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.culture - An optional query parameter used to indicate the locale that should be used for formatting.
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
culture will not be used for formatting.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.public CompletableFuture<ODataValueContextOfIListOfEntry> getSearchResultsNextLink(String nextLink, Integer maxPageSize)
SearchesClientgetSearchResultsNextLink in interface SearchesClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.public CompletableFuture<Void> getSearchResultsForEach(Function<CompletableFuture<ODataValueContextOfIListOfEntry>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, String searchToken, Boolean groupByEntryType, Boolean refresh, String[] fields, Boolean formatFields, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)
SearchesClientgetSearchResultsForEach in interface SearchesClientcallback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.repoId - The requested repository ID.searchToken - The requested searchToken.groupByEntryType - An optional query parameter used to indicate if the result should be grouped by entry type or not.refresh - If the search listing should be refreshed to show updated values.fields - Optional array of field names. Field values corresponding to the given field names will be returned for each search result.formatFields - Boolean for if field values should be formatted. Only applicable if Fields are specified.prefer - An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.culture - An optional query parameter used to indicate the locale that should be used for formatting.
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
culture will not be used for formatting.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.Copyright © 2022. All rights reserved.