def list(self, after_time=None, before_time=None, epsg_code=None, limit=None, meta_string=None, offset=None, shapegrid_id=None): """Gets a list of gridsets matching the provided criteria. Args: after_time (str): Count gridsets modified after this time. before_time (str): Count gridsets modified before this time. epsg_code (int): The integer representing the map projection EPSG code for the gridsets to count. limit (int): The maximum number of records to return in this request. meta_string (str): Metadata string to use to count gridsets. offset (int): Start returned records after this offset (used for paging). shapegrid_id (int): Count gridsets built from the shapegrid with this identifier. Returns: list of dict: A list of JSON dictionaries for matching gridset metadata. """ return RestService.list(self, self.end_point, after_time=after_time, before_time=before_time, epsg_code=epsg_code, limit=limit, meta_string=meta_string, offset=offset, shapegrid_id=shapegrid_id)
def list(self, after_time=None, before_time=None, limit=None, offset=None, scenario_id=None): """Gets a list of scenario package matching the provided criteria. Args: after_time (str): Return scenario packages modified after this time. before_time (str): Return scenario packages modified before this time. limit (int): The maximum number of scenario packages to return. offset (int): Offset the returned scenario packages by this amount. scenario_id (int): Return scenario packages containing this scenario. Returns: list of dict: A list of JSON dictionaries of scenario package metadata for the matching scenario packages. """ return RestService.list(self, self.end_point, after_time=after_time, scenario_id=scenario_id, before_time=before_time, limit=limit, offset=offset)
def list(self, after_time=None, before_time=None, epsg_code=None, limit=None, offset=None, squid=None): """Gets a list of layers matching the specified criteria. Args: after_time (:obj:`str`, optional): Matching layers are modified after this time specified in ISO-8601 format. before_time (:obj:`str`, optional): Matching layers are modified before this time specified in ISO-8601 format. epsg_code (:obj:`int`, optional): Matching layers will have the map projection specified by this EPSG code. limit (:obj:`int`, optional): Return, at most, this many layers. offset (:obj:`int`, optional): Offset the returned layers by this amount. Useful for paging. squid (:obj:`str`, optional): Matching layers will have this hash- based species identifier. Returns: list of dicts - A list of layer dictionary objects with metadata about each one. The response format is JSON. """ return RestService.list(self, self.end_point, after_time=after_time, before_time=before_time, epsg_code=epsg_code, squid=squid, limit=limit, offset=offset)
def list(self, after_time=None, alt_pred_code=None, before_time=None, date_code=None, epsg_code=None, env_code=None, env_type_id=None, gcm_code=None, scenario_id=None, limit=None, offset=None): """Gets a list of environmental layers matching the specified criteria. Args: after_time (:obj:`str`, optional): Matching environmental layers are modified after this time specified in ISO-8601 format. alt_pred_code (:obj:`str`, optional): Matching environmental layers must have this alternate prediction code. before_time (:obj:`str`, optional): Matching environmental layers are modified before this time specified in ISO-8601 format. date_code (:obj:`str`, optional): Matching environmental layers will have this date code. epsg_code (:obj:`int`, optional): Matching environmental layers will have the map projection specified by this EPSG code. env_code (:obj:`str`, optional): Matching environmental layers will have this environment code. env_type_id (:obj:`str`, optional): Matching environmental layers will have this environmental layer type identifier. gcm_code (:obj:`str`, optional): Matching environmental layers will have this GCM code. scenario_id (:obj:`int`, optional): Matching environmental layers will belong to the Lifemapper scenario specified by this identifier. limit (:obj:`int`, optional): Return, at most, this many environmental layers. offset (:obj:`int`, optional): Offset the returned environmental layers by this amount. Useful for paging. Returns: list of dicts - A list of environmental layer dictionary objects with metadata about each one. The response format is JSON. """ return RestService.list(self, self.end_point, after_time=after_time, alt_pred_code=alt_pred_code, before_time=before_time, date_code=date_code, epsg_code=epsg_code, env_code=env_code, env_type_id=env_type_id, gcm_code=gcm_code, scenario_id=scenario_id, limit=limit, offset=offset)
def list(self, after_status=None, after_time=None, algorithm_code=None, before_status=None, before_time=None, display_name=None, epsg_code=None, limit=None, model_scenario_code=None, occurrence_set_id=None, offset=None, projection_scenario_code=None, scenario_id=None, status=None, gridset_id=None): """Gets a list of projections matching the provided criteria. Args: after_status (int): Return projections with a status greater than this. after_time (str): Return projections modified after this time. algorithm_code (str): Return projections built with this algorithm. before_status (int): Return projections with a status less than this. before_time (str): Return projections modified before this time. display_name (str): Return projections with this display name. epsg_code (int): Return projections using this map projection. limit (int): The maximum number of projections to return. model_scenario_code (str): Return projections built from this model. occurrence_set_id (int): Return projections built from this occurrence set. offset (int): Start returned projections after this offset. projection_scenario_code (str): Return projections using this scenario. scenario_id (int): Return projections using this scenario identifier. status (int): Return projections with this exact status. gridset_id (int): Return projections in this gridset. Returns: list of dict: A list of JSON dictionary metadata for matching scenarios. """ return RestService.list( self, self.end_point, after_time=after_time, scenario_id=scenario_id, before_time=before_time, limit=limit, offset=offset, after_status=after_status, algorithm_code=algorithm_code, before_status=before_status, display_name=display_name, epsg_code=epsg_code, model_scenario_code=model_scenario_code, status=status, occurrence_set_id=occurrence_set_id, projection_scenario_code=projection_scenario_code, gridset_id=gridset_id)
def list(self, after_time=None, agent=None, before_time=None, catalog_number=None, collection=None, ident1=None, ident2=None, operation=None, provider=None, url=None, who=None, why=None): """Lists snippets matching the provided criteria. Args: after_time (:obj:`str`, optional): Only return snippets modified after this time (in ISO-8601 format). agent (:obj:`str`, optional): Return snippets initiated by this agent. before_time (:obj:`str`, optional): Only return snippets modified before this time (in ISO-8601 format). catalog_number (:obj:`str`, optional): List snippets for occurrence records with this catalog number. collection (:obj:`str`, optional): List snippets for this collection. ident1 (:obj:`str`, optional): List snippets with this primary object identifier. ident2 (:obj:`str`, optional): List snippets with this secondary object identifier. operation (:obj:`str`, optional): List snippets for this operation. provider (:obj:`str`, optional): List snippets for this occurrence point provider. url (:obj:`str`, optional): List snippets related to this URL. who (:obj:`str`, optional): List snippets created by this entity. why (:obj:`str`, optional): List snippets that were created for this reason. Returns: list of dict: A list of JSON dictionaries for matching snippets. """ return RestService.list(self, self.end_point, after_time=after_time, agent=agent, before_time=before_time, catalog_number=catalog_number, collection=collection, ident1=ident1, ident2=ident2, operation=operation, provider=provider, url=url, who=who, why=why)
def list(self, after_time=None, before_time=None, has_branch_lengths=None, is_binary=None, is_ultrametric=None, limit=None, meta_string=None, name=None, offset=None, user=None): """Lists occurrence sets matching the provided criteria. Args: after_time (:obj:`str`, optional): Only trees modified after this time (in ISO-8601 format). before_time (:obj:`str`, optional): Only return trees modified before this time (in ISO-8601 format). has_branch_lengths (:obj:`bool`, optional): Return trees that have or do not have branch lengths. is_binary (:obj:`bool`, optional): Return trees that are or are not binary. is_ultrametric (:obj:`bool`, optional): Return trees that are or are not ultrametric. limit (:obj:`int`, optional): Return up to this number of trees. meta_string (:obj:`str`, optional): Return trees with this metadata string attached to them. name (:obj:`str`, optional): Return trees that have this name. offset (:obj:`int`, optional): Offset the list of returned trees by this number. user (:obj:`str`, optional): If 'public', return public trees. If 'anon', return anonymous trees. If None, return the user's trees. Returns: list of dict: A list of tree metadata JSON dictionaries. """ return RestService.list(self, self.end_point, after_time=after_time, before_time=before_time, has_branch_lengths=has_branch_lengths, is_binary=is_binary, is_ultrametric=is_ultrametric, limit=limit, meta_string=meta_string, name=name, offset=offset, user=user)
def list(self, search_string, limit=None): """Gets a list of specie hint matches. Args: search_string (str): A partial string to match species names against. limit (int): The maximum number of results to return. Returns: list of strings: List of matching species. """ return RestService.list( self, '{}/{}'.format(self.end_point, search_string), limit=limit )
def list(self, after_time=None, before_time=None, cell_sides=None, cell_size=None, epsg_code=None, limit=None, offset=None): """Gets a list of shapegrids matching the provided criteria. Args: after_time (:obj:`str`, optional): Return shapegrids modified after this time (in ISO-8601 format). before_time (:obj:`str`, optional): Return shapegrids modified before this time (in ISO-8601 format). cell_sides (:obj:`int`, optional): Return shapegrids that have cells with the specified number of sides (4 - rectangles, 6 - hexagons). cell_size (:obj:`float`, optional): Return shapegrids with the specified cell size (resolution). epsg_code (:obj:`int`, optional): Return shapegrids that were created using the specified spatial projection represented by the EPSG code. limit (:obj:`int`, optional): Return this number of shapegrids. offset (:obj:`int`, optional): Offset the shapegrids returned by this number. Use along with limit to implement paging. Returns: list of shapegrid metadata - Returns a list of shapegrids matching the provided criteria. """ return RestService.list(self, self.end_point, after_time=after_time, before_time=before_time, cell_sides=cell_sides, cell_size=cell_size, epsg_code=epsg_code, limit=limit, offset=offset)
def list(self, after_time=None, alt_pred_code=None, before_time=None, date_code=None, epsg_code=None, gcm_code=None, limit=None, offset=None): """Gets a list of scenarios matching the provided criteria. Args: after_time (str): List scenarios modified after this time. alt_pred_code (str): List scenarios containing this alternate prediction code. before_time (str): List scenarios modified before this time. date_code (str): List scenarios with this date code. epsg_code (int): List scenarios using this map projection EPSG code. gcm_code (str): List scenario using this GCM code. limit (int): The maximum number of scenarios to return. offset (int): Offset the scenarios returned by this number. Returns: list of dict: A list of JSON dictionaries of metadata for matching scenarios. """ return RestService.list(self, self.end_point, after_time=after_time, alt_pred_code=alt_pred_code, before_time=before_time, date_code=date_code, epsg_code=epsg_code, gcm_code=gcm_code, limit=limit, offset=offset)
def list( self, after_status=None, after_time=None, before_status=None, before_time=None, display_name=None, epsg_code=None, gridset_id=None, limit=None, minimum_number_of_points=None, offset=None, squid=None, status=None, user=None ): """Lists occurrence sets matching the provided criteria. Args: after_status (:obj:`int`, optional): Only return occurrence sets that have a status value greater than this number. after_time (:obj:`str`, optional): Only return occurrence sets modified after this time (in ISO-8601 format). before_status (:obj:`int`, optional): Only return occurrence sets that have a status value less than this number. before_time (:obj:`str`, optional): Only return occurrence sets modified before this time (in ISO-8601 format). display_name (:obj:`str`, optional): Only return occurrence sets that have this display name. epsg_code (:obj:`int`, optional): Only return occurrence sets that have this EPSG code. gridset_id (:obj:`int`, optional): Only return occurrence sets that are part of the gridset with this ID. limit (:obj:`int`, optional): Only return this number of occurrence sets. minimum_number_of_points (:obj:`int`, optional): Only return occurrence sets that have at least this many points. offset (:obj:`int`, optional): Offset the occurrence sets returned by this number. squid (:obj:`str`, optional): Only return occurrence sets that have this squid (hash value for species identifier). status (:obj:`int`, optional): Only return occurrence sets that have this status. user (:obj:`str`, optional): If 'public', return public occurrence sets. If 'anon', return anonymous occurrence sets. If None, return the user's occurrence sets. Returns: list of dict: A list of matching layer atoms. """ return RestService.list( self, self.end_point, after_status=after_status, after_time=after_time, before_status=before_status, before_time=before_time, display_name=display_name, epsg_code=epsg_code, gridset_id=gridset_id, limit=limit, minimum_number_of_points=minimum_number_of_points, offset=offset, squid=squid, status=status, user=user )
def list_matches( self, algorithm_code=None, bbox=None, display_name=None, gridset_id=None, model_scenario_code=None, point_max=None, point_min=None, prj_scen_code=None, squid=None, taxon_kingdom=None, taxon_phylum=None, taxon_class=None, taxon_order=None, taxon_family=None, taxon_genus=None, taxon_species=None ): """Gets a list of PAVs matching the provided parameters (subset dry run). Args: algorithm_code (str): The code of the modeling algorithm the PAVs should have been built from. bbox (tuple of number): A (min x, min y, max x, max y) bounding box to subset to. display_name (str): Match on this display name. gridset_id (int): The identifier of the gridset containing the PAVs. model_scenario_code (str): The scenario code of the PAV's model. point_max (int): The maximum number of points the PAV should be built from. point_min (int): The minimum number of points the PAV should be built from. prj_scen_code (str): A projection scenario code to match on. squid (str): A Lifemapper species identifier to match on. taxon_kingdom (str): A taxonomic kingdom to match on. taxon_phylum (str): A taxonomic phylum to match on. taxon_class (str): A taxonomic class to match on. taxon_order (str): A taxonomic order to match on. taxon_family (str): A family to match on. taxon_genus (str): A genus name to match on. taxon_species (str): A species name to match on. Returns: list of dict: A JSON list of matching PAV objects. """ return RestService.list( self, self.end_point, algorithm_code=algorithm_code, bbox=bbox, display_name=display_name, gridset_id=gridset_id, model_scenario_code=model_scenario_code, point_max=point_max, point_min=point_min, prj_scen_code=prj_scen_code, squid=squid, taxon_kingdom=taxon_kingdom, taxon_phylum=taxon_phylum, taxon_class=taxon_class, taxon_order=taxon_order, taxon_family=taxon_family, taxon_genus=taxon_genus, taxon_species=taxon_species )