gfwapiclient.resources.bulk_downloads.list.endpoints

Global Fishing Watch (GFW) API Python Client - Get All Bulk Reports API endpoint.

Module Contents

Classes

BulkReportListEndPoint

Get All Bulk Reports API endpoint.

Data

__all__

API

gfwapiclient.resources.bulk_downloads.list.endpoints.__all__ = ['BulkReportListEndPoint']

class gfwapiclient.resources.bulk_downloads.list.endpoints.BulkReportListEndPoint(*, request_params: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.GetEndPoint[gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams, gfwapiclient.http.models.RequestBody, gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem, gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult]

Get All Bulk Reports API endpoint.

This endpoint retrieves a list of metadata and status of the previously created bulk reports based on the provided request parameters.

For more details on the Get All Bulk Reports API endpoint, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#get-all-bulk-reports-by-user

Initialization

Initializes a new BulkReportListEndPoint.

Args:

request_params (BulkReportListParams):

The request parameters.

http_client (HTTPClient):

The HTTP client used to make the API call.

_transform_response_data(*, body: Union[List[Dict[str, Any]], Dict[str, Any]]) → Union[List[Dict[str, Any]], Dict[str, Any]]

Transform and reshape response body and yield data.

This method transforms the raw response body from the API into a format suitable for the BulkReportListResult model.

The expected response structure is: {“entries”: [{…}]}.

Args:

body (Union[List[Dict[str, Any]], Dict[str, Any]]):

The raw response body.

Returns:

Union[List[Dict[str, Any]], Dict[str, Any]]:

The transformed response data.

Raises:

ResultValidationError:

If the response body does not match the expected format.