gfwapiclient.resources.bulk_downloads.list.models.response

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

Module Contents

Classes

BulkReportListItem

Result item for the Get All Bulk Reports API endpoint.

BulkReportListResult

Result for the Get All Bulk Reports API endpoint.

Data

__all__

API

gfwapiclient.resources.bulk_downloads.list.models.response.__all__ = ['BulkReportListItem', 'BulkReportListResult']
class gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem(/, **data: typing.Any)

Bases: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem

Result item for the Get All Bulk Reports API endpoint.

Represents metadata and status of the previously created bulk report.

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

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

See: https://globalfishingwatch.org/our-apis/documentation#bulk-reports-get-http-response

See: https://globalfishingwatch.org/our-apis/documentation#bulk-report-object-schema

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.

class gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult(data: List[gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem])

Bases: gfwapiclient.http.models.Result[gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem]

Result for the Get All Bulk Reports API endpoint.

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

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

Attributes:
_result_item_class (Type[BulkReportListItem]):

The model used for individual result items.

_data (BulkReportListItem):

The bulk report item returned in the response.

Initialization

Initializes a new BulkReportListResult.

Args:
data (List[BulkReportListItem]):

The list of bulk report items.

_result_item_class: Type[gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem] = None
_data: List[gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem] = None