gfwapiclient.resources.vessels.base.models.request

Global Fishing Watch (GFW) API Python Client - Vessels API Base Request Models.

This module defines base request models for the Vessels API, providing common parameters and enumerations for various vessel-related endpoints.

Module Contents

Classes

VesselDataset	Enumeration of available vessel datasets.
VesselRegistryInfoData	Enumeration of registry information data options.
VesselInclude	Enumeration of extra information to include in vessel details.
VesselMatchField	Enumeration of match field options for vessel search.
VesselBaseParams	Base request query parameters for all Vessels API endpoints.
VesselBaseDetailParams	Base request query parameters for get vessels by IDs and get vessel by ID API endpoints.

Data

__all__

API

gfwapiclient.resources.vessels.base.models.request.__all__ = ['VesselBaseDetailParams', 'VesselBaseParams', 'VesselDataset', 'VesselInclude', 'VesselMatchField',...

class gfwapiclient.resources.vessels.base.models.request.VesselDataset

Bases: str, enum.Enum

Enumeration of available vessel datasets.

Attributes:

VESSEL_IDENTITY_LATEST (str):

The latest version of the public global vessel identity dataset.

Initialization

Initialize self. See help(type(self)) for accurate signature.

VESSEL_IDENTITY_LATEST = 'public-global-vessel-identity:latest'

class gfwapiclient.resources.vessels.base.models.request.VesselRegistryInfoData

Bases: str, enum.Enum

Enumeration of registry information data options.

Attributes:

NONE (str):

Do not include registry information data.

DELTA (str):

Include only changes in registry information data.

ALL (str):

Include all registry information data.

Initialization

Initialize self. See help(type(self)) for accurate signature.

NONE = 'NONE'

DELTA = 'DELTA'

ALL = 'ALL'

class gfwapiclient.resources.vessels.base.models.request.VesselInclude

Bases: str, enum.Enum

Enumeration of extra information to include in vessel details.

Attributes:

POTENTIAL_RELATED_SELF_REPORTED_INFO (str):

Include potential related self-reported information.

Initialization

Initialize self. See help(type(self)) for accurate signature.

POTENTIAL_RELATED_SELF_REPORTED_INFO = 'POTENTIAL_RELATED_SELF_REPORTED_INFO'

class gfwapiclient.resources.vessels.base.models.request.VesselMatchField

Bases: str, enum.Enum

Enumeration of match field options for vessel search.

Attributes:

SEVERAL_FIELDS (str):

Match on several fields.

NO_MATCH (str):

Do not match on any fields.

ALL (str):

Match on all available fields.

Initialization

Initialize self. See help(type(self)) for accurate signature.

SEVERAL_FIELDS = 'SEVERAL_FIELDS'

NO_MATCH = 'NO_MATCH'

ALL = 'ALL'

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

Bases: gfwapiclient.http.models.request.RequestParams

Base request query parameters for all Vessels API endpoints.

Provides common parameters applicable to various vessel-related endpoints.

Attributes:

match_fields (Optional[List[VesselMatchField]]):

Filter by match fields levels criteria.

binary (Optional[bool]):

Whether response should be in binary format (proto buffer) or not.

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.

match_fields: Optional[List[gfwapiclient.resources.vessels.base.models.request.VesselMatchField]] = 'Field(...)'

binary: Optional[bool] = 'Field(...)'

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

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

Base request query parameters for get vessels by IDs and get vessel by ID API endpoints.

Provides common parameters for retrieving vessel details.

Attributes:

registries_info_data (Optional[VesselRegistryInfoData]):

Registry info data criteria.

includes (Optional[List[VesselInclude]]):

Whether to add extra information to the response.

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.

registries_info_data: Optional[gfwapiclient.resources.vessels.base.models.request.VesselRegistryInfoData] = 'Field(...)'

includes: Optional[List[gfwapiclient.resources.vessels.base.models.request.VesselInclude]] = 'Field(...)'