gfwapiclient.resources.bulk_downloads.file.models.request

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

Module Contents

Classes

BulkReportFileParams

Request query parameters for Download bulk Report (URL File) API endpoint.

Data

__all__
BULK_REPORT_FILE_PARAMS_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.bulk_downloads.file.models.request.__all__ = ['BulkReportFileParams']

gfwapiclient.resources.bulk_downloads.file.models.request.BULK_REPORT_FILE_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = 'Get bulk report file download URL request parameters validation failed.'

class gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams(/, **data: typing.Any)

Bases: gfwapiclient.http.models.RequestParams

Request query parameters for Download bulk Report (URL File) API endpoint.

Represents request query parameters to obtain signed URL to download the file (i.e., “DATA”, “README”, or “GEOM”) of the previously created bulk report.

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

See: https://globalfishingwatch.org/our-apis/documentation#download-bulk-report-url-parameters-for-get-requests

Attributes:

file (Optional[BulkReportFileType]):

Type of bulk report file (i.e., “DATA”, “README”, or “GEOM”).

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

file: Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType] = 'Field(...)'