weaver.processes.constants
==========================

.. py:module:: weaver.processes.constants






Module Contents
---------------

.. py:data:: IO_SelectInput_Type

.. py:data:: IO_SelectOutput_Type

.. py:data:: IO_Select_Type

.. py:data:: IO_INPUT

.. py:data:: IO_OUTPUT

.. py:data:: WPS_Literal_Type

.. py:data:: WPS_Reference_Type

.. py:data:: WPS_Complex_Type

.. py:data:: WPS_COMPLEX

.. py:data:: WPS_ComplexData_Type

.. py:data:: WPS_BoundingBoxData_Type

.. py:data:: WPS_BoundingBox_Type

.. py:data:: WPS_BOUNDINGBOX

.. py:data:: WPS_CategoryType

.. py:data:: WPS_LITERAL

.. py:data:: WPS_REFERENCE

.. py:data:: WPS_COMPLEX_DATA

.. py:data:: WPS_BOUNDINGBOX_DATA

.. py:data:: WPS_LiteralDataBoolean_Type

.. py:data:: WPS_LITERAL_DATA_BOOLEAN

.. py:data:: WPS_LiteralDataDateTime_Type

.. py:data:: WPS_LITERAL_DATA_DATETIME

.. py:data:: WPS_LiteralDataFloat_Type

.. py:data:: WPS_LITERAL_DATA_FLOAT

.. py:data:: WPS_LiteralDataInteger_Type

.. py:data:: WPS_LITERAL_DATA_INTEGER

.. py:data:: WPS_LiteralDataString_Type

.. py:data:: WPS_LITERAL_DATA_STRING

.. py:data:: WPS_LiteralData_Type

.. py:data:: WPS_LITERAL_DATA_TYPES

.. py:data:: WPS_ComplexType

.. py:data:: WPS_COMPLEX_TYPES

.. py:data:: WPS_DataType

.. py:data:: WPS_DATA_TYPES

.. py:class:: OpenSearchField



   Constants container that provides similar functionalities to :class:`ExtendedEnum` without explicit Enum membership.


   .. py:attribute:: START_DATE
      :value: 'StartDate'



   .. py:attribute:: END_DATE
      :value: 'EndDate'



   .. py:attribute:: AOI
      :value: 'aoi'



   .. py:attribute:: COLLECTION
      :value: 'collection'



   .. py:attribute:: LOCAL_FILE_SCHEME
      :value: 'opensearchfile'



.. py:data:: CWL_NAMESPACE_CWL_SPEC_ID
   :value: 'cwl'


.. py:data:: CWL_NAMESPACE_CWL_SPEC_URL
   :value: 'https://w3id.org/cwl/cwl#'


.. py:data:: CWL_NAMESPACE_CWL_SPEC_DEFINITION
   :type:  weaver.typedefs.CWL_NamespaceDefinition

   Namespace used to reference :term:`CWL` definitions provided the common specification.


.. py:data:: CWL_NAMESPACE_CWLTOOL_ID
   :value: 'cwltool'


.. py:data:: CWL_NAMESPACE_CWLTOOL_URL
   :value: 'http://commonwl.org/cwltool#'


.. py:data:: CWL_NAMESPACE_CWLTOOL_DEFINITION
   :type:  weaver.typedefs.CWL_NamespaceDefinition

   Namespace used to reference :term:`CWL` definitions provided by mod:`cwltool`.


.. py:data:: CWL_NAMESPACE_SCHEMA_ID
   :value: 's'


.. py:data:: CWL_NAMESPACE_SCHEMA_URL
   :value: 'https://schema.org/'


.. py:data:: CWL_NAMESPACE_SCHEMA_DEFINITION
   :type:  weaver.typedefs.CWL_NamespaceDefinition

   Namespace used to reference :term:`CWL` definitions provided by ``schema.org`` typically used for additional metadata.


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_NAME
   :value: 's:name'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_EMAIL
   :value: 's:email'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_IDENTIFIER
   :value: 's:identifier'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_PERSON
   :value: 's:Person'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_AUTHOR
   :value: 's:author'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_CITATION
   :value: 's:citation'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_KEYWORDS
   :value: 's:keywords'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_CODE_REPOSITORY
   :value: 's:codeRepository'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_CONTRIBUTOR
   :value: 's:contributor'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_DATE_CREATED
   :value: 's:dateCreated'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_LICENSE
   :value: 's:license'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_RELEASE_NOTES
   :value: 's:releaseNotes'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_VERSION
   :value: 's:version'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_SOFTWARE_VERSION
   :value: 's:softwareVersion'


