SearchResultCollection

class oci.data_catalog.models.SearchResultCollection(**kwargs)

Bases: object

The list of search result items matching the criteria returned from the search operation. Search errors and messages, if any , will be part of the standard error response.

Methods:

__init__(**kwargs)

Initializes a new SearchResultCollection object with values from keyword arguments.

Attributes:

count

Gets the count of this SearchResultCollection.

faceted_search_aggregation

Gets the faceted_search_aggregation of this SearchResultCollection.

items

Gets the items of this SearchResultCollection.

query

Gets the query of this SearchResultCollection.

sortable_fields

Gets the sortable_fields of this SearchResultCollection.

__init__(**kwargs)

Initializes a new SearchResultCollection object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • count (int) – The value to assign to the count property of this SearchResultCollection.

  • items (list[oci.data_catalog.models.SearchResult]) – The value to assign to the items property of this SearchResultCollection.

  • query (str) – The value to assign to the query property of this SearchResultCollection.

  • faceted_search_aggregation (list[oci.data_catalog.models.FacetedSearchAggregation]) – The value to assign to the faceted_search_aggregation property of this SearchResultCollection.

  • sortable_fields (list[str]) – The value to assign to the sortable_fields property of this SearchResultCollection.

property count

Gets the count of this SearchResultCollection. Total number of items returned.

Returns

The count of this SearchResultCollection.

Return type

int

property faceted_search_aggregation

Gets the faceted_search_aggregation of this SearchResultCollection. Aggregations/facets on properties of data objects.

Returns

The faceted_search_aggregation of this SearchResultCollection.

Return type

list[oci.data_catalog.models.FacetedSearchAggregation]

property items

Gets the items of this SearchResultCollection. Search result set.

Returns

The items of this SearchResultCollection.

Return type

list[oci.data_catalog.models.SearchResult]

property query

Gets the query of this SearchResultCollection. String that data objects are to be searched with.

Returns

The query of this SearchResultCollection.

Return type

str

property sortable_fields

Gets the sortable_fields of this SearchResultCollection. A list of fields or properties used in the sorting of a search result.

Returns

The sortable_fields of this SearchResultCollection.

Return type

list[str]