gfwapiclient.resources.events.list.models.request

Global Fishing Watch (GFW) API Python Client - Get All Events API Request Models.

Module Contents

Classes

EventListParams	Request query parameters for retrieving a list of events.
EventListBody	Request body for retrieving a list of events.

Data

__all__
EVENT_LIST_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE
EVENT_LIST_REQUEST_BODY_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.events.list.models.request.__all__ = ['EventListBody', 'EventListParams']

gfwapiclient.resources.events.list.models.request.EVENT_LIST_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = 'Get All Events request parameters validation failed.'

gfwapiclient.resources.events.list.models.request.EVENT_LIST_REQUEST_BODY_VALIDATION_ERROR_MESSAGE: Final[str] = 'Get All Events request body validation failed.'

class gfwapiclient.resources.events.list.models.request.EventListParams(/, **data: typing.Any)

Bases: gfwapiclient.http.models.RequestParams

Request query parameters for retrieving a list of events.

Attributes:

limit (Optional[int]):

Maximum number of events to return. Defaults to 99999.

offset (Optional[int]):

Number of events to skip before returning results. Used for pagination. Defaults to 0.

sort (Optional[str]):

Property to sort the events by. Depends on the dataset.

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.

limit: Optional[int] = 'Field(...)'

offset: Optional[int] = 'Field(...)'

sort: Optional[str] = 'Field(...)'

class gfwapiclient.resources.events.list.models.request.EventListBody(/, **data: typing.Any)

Bases: gfwapiclient.resources.events.base.models.request.EventBaseBody

Request body for retrieving a list of events.

This request body contains the filtering criteria for the events.

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.