gfwapiclient.resources.bulk_downloads.create.endpoints

Global Fishing Watch (GFW) API Python Client - Create a Bulk Report API endpoint.

Module Contents

Classes

BulkReportCreateEndPoint

Create a Bulk Report API endpoint.

Data

__all__

API

gfwapiclient.resources.bulk_downloads.create.endpoints.__all__ = ['BulkReportCreateEndPoint']

class gfwapiclient.resources.bulk_downloads.create.endpoints.BulkReportCreateEndPoint(*, request_body: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody, http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.PostEndPoint[gfwapiclient.http.models.RequestParams, gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody, gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem, gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult]

Create a Bulk Report API endpoint.

This endpoint is used to create bulk reports based on the provided request body.

For more details on the Create a Bulk Report API endpoint, please refer to the official Global Fishing Watch API documentation:

See: https://globalfishingwatch.org/our-apis/documentation#create-a-bulk-report

Initialization

Initializes a new BulkReportCreateEndPoint.

Args:

request_body (BulkReportCreateBody):

The request body.

http_client (HTTPClient):

The HTTP client for making API requests.