Skip to content

QueryObjectsInput

Source code in docs_src/capo_data_pipeline/types/query_objects_input.py 
16
17
18
19
20
21
22
23
24
25
26
class QueryObjectsInput(TypedDict, closed=True):
    pipeline_id: "capo_data_pipeline.types.id.id"
    """<p>The ID of the pipeline.</p>"""
    query: NotRequired["capo_data_pipeline.types.query.Query"]
    """<p>The query that defines the objects to be returned. The <code>Query</code> object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.</p>"""
    sphere: "capo_data_pipeline.types.string.string"
    """<p>Indicates whether the query applies to components or instances. The possible values are: <code>COMPONENT</code>, <code>INSTANCE</code>, and <code>ATTEMPT</code>.</p>"""
    marker: NotRequired["capo_data_pipeline.types.string.string"]
    """<p>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>QueryObjects</code> with the marker value from the previous call to retrieve the next set of results.</p>"""
    limit: NotRequired["capo_data_pipeline.types.int.int"]
    """<p>The maximum number of object names that <code>QueryObjects</code> will return in a single call. The default value is 100. </p>"""

limit instance-attribute 

limit: NotRequired[int]

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

marker instance-attribute 

marker: NotRequired[string]

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

pipeline_id instance-attribute 

pipeline_id: id

The ID of the pipeline.

query instance-attribute 

query: NotRequired[Query]

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

sphere instance-attribute 

sphere: string

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.