:py:mod:`gfwapiclient.resources.fourwings.report.models.request` ================================================================ .. py:module:: gfwapiclient.resources.fourwings.report.models.request .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request :allowtitles: Module Contents --------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`FourWingsReportFormat ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportFormat :summary: * - :py:obj:`FourWingsReportSpatialResolution ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution :summary: * - :py:obj:`FourWingsReportGroupBy ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy :summary: * - :py:obj:`FourWingsReportTemporalResolution ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution :summary: * - :py:obj:`FourWingsReportBufferOperation ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation :summary: * - :py:obj:`FourWingsReportBufferUnit ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit :summary: * - :py:obj:`FourWingsReportDataset ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset :summary: * - :py:obj:`FourWingsGeometry ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry :summary: * - :py:obj:`FourWingsReportRegion ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion :summary: * - :py:obj:`FourWingsReportParams ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams :summary: * - :py:obj:`FourWingsReportBody ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBody :summary: Data ~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`__all__ ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.__all__ :summary: * - :py:obj:`FOURWINGS_REPORT_REQUEST_BODY_VALIDATION_ERROR_MESSAGE ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_BODY_VALIDATION_ERROR_MESSAGE :summary: * - :py:obj:`FOURWINGS_REPORT_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE :summary: * - :py:obj:`FOURWINGS_REPORT_REQUEST_PARAM_VALIDATION_ERROR_MESSAGE ` - .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_PARAM_VALIDATION_ERROR_MESSAGE :summary: API ~~~ .. py:data:: __all__ :canonical: gfwapiclient.resources.fourwings.report.models.request.__all__ :value: ['FourWingsReportBody', 'FourWingsReportParams'] .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.__all__ .. py:data:: FOURWINGS_REPORT_REQUEST_BODY_VALIDATION_ERROR_MESSAGE :canonical: gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_BODY_VALIDATION_ERROR_MESSAGE :type: typing.Final[str] :value: '4Wings report request body validation failed.' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_BODY_VALIDATION_ERROR_MESSAGE .. py:data:: FOURWINGS_REPORT_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE :canonical: gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE :type: typing.Final[str] :value: '4Wings report request params validation failed.' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE .. py:data:: FOURWINGS_REPORT_REQUEST_PARAM_VALIDATION_ERROR_MESSAGE :canonical: gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_PARAM_VALIDATION_ERROR_MESSAGE :type: typing.Final[str] :value: None .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FOURWINGS_REPORT_REQUEST_PARAM_VALIDATION_ERROR_MESSAGE .. py:class:: FourWingsReportFormat() :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportFormat Bases: :py:obj:`str`, :py:obj:`enum.Enum` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportFormat .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportFormat.__init__ .. py:attribute:: JSON :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportFormat.JSON :value: 'JSON' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportFormat.JSON .. py:class:: FourWingsReportSpatialResolution() :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution Bases: :py:obj:`str`, :py:obj:`enum.Enum` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution.__init__ .. py:attribute:: LOW :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution.LOW :value: 'LOW' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution.LOW .. py:attribute:: HIGH :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution.HIGH :value: 'HIGH' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution.HIGH .. py:class:: FourWingsReportGroupBy() :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy Bases: :py:obj:`str`, :py:obj:`enum.Enum` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.__init__ .. py:attribute:: VESSEL_ID :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.VESSEL_ID :value: 'VESSEL_ID' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.VESSEL_ID .. py:attribute:: FLAG :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.FLAG :value: 'FLAG' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.FLAG .. py:attribute:: GEARTYPE :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.GEARTYPE :value: 'GEARTYPE' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.GEARTYPE .. py:attribute:: FLAGANDGEARTYPE :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.FLAGANDGEARTYPE :value: 'FLAGANDGEARTYPE' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.FLAGANDGEARTYPE .. py:attribute:: MMSI :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.MMSI :value: 'MMSI' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy.MMSI .. py:class:: FourWingsReportTemporalResolution() :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution Bases: :py:obj:`str`, :py:obj:`enum.Enum` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.__init__ .. py:attribute:: HOURLY :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.HOURLY :value: 'HOURLY' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.HOURLY .. py:attribute:: DAILY :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.DAILY :value: 'DAILY' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.DAILY .. py:attribute:: MONTHLY :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.MONTHLY :value: 'MONTHLY' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.MONTHLY .. py:attribute:: YEARLY :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.YEARLY :value: 'YEARLY' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.YEARLY .. py:attribute:: ENTIRE :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.ENTIRE :value: 'ENTIRE' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution.ENTIRE .. py:class:: FourWingsReportBufferOperation() :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation Bases: :py:obj:`str`, :py:obj:`enum.Enum` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation.__init__ .. py:attribute:: DIFFERENCE :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation.DIFFERENCE :value: 'DIFFERENCE' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation.DIFFERENCE .. py:attribute:: DISSOLVE :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation.DISSOLVE :value: 'DISSOLVE' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation.DISSOLVE .. py:class:: FourWingsReportBufferUnit() :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit Bases: :py:obj:`str`, :py:obj:`enum.Enum` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.__init__ .. py:attribute:: MILES :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.MILES :value: 'MILES' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.MILES .. py:attribute:: NAUTICALMILES :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.NAUTICALMILES :value: 'NAUTICALMILES' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.NAUTICALMILES .. py:attribute:: KILOMETERS :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.KILOMETERS :value: 'KILOMETERS' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.KILOMETERS .. py:attribute:: RADIANS :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.RADIANS :value: 'RADIANS' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.RADIANS .. py:attribute:: DEGREES :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.DEGREES :value: 'DEGREES' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit.DEGREES .. py:class:: FourWingsReportDataset() :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset Bases: :py:obj:`str`, :py:obj:`enum.Enum` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset.__init__ .. py:attribute:: FISHING_EFFORT_LATEST :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset.FISHING_EFFORT_LATEST :value: 'public-global-fishing-effort:latest' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset.FISHING_EFFORT_LATEST .. py:attribute:: SAR_PRESENCE_LATEST :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset.SAR_PRESENCE_LATEST :value: 'public-global-sar-presence:latest' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset.SAR_PRESENCE_LATEST .. py:class:: FourWingsGeometry(/, **data: typing.Any) :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry Bases: :py:obj:`gfwapiclient.base.models.BaseModel` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry.__init__ .. py:attribute:: type :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry.type :type: str :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry.type .. py:attribute:: coordinates :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry.coordinates :type: typing.Any :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry.coordinates .. py:class:: FourWingsReportRegion(/, **data: typing.Any) :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion Bases: :py:obj:`gfwapiclient.base.models.BaseModel` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.__init__ .. py:attribute:: dataset :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.dataset :type: typing.Optional[str] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.dataset .. py:attribute:: id :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.id :type: typing.Optional[str] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.id .. py:attribute:: buffer_operation :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.buffer_operation :type: typing.Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferOperation] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.buffer_operation .. py:attribute:: buffer_unit :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.buffer_unit :type: typing.Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBufferUnit] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.buffer_unit .. py:attribute:: buffer_value :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.buffer_value :type: typing.Optional[str] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion.buffer_value .. py:class:: FourWingsReportParams(/, **data: typing.Any) :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams Bases: :py:obj:`gfwapiclient.http.models.RequestParams` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.__init__ .. py:attribute:: indexed_fields :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.indexed_fields :type: typing.ClassVar[typing.Optional[typing.List[str]]] :value: ['datasets', 'filters'] .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.indexed_fields .. py:attribute:: spatial_resolution :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.spatial_resolution :type: typing.Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportSpatialResolution] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.spatial_resolution .. py:attribute:: format :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.format :type: typing.Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportFormat] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.format .. py:attribute:: group_by :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.group_by :type: typing.Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportGroupBy] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.group_by .. py:attribute:: temporal_resolution :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.temporal_resolution :type: typing.Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportTemporalResolution] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.temporal_resolution .. py:attribute:: datasets :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.datasets :type: typing.Optional[typing.List[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportDataset]] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.datasets .. py:attribute:: filters :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.filters :type: typing.Optional[typing.List[str]] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.filters .. py:attribute:: date_range :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.date_range :type: typing.Optional[str] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.date_range .. py:attribute:: spatial_aggregation :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.spatial_aggregation :type: typing.Optional[bool] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportParams.spatial_aggregation .. py:class:: FourWingsReportBody(/, **data: typing.Any) :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBody Bases: :py:obj:`gfwapiclient.http.models.RequestBody` .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBody .. rubric:: Initialization .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBody.__init__ .. py:attribute:: geojson :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBody.geojson :type: typing.Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsGeometry] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBody.geojson .. py:attribute:: region :canonical: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBody.region :type: typing.Optional[gfwapiclient.resources.fourwings.report.models.request.FourWingsReportRegion] :value: 'Field(...)' .. autodoc2-docstring:: gfwapiclient.resources.fourwings.report.models.request.FourWingsReportBody.region