gfwapiclient.resources.bulk_downloads.detail.endpoints

Global Fishing Watch (GFW) API Python Client - Get Bulk Report by ID API endpoint.

Module Contents

Classes

BulkReportDetailEndPoint

Get Bulk Report by ID API endpoint.

Data

__all__

API

gfwapiclient.resources.bulk_downloads.detail.endpoints.__all__ = ['BulkReportDetailEndPoint']

class gfwapiclient.resources.bulk_downloads.detail.endpoints.BulkReportDetailEndPoint(*, bulk_report_id: str, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.GetEndPoint[gfwapiclient.http.models.RequestParams, gfwapiclient.http.models.RequestBody, gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem, gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult]

Get Bulk Report by ID API endpoint.

This endpoint retrieves metadata and status of the previously created bulk report based on the provided bulk report ID.

For more details on the Get Bulk Report by ID API endpoint, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#get-bulk-report-by-id

For more details on the Get Bulk Report by ID data caveats, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#sar-fixed-infrastructure-data-caveats

Initialization

Initializes a new BulkReportDetailEndPoint.

Args:

bulk_report_id (str):

Unique identifier (ID) of the bulk report.

http_client (HTTPClient):

The HTTP client used to make the API call.