.. py:data:: CWL_NAMESPACE_SCHEMA_METADATA_SUPPORTED

   Fields that can be directly in the :term:`CWL` contents.


.. py:data:: CWL_NAMESPACE_OGC_API_PROC_PART1_ID
   :value: 'ogcapi-processes-1'


.. py:data:: CWL_NAMESPACE_OGC_API_PROC_PART1_URL
   :value: 'https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/'


.. py:data:: CWL_NAMESPACE_OGC_API_PROC_DEFINITION
   :type:  weaver.typedefs.CWL_NamespaceDefinition

   Namespaces used to reference :term:`OGC API - Processes` schema definitions.


.. py:data:: CWL_NAMESPACES
   :type:  Dict[str, str]

.. py:data:: CWL_NAMESPACES
   :type:  weaver.typedefs.CWL_NamespaceDefinition

.. py:data:: CWL_NAMESPACES_REVERSED
   :type:  weaver.typedefs.CWL_NamespaceDefinition

.. py:data:: CWL_RequirementBuiltinType

.. py:data:: CWL_RequirementESGFCWTType

.. py:data:: CWL_RequirementOGCAPIType

.. py:data:: CWL_RequirementWPS1Type

.. py:data:: CWL_RequirementWeaverBuiltinType

.. py:data:: CWL_RequirementWeaverESGFCWTType

.. py:data:: CWL_RequirementWeaverOGCAPIType

.. py:data:: CWL_RequirementWeaverWPS1Type

.. py:data:: CWL_RequirementDockerType

.. py:data:: CWL_RequirementDockerGpuType

.. py:data:: CWL_RequirementCUDANameType

.. py:data:: CWL_RequirementCUDAType

.. py:data:: CWL_RequirementEnvVarType

.. py:data:: CWL_RequirementInitialWorkDirType

.. py:data:: CWL_RequirementInlineJavascriptType

.. py:data:: CWL_RequirementInplaceUpdateType

.. py:data:: CWL_RequirementLoadListingType

.. py:data:: CWL_RequirementMPIType

.. py:data:: CWL_RequirementMultipleInputFeatureType

.. py:data:: CWL_RequirementNetworkAccessType

.. py:data:: CWL_RequirementProcessGeneratorType

.. py:data:: CWL_RequirementResourceType

.. py:data:: CWL_RequirementScatterFeatureType

.. py:data:: CWL_RequirementSecretsType

.. py:data:: CWL_RequirementStepInputExpressionType

.. py:data:: CWL_RequirementSubworkflowFeatureType

.. py:data:: CWL_RequirementToolTimeLimitType

.. py:data:: CWL_RequirementWorkReuseType

.. py:data:: CWL_REQUIREMENT_APP_BUILTIN

.. py:data:: CWL_REQUIREMENT_APP_DOCKER

.. py:data:: CWL_REQUIREMENT_APP_DOCKER_GPU

.. py:data:: CWL_REQUIREMENT_APP_ESGF_CWT

.. py:data:: CWL_REQUIREMENT_APP_OGC_API

.. py:data:: CWL_REQUIREMENT_APP_WPS1

.. py:data:: CWL_REQUIREMENT_APP_WEAVER_CLASSES

   Set of :term:`CWL` requirements defined by `Weaver` for an :term:`Application Package` implementation.


.. py:data:: CWL_NAMESPACE_WEAVER_ID
   :value: 'weaver'


.. py:data:: CWL_NAMESPACE_WEAVER_URL
   :value: 'https://schemas.crim.ca/cwl/weaver#'


.. py:data:: CWL_NAMESPACE_WEAVER_DEFINITION

   Namespace used to reference :term:`CWL` definitions provided by `Weaver`.


.. py:data:: CWL_REQUIREMENT_APP_WEAVER_DEFINITION

.. py:data:: CWL_RequirementAppTypes

.. py:data:: CWL_REQUIREMENT_APP_TYPES

   Set of :term:`CWL` requirements consisting of known :term:`Application Package` by this `Weaver` instance.


