`gfwapiclient.resources.events.detail.models.request`¶

Global Fishing Watch (GFW) API Python Client - Get one by Event ID API Request Models.

Module Contents¶

Request query parameters for retrieving an event by its ID.

`__all__`
`EVENT_DETAIL_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE`

gfwapiclient.resources.events.detail.models.request.__all__ = ['EventDetailParams']¶

gfwapiclient.resources.events.detail.models.request.EVENT_DETAIL_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = 'Get one by Event ID request parameters validation failed.'¶

class gfwapiclient.resources.events.detail.models.request.EventDetailParams(/, **data: typing.Any)¶

Bases: gfwapiclient.http.models.RequestParams

Request query parameters for retrieving an event by its ID.

Attributes:

dataset (EventDataset):: Dataset to search for the event.
raw (Optional[bool]):: Whether to return the raw content of the event without parsing. Defaults to False.

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.

dataset: gfwapiclient.resources.events.base.models.request.EventDataset = 'Field(...)'¶