gfwapiclient.resources.vessels.base.models.response

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

This module defines base response models for the Vessels API, providing common data structures for vessel-related information.

Module Contents

Classes

ExtraField	Vessel registry extra information.
RegistryInfo	Vessel registry information.
RegistryOwner	Vessel registry owner.
RegistryPublicAuthorization	Vessel registry public authorization.
GearType	Vessel combined source gear type.
ShipType	Vessel combined source ship type.
CombinedSourceInfo	Vessel combined source information.
SelfReportedInfo	Vessel self reported information.
VesselItem	Vessels API result item.

Data

__all__

API

gfwapiclient.resources.vessels.base.models.response.__all__ = ['VesselItem']

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

Bases: gfwapiclient.base.models.BaseModel

Vessel registry extra information.

Attributes:

registry_source (Optional[str]):

The source of the registry information.

iuu_status (Optional[Any]):

The IUU (Illegal, Unreported, Unregulated) status.

has_compliance_info (Optional[Any]):

Indicates if compliance information is available.

images (Optional[Any]):

Images associated with the vessel.

operator (Optional[Any]):

The operator of the vessel.

built_year (Optional[Any]):

The year the vessel was built.

depth_m (Optional[Any]):

The depth in meters.

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.

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

iuu_status: Optional[Any] = 'Field(...)'

has_compliance_info: Optional[Any] = 'Field(...)'

images: Optional[Any] = 'Field(...)'

operator: Optional[Any] = 'Field(...)'

built_year: Optional[Any] = 'Field(...)'

depth_m: Optional[Any] = 'Field(...)'

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

Bases: gfwapiclient.base.models.BaseModel

Vessel registry information.

Attributes:

id (Optional[str]):

The registry ID.

source_code (Optional[List[str]]):

List of source codes.

ssvid (Optional[str]):

The Ship Static Voyage Identifier.

flag (Optional[str]):

The vessel’s flag.

ship_name (Optional[str]):

The vessel’s ship name.

n_ship_name (Optional[str]):

Normalized ship name.

call_sign (Optional[str]):

The vessel’s call sign.

imo (Optional[str]):

The vessel’s IMO number.

latest_vessel_info (Optional[bool]):

Indicates if it’s the latest vessel info.

transmission_date_from (Optional[datetime.datetime]):

Transmission date from.

transmission_date_to (Optional[datetime.datetime]):

Transmission date to.

gear_types (Optional[List[str]]):

List of gear types.

length_m (Optional[float]):

Length in meters.

tonnage_gt (Optional[float]):

Tonnage in gross tons.

vessel_info_reference (Optional[str]):

Vessel info reference.

extra_fields (Optional[List[ExtraField]]):

List of extra fields.

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.

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

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

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

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

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

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

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

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

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

transmission_date_from: Optional[datetime.datetime] = 'Field(...)'

transmission_date_to: Optional[datetime.datetime] = 'Field(...)'

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

length_m: Optional[float] = 'Field(...)'

tonnage_gt: Optional[float] = 'Field(...)'

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

extra_fields: Optional[List[gfwapiclient.resources.vessels.base.models.response.ExtraField]] = 'Field(...)'

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

Bases: gfwapiclient.base.models.BaseModel

Vessel registry owner.

Attributes:

name (Optional[str]):

The owner’s name.

flag (Optional[str]):

The owner’s flag.

ssvid (Optional[str]):

The Ship Static Voyage Identifier.

source_code (Optional[List[str]]):

List of source codes.

date_from (Optional[datetime.datetime]):

Date from.

date_to (Optional[datetime.datetime]):

Date to.

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.

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

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

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

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

date_from: Optional[datetime.datetime] = 'Field(...)'

date_to: Optional[datetime.datetime] = 'Field(...)'

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

Bases: gfwapiclient.base.models.BaseModel

Vessel registry public authorization.

Attributes:

