gfwapiclient.resources.bulk_downloads.file.endpoints

Global Fishing Watch (GFW) API Python Client - Download bulk Report (URL File) API endpoint.

Module Contents

Classes

BulkReportFileEndPoint

Download bulk Report (URL File) API endpoint.

Data

__all__

API

gfwapiclient.resources.bulk_downloads.file.endpoints.__all__ = ['BulkReportFileEndPoint']

class gfwapiclient.resources.bulk_downloads.file.endpoints.BulkReportFileEndPoint(*, bulk_report_id: str, request_params: gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.GetEndPoint[gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams, gfwapiclient.http.models.RequestBody, gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem, gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult]

Download bulk Report (URL File) API endpoint.

This endpoint is used to retrieve signed URL to download file(s) (i.e., “DATA”, “README”, or “GEOM”) of the previously created bulk report.

For more details on the Download bulk Report (URL File) API endpoint, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#download-bulk-report-url-file

For more details on the Download bulk Report (URL File) 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 BulkReportFileEndPoint.

Args:

bulk_report_id (str):

Unique identifier (ID) of the bulk report.

request_params (BulkReportFileParams):

The request query parameters.

http_client (HTTPClient):

The HTTP client used to make the API call.