`gfwapiclient.resources.bulk_downloads.file.models.response`¶

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

Module Contents¶

Classes¶

`BulkReportFileItem`	Result item for the Download bulk Report (URL File) API endpoint.
`BulkReportFileResult`	Result for the Download bulk Report (URL File) API endpoint.

Data¶

__all__

API¶

gfwapiclient.resources.bulk_downloads.file.models.response.__all__ = ['BulkReportFileItem', 'BulkReportFileResult']¶

class gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem(/, **data: typing.Any)¶

Bases: gfwapiclient.http.models.ResultItem

Result item for the Download bulk Report (URL File) API endpoint.

Represents 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 response bodies, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#download-bulk-report-http-response

Attributes:

url (Optional[str]):: Signed URL to download the file.

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.

url: Optional[str] = 'Field(...)'¶

class gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult(data: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem)¶

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem]

Result for the Download bulk Report (URL File) API endpoint.