gfwapiclient.http.endpoints.get

Global Fishing Watch (GFW) API Python Client - GET HTTP EndPoint.

Module Contents

Classes

GetEndPoint

Get API resource endpoint.

Data

__all__

API

gfwapiclient.http.endpoints.get.__all__ = ['GetEndPoint']

class gfwapiclient.http.endpoints.get.GetEndPoint(*, path: str, request_params: Optional[gfwapiclient.http.models.request._RequestParamsT], result_item_class: Type[gfwapiclient.http.models.response._ResultItemT], result_class: Type[gfwapiclient.http.models.response._ResultT], http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.base.BaseEndPoint[gfwapiclient.http.models.request._RequestParamsT, gfwapiclient.http.models.request._RequestBodyT, gfwapiclient.http.models.response._ResultItemT, gfwapiclient.http.models.response._ResultT]

Get API resource endpoint.

This class extends BaseEndPoint to provide functionality for making GET requests to API endpoints. It encapsulates the logic for handling GET requests, including request preparation and response processing.

Initialization

Initialize a new GetEndPoint.

Args:

path (str):

The relative path of the API endpoint.

request_params (Optional[_RequestParamsT]):

Query parameters for the GET request.

result_item_class (Type[_ResultItemT]):

Pydantic model for the expected response item.

result_class (Type[_ResultT]):

Pydantic model for the expected response result.

http_client (HTTPClient):

The HTTP client to send requests.