CatalogSearchResponse

pydantic model openapi_client.models.catalog_search_response.CatalogSearchResponse

Full search response, returned when get_metrics is false or omitted. When get_metrics is true the backend returns CatalogSearchMetricsResponse instead, which carries only Metrics and total_count.

Fields:
field results: List[CatalogResultItem] [Required] (alias 'Results')

Matching catalog assets on the current page.

field metrics: Dict[str, Dict[str, StrictInt]] [Required] (alias 'Metrics')

Facet counts for the current search, keyed by facet field and then by value. Facet fields are Domain, DataClassification, TagsAttached, Keywords, FileType, IngestionType, TargetLocation, DatasourceType, AssetType, Tenant, DatasourceName and DataCategory, plus a FieldsToMatch entry. On the semantic search path the FieldsToMatch entry is omitted when the result set is empty.

field count: StrictInt [Required]

Number of assets returned in Results on this page.

Constraints:

  • strict = True

field total_count: StrictInt [Required]

Total number of assets matching the search across all pages.

Constraints:

  • strict = True

field total_pages: StrictInt [Required]

Total number of pages available, computed as total_count divided by limit and rounded up. Zero when limit is zero.

Constraints:

  • strict = True

field next_available: StrictStr [Required]

Whether a further page exists. “yes” means more records remain, so request the next page by incrementing page_number. “no” means this is the last page and the client must stop iterating.

Constraints:

  • strict = True

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of CatalogSearchResponse from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of CatalogSearchResponse from a dict

Return type:

Optional[Self]