.. py:data:: CWL_REQUIREMENT_APP_LOCAL

   Set of :term:`CWL` requirements that correspond to local execution of an :term:`Application Package`.


.. py:data:: CWL_REQUIREMENT_APP_REMOTE

   Set of :term:`CWL` requirements that correspond to remote execution of an :term:`Application Package`.


.. py:data:: CWL_REQUIREMENT_CUDA_DEFAULT_PARAMETERS

   Parameters employed by default for updating :data:`CWL_REQUIREMENT_APP_DOCKER_GPU` into :data:`CWL_REQUIREMENT_CUDA`.


.. py:data:: CWL_REQUIREMENT_CUDA

.. py:data:: CWL_REQUIREMENT_CUDA_NAME

.. py:data:: CWL_REQUIREMENT_CUDA_NAMESPACE

.. py:data:: CWL_REQUIREMENT_ENV_VAR

.. py:data:: CWL_REQUIREMENT_INIT_WORKDIR

.. py:data:: CWL_REQUIREMENT_INLINE_JAVASCRIPT

.. py:data:: CWL_REQUIREMENT_INPLACE_UPDATE

.. py:data:: CWL_REQUIREMENT_LOAD_LISTING

.. py:data:: CWL_REQUIREMENT_MPI

.. py:data:: CWL_REQUIREMENT_MULTIPLE_INPUT

.. py:data:: CWL_REQUIREMENT_NETWORK_ACCESS

.. py:data:: CWL_REQUIREMENT_PROCESS_GENERATOR

.. py:data:: CWL_REQUIREMENT_RESOURCE

.. py:data:: CWL_REQUIREMENT_SCATTER

.. py:data:: CWL_REQUIREMENT_SECRETS

.. py:data:: CWL_REQUIREMENT_STEP_INPUT_EXPRESSION

.. py:data:: CWL_REQUIREMENT_SUBWORKFLOW

.. py:data:: CWL_REQUIREMENT_TIME_LIMIT

.. py:data:: CWL_REQUIREMENT_WORK_REUSE

.. py:data:: CWL_REQUIREMENT_FEATURES

   Set of :term:`CWL` requirements that corresponds to extra functionalities.

   An :term:`Application Package` that only contains these requirements by themselves would not be considered complete.
   These extra requirements must be accompanied by another one from :data:`CWL_REQUIREMENT_APP_TYPES` to be considered
   a complete definition.


.. py:data:: CWL_REQUIREMENTS_SUPPORTED

   Set of all :term:`CWL` requirements or hints that are supported for deployment of valid :term:`Application Package`.


.. py:data:: PACKAGE_EXTENSIONS

.. py:data:: PACKAGE_INTEGER_TYPES

.. py:data:: PACKAGE_FLOATING_TYPES

.. py:data:: PACKAGE_NUMERIC_TYPES

.. py:data:: PACKAGE_BASIC_TYPES

.. py:data:: PACKAGE_LITERAL_TYPES

.. py:data:: PACKAGE_FILE_TYPE
   :value: 'File'


.. py:data:: PACKAGE_DIRECTORY_TYPE
   :value: 'Directory'


.. py:data:: PACKAGE_COMPLEX_TYPES

.. py:data:: PACKAGE_ENUM_BASE
   :value: 'enum'


.. py:data:: PACKAGE_CUSTOM_TYPES

.. py:data:: PACKAGE_ARRAY_BASE
   :value: 'array'


.. py:data:: PACKAGE_ARRAY_MAX_SIZE
   :value: 9223372036854775807


.. py:data:: PACKAGE_ARRAY_ITEMS

.. py:data:: PACKAGE_ARRAY_TYPES

.. py:data:: PACKAGE_TYPE_NULLABLE

.. py:data:: PACKAGE_SHORTCUTS

.. py:data:: PACKAGE_TYPE_POSSIBLE_VALUES

.. py:data:: OAS_COMPLEX_TYPES

.. py:data:: OAS_ARRAY_TYPES

.. py:data:: OAS_LITERAL_TYPES

.. py:data:: OAS_LITERAL_NUMERIC

.. py:data:: OAS_LITERAL_FLOAT_FORMATS

.. py:data:: OAS_LITERAL_INTEGER_FORMATS

.. py:data:: OAS_LITERAL_NUMERIC_FORMATS

