iudx.cat package

Submodules

iudx.cat.Catalogue module

Module doc string. Leave empty for now.

Catalogue.py

class iudx.cat.Catalogue.Catalogue(cat_url: Optional[str] = None, token: Optional[str] = None, headers: Optional[Dict[str, str]] = None)

Bases: object

Abstract class for Catalogue. Helps to create a modular interface for the API to implement queries.

count_entity(query: iudx.cat.CatalogueQuery.CatalogueQuery) → iudx.cat.CatalogueResult.CatalogueResult

Method to get the count response for entities, based on a query.

Parameters

query (CatalogueQuery) – A query object of CatalogueQuery class.

Returns

returns a CatalogueResult object.

Return type

cat_result (CatalogueResult)

create(item: Dict[str, Any]) → iudx.cat.CatalogueResult.CatalogueResult

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

delete(iid: str) → iudx.cat.CatalogueResult.CatalogueResult

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

get_item(iid: str) → iudx.cat.CatalogueResult.CatalogueResult

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

get_related_entity(iid: str, rel: str) → iudx.cat.CatalogueResult.CatalogueResult

Method to get the relationship response for entities,

based on their id and relation.

Parameters

• iid (String) – Id of the entity.

• rel (String) – Relationship attribute of the entity whose id is provided.

Returns

returns a CatalogueResult object.

Return type

cat_result (CatalogueResult)

list_entity(entity_type: str) → iudx.cat.CatalogueResult.CatalogueResult

Method to get the list response for entities, based on an entity type.

Parameters

entity_type (String) – type must be either resource, resourceGroup, resourceServer.

Returns

returns a CatalogueResult object.

Return type

cat_result (CatalogueResult)

rel_search(query: iudx.cat.CatalogueQuery.CatalogueQuery) → iudx.cat.CatalogueResult.CatalogueResult

Pydoc heading. TODO: Implement the query for relationship search in CatalogueQuery before this function defination.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

search_entity(query: iudx.cat.CatalogueQuery.CatalogueQuery) → iudx.cat.CatalogueResult.CatalogueResult

Method to get the search response for entities, based on a query.

Parameters

query (CatalogueQuery) – A query object of CatalogueQuery class.

Returns

returns a CatalogueResult object.

Return type

cat_result (CatalogueResult)

status() → bool

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

update(item: Dict[str, Any]) → iudx.cat.CatalogueResult.CatalogueResult

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

update_token(token: str) → None

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

validate(item: Dict[str, Any]) → bool

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

iudx.cat.CatalogueQuery module

Module doc string. Leave empty for now.

CatalogueQuery.py

class iudx.cat.CatalogueQuery.CatalogueQuery

Bases: object

Abstract class for Catalogue Query. Helps to create a modular interface for the API to construct query in Python.

add_filters(filters: Optional[List[str]] = None) → T

Method to instantiate query for filter based search.

Parameters

filters (List[str]) – Filters to be filtered.

geo_search(geoproperty: Optional[str] = None, geometry: Optional[str] = None, georel: Optional[str] = None, max_distance: Optional[int] = None, coordinates: Optional[List[Any]] = None) → T

Method to instantiate query for geo based search.

TODO: Need to validate input params here.

Parameters

• geoproperty (String) – Which geoproperty to query.

• geometry (String) – GeoJson geometries.

• georel (String) – Geo-relationship.

• max_distance (Integer) – Radius from the center in meters.

• coordinates (List[Any]) – The Coordinates of the geometry.

get_query() → str

Method to build query for geo, text, propery and filter.

Returns

options as a string for the generated query.

Return type

opts (String)

property_search(key: Optional[str] = None, value: Optional[List[str]] = None) → T

Method to instantiate query for property based search.

Parameters

• key (String) – Property key to tag the values for search.

• value (List[str]) – List of values to be searched.

text_search(text_query: Optional[str] = None) → T

Method to instantiate query for text based search.

Parameters

text_query (String) – Text to be queried.

iudx.cat.CatalogueResult module

Module doc string. Leave empty for now.

CatalogueResult.py

class iudx.cat.CatalogueResult.CatalogueResult

Bases: object

Abstract class for Resource Result. Helps to create a modular interface for the API response results.

all_pages() → T

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

goto_page(pagenume: int) → T

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

next_page() → T

Pydoc heading.

Parameters

argument (argument-type) – argument-description

Returns

return-variable-description

Return type

returned-varaible (returned-varaible-type)

Module contents