mate_rest_client.pois module

Python API bindings for POI endpoints in the MATE REST API.

class mate_rest_client.pois.POI(client: mate_rest_client.Client, info: POIResultInfo)

Bases: mate_rest_client.common.APIModel

Represents a POI in MATE.

property analysis_id: str

Returns the identifier of the analysis that produced this POI.

property analysis_name: str

Returns the name of the analysis that produced this POI.

property build_id: str

Returns the identifier of the build associated with this POI.

property child_ids: List[str]

Returns any child POIs that were produced as a result of this POI.

property complexity: mate_common.models.analyses.POIResultComplexity

Returns the estimated complexity of the POI.

property detail: mate_common.models.analyses.POIResultInfo

Returns a struct containing extra details about the POI.

property done: bool

Returns whether the POI has been marked as done

property flagged: bool

Returns whether the POI has been marked as flagged.

property id_: str

Returns a unique identifier for this POI.

property parent_id: Optional[str]

Returns the identifier of the parent POI if the POI was created from a parent.

property raw_data: Dict[str, Any]

Returns the raw POI result.

refresh() → None

Refresh the internal state of this POI.

Return type

None

property task_id: str

Returns the identifier of the analysis task associated with this POI.

class mate_rest_client.pois.POIRoutes(client: mate_rest_client.Client)

Bases: mate_rest_client.common.Routes

An adapter for interactions with POI endpoints.

Parameters

client (mate_rest_client.Client) –

Return type

None