.. py:data:: OAS_LITERAL_DATETIME_FORMATS

.. py:data:: OAS_LITERAL_STRING_FORMATS

.. py:data:: OAS_LITERAL_BINARY_FORMATS

.. py:data:: OAS_KEYWORD_TYPES

.. py:data:: OAS_DATA_TYPES

.. py:data:: ProcessSchemaOGCType

.. py:data:: ProcessSchemaOLDType

.. py:data:: ProcessSchemaWPSType

.. py:type:: ProcessSchemaConstType
   :canonical: 'ProcessSchema'


.. py:data:: ProcessSchemaType

.. py:data:: JobStatusTypeProcess

.. py:data:: JobStatusTypeService

.. py:data:: JobStatusTypeProvider

.. py:type:: JobStatusConstType
   :canonical: 'JobStatusType'


.. py:data:: JobStatusPropertyType

.. py:data:: JobInputsOutputsSchemaType_OGC

.. py:data:: JobInputsOutputsSchemaType_OLD

.. py:data:: JobInputsOutputsSchemaType_OGC_STRICT

.. py:data:: JobInputsOutputsSchemaType_OLD_STRICT

.. py:data:: JobInputsOutputsSchemaAnyOGCType

.. py:data:: JobInputsOutputsSchemaAnyOLDType

.. py:type:: JobInputsOutputsSchemaConstType
   :canonical: 'JobInputsOutputsSchema'


.. py:data:: JobInputsOutputsSchemaType

.. py:data:: JobStatusProfileSchemaType_OGC

.. py:data:: JobStatusProfileSchemaType_OpenEO

.. py:data:: JobStatusProfileSchemaType_WPS

.. py:type:: JobStatusProfileSchemaConstType
   :canonical: 'JobStatusProfileSchema'


.. py:data:: JobStatusProfileSchemaType

.. py:class:: ProcessSchema



   Schema selector to represent a :term:`Process` description.


   .. py:attribute:: OGC
      :type:  ProcessSchemaOGCType
      :value: 'OGC'



   .. py:attribute:: OLD
      :type:  ProcessSchemaOLDType
      :value: 'OLD'



   .. py:attribute:: WPS
      :type:  ProcessSchemaWPSType
      :value: 'WPS'



.. py:class:: JobInputsOutputsSchema



   Schema selector to represent a :term:`Job` output results.


   .. py:attribute:: OGC_STRICT
      :type:  JobInputsOutputsSchemaType_OGC_STRICT
      :value: 'ogc+strict'



   .. py:attribute:: OLD_STRICT
      :type:  JobInputsOutputsSchemaType_OLD_STRICT
      :value: 'old+strict'



   .. py:attribute:: OGC
      :type:  JobInputsOutputsSchemaType_OGC
      :value: 'ogc'



   .. py:attribute:: OLD
      :type:  JobInputsOutputsSchemaType_OLD
      :value: 'old'



.. py:class:: JobStatusProfileSchema



   Schema :term:`Profile` selector to represent a :term:`Job` status response.


   .. py:attribute:: OGC
      :type:  JobStatusProfileSchemaType_OGC
      :value: 'ogc'



   .. py:attribute:: OPENEO
      :type:  JobStatusProfileSchemaType_OpenEO
      :value: 'openeo'



   .. py:attribute:: WPS
      :type:  JobStatusProfileSchemaType_WPS
      :value: 'wps'



.. py:class:: JobStatusType



   Type of :term:`Job` status response being represented.

   The values consider teh originally submitted :term:`Process`, :term:`Provider` or :term:`Profile` representations.

   .. seealso::
       - https://github.com/opengeospatial/ogcapi-processes/blob/master/openapi/schemas/processes-core/statusInfo.yaml


   .. py:attribute:: PROCESS
      :type:  JobStatusTypeProcess
      :value: 'process'



   .. py:attribute:: PROVIDER
      :type:  JobStatusTypeProvider
      :value: 'provider'



   .. py:attribute:: SERVICE
      :type:  JobStatusTypeService
      :value: 'service'



   .. py:attribute:: WPS
      :type:  ProcessSchemaWPSType
      :value: 'wps'



   .. py:attribute:: OPENEO
      :type:  JobStatusProfileSchemaType_OpenEO
      :value: 'openeo'



.. py:data:: CWL_RequirementNames