Skip to content

ResourceCount

Source code in docs_src/capo_resource_explorer_2/types/resource_count.py
class ResourceCount(TypedDict, closed=True):
    total_resources: NotRequired["int"]
    """<p>The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the <code>Complete</code> field is set to false. We recommend that you refine your query to return a smaller number of results.</p>"""
    complete: NotRequired["bool"]
    """<p>Indicates whether the <code>TotalResources</code> value represents an exhaustive count of search results.</p> <ul> <li> <p>If <code>True</code>, it indicates that the search was exhaustive. Every resource that matches the query was counted.</p> </li> <li> <p>If <code>False</code>, then the search reached the limit of 1,000 matching results, and stopped counting.</p> </li> </ul>"""

complete instance-attribute

complete: NotRequired[bool]

Indicates whether the TotalResources value represents an exhaustive count of search results.

  • If True, it indicates that the search was exhaustive. Every resource that matches the query was counted.

  • If False, then the search reached the limit of 1,000 matching results, and stopped counting.

total_resources instance-attribute

total_resources: NotRequired[int]

The number of resources that match the search query. This value can't exceed 1,000. If there are more than 1,000 resources that match the query, then only 1,000 are counted and the Complete field is set to false. We recommend that you refine your query to return a smaller number of results.