date_from (Optional[datetime.datetime]):

Date from.

date_to (Optional[datetime.datetime]):

Date to.

ssvid (Optional[str]):

The Ship Static Voyage Identifier.

source_code (Optional[List[str]]):

List of source codes.

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.

date_from: Optional[datetime.datetime] = 'Field(...)'

date_to: Optional[datetime.datetime] = 'Field(...)'

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Vessel combined source gear type.

Attributes:

name (Optional[str]):

The gear type name.

source (Optional[str]):

The source of the gear type information.

year_from (Optional[int]):

Year from.

year_to (Optional[int]):

Year to.

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.

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

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

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Vessel combined source ship type.

Attributes:

name (Optional[str]):

The ship type name.

source (Optional[str]):

The source of the ship type information.

year_from (Optional[int]):

Year from.

year_to (Optional[int]):

Year to.

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.

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

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

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

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

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

Bases: gfwapiclient.base.models.BaseModel

Vessel combined source information.

Attributes:

vessel_id (Optional[str]):

The vessel ID.

gear_types (Optional[List[GearType]]):

List of gear types.

ship_types (Optional[List[ShipType]]):

List of ship types.

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.

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

gear_types: Optional[List[gfwapiclient.resources.vessels.base.models.response.GearType]] = 'Field(...)'

ship_types: Optional[List[gfwapiclient.resources.vessels.base.models.response.ShipType]] = 'Field(...)'

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

Bases: gfwapiclient.base.models.BaseModel

Vessel self reported information.

Attributes:

id (Optional[str]):

The self-reported information ID.

ssvid (Optional[str]):

The Ship Static Voyage Identifier.

ship_name (Optional[str]):

The vessel’s ship name.

n_ship_name (Optional[str]):

Normalized ship name.

flag (Optional[str]):

The vessel’s flag.

call_sign (Optional[str]):

The vessel’s call sign.

imo (Optional[str]):

The vessel’s IMO number.

messages_counter (Optional[int]):

Messages counter.

positions_counter (Optional[int]):

Positions counter.

source_code (Optional[List[str]]):

List of source codes.

match_fields (Optional[str]):

Matched fields.

transmission_date_from (Optional[datetime.datetime]):

Transmission date from.

transmission_date_to (Optional[datetime.datetime]):

Transmission date to.

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.

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

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

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

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

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

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

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

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

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

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

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

transmission_date_from: Optional[datetime.datetime] = 'Field(...)'

transmission_date_to: Optional[datetime.datetime] = 'Field(...)'

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

Bases: gfwapiclient.http.models.ResultItem

Vessels API result item.

Attributes:

dataset (Optional[str]):

The dataset used.

registry_info_total_records (Optional[int]):

Total registry info records.

registry_info (Optional[List[RegistryInfo]]):

List of registry information.

registry_owners (Optional[List[RegistryOwner]]):

List of registry owners.

registry_public_authorizations (Optional[List[RegistryPublicAuthorization]]):

List of registry public authorizations.

combined_sources_info (Optional[List[CombinedSourceInfo]]):

List of combined source information.

self_reported_info (Optional[List[SelfReportedInfo]]):

List of self-reported information.

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: Optional[str] = 'Field(...)'

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

registry_info: Optional[List[gfwapiclient.resources.vessels.base.models.response.RegistryInfo]] = 'Field(...)'

registry_owners: Optional[List[gfwapiclient.resources.vessels.base.models.response.RegistryOwner]] = 'Field(...)'

registry_public_authorizations: Optional[List[gfwapiclient.resources.vessels.base.models.response.RegistryPublicAuthorization]] = 'Field(...)'

combined_sources_info: Optional[List[gfwapiclient.resources.vessels.base.models.response.CombinedSourceInfo]] = 'Field(...)'

self_reported_info: Optional[List[gfwapiclient.resources.vessels.base.models.response.SelfReportedInfo]] = 'Field(...)'