gfwapiclient.resources.vessels.list.models.request

Global Fishing Watch (GFW) API Python Client - Get Vessels by IDs API Request Models.

This module defines request models for the Vessels API’s get vessels by IDs endpoint.

Module Contents

Classes

VesselListParams

Request query parameters for get list of vessels filtered by ids API endpoint.

Data

__all__
VESSEL_LIST_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.resources.vessels.list.models.request.__all__ = ['VesselListParams']

gfwapiclient.resources.vessels.list.models.request.VESSEL_LIST_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = 'Get vesselS by IDs request parameters validation failed.'

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

Bases: gfwapiclient.resources.vessels.base.models.request.VesselBaseDetailParams

Request query parameters for get list of vessels filtered by ids API endpoint.

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.

indexed_fields: ClassVar[Optional[List[str]]] = ['datasets', 'includes', 'match-fields', 'ids', 'vessel-groups']

datasets: List[gfwapiclient.resources.vessels.base.models.request.VesselDataset] = 'Field(...)'

ids: List[str] = 'Field(...)'

vessel_groups: Optional[List[str]] = 'Field(...)'