osdu-python-models 0.5.0__py3-none-any.whl

osdu_models/workproductcomponent/tubular_external_component/v1_1_0.py

@@ -0,0 +1,342 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/tubular_external_component/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_technical_assurance import v1_2_0
+from ...abstract.abstract_alias_names import v1_0_0
+from ...abstract.abstract_spatial_location import v1_1_0
+from ...abstract.abstract_geo_context import v1_0_0 as v1_0_0_1
+
+
+class Artefact(BaseModel):
+    """
+    An array of Artefacts - each artefact has a Role, Resource tuple. An artefact is distinct from the file, in the sense certain valuable information is generated during loading process (Artefact generation process). Examples include retrieving location data, performing an OCR which may result in the generation of artefacts which need to be preserved distinctly
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RoleID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ArtefactRole:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The record id of this artefact's role.
+    """
+    ResourceKind: (
+        constr(pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$') | None
+    ) = None
+    """
+    The kind or schema ID of the artefact. Resolvable with the Schema Service.
+    """
+    ResourceID: (
+        constr(pattern=r'^[\w\-\.]+:dataset\-\-[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = None
+    """
+    The SRN which identifies this OSDU Artefact resource.
+    """
+
+
+class LineageAssertion(BaseModel):
+    """
+    Defines relationships with other objects (any kind of Resource) upon which this work product component depends.  The assertion is directed only from the asserting WPC to ancestor objects, not children.  It should not be used to refer to files or artefacts within the WPC -- the association within the WPC is sufficient and Artefacts are actually children of the main WPC file. They should be recorded in the data.Artefacts[] array.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ID: constr(pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$') | None = None
+    """
+    The object reference identifying the DIRECT, INDIRECT, REFERENCE dependency.
+    """
+    LineageRelationshipType: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LineageRelationshipType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Used by LineageAssertion to describe the nature of the line of descent of a work product component from a prior Resource, such as DIRECT, INDIRECT, REFERENCE.  It is not for proximity (number of nodes away), it is not to cover all the relationships in a full ontology or graph, and it is not to describe the type of activity that created the asserting WPC.  LineageAssertion does not encompass a full provenance, process history, or activity model.
+    """
+
+
+class Data(BaseModel):
+    """
+    Generic reference object containing the universal properties of a Work Product Component for inclusion in data type specific Work Product Component objects
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ResourceHomeRegionID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-OSDURegion:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Resource Home Region ID')
+    """
+    The name of the home [cloud environment] region for this OSDU resource object.
+    """
+    ResourceHostRegionIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-OSDURegion:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Resource Host Region ID')
+    """
+    The name of the host [cloud environment] region(s) for this OSDU resource object.
+    """
+    ResourceCurationStatus: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceCurationStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Curation Status')
+    """
+    Describes the current Curation status.
+    """
+    ResourceLifecycleStatus: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceLifecycleStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Lifecycle Status')
+    """
+    Describes the current Resource Lifecycle status.
+    """
+    ResourceSecurityClassification: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceSecurityClassification:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Security Classification')
+    """
+    Classifies the security level of the resource.
+    """
+    Source: str | None = Field(None, title='Data Source')
+    """
+    The entity that produced the record, or from which it is received; could be an organization, agency, system, internal team, or individual. For informational purposes only, the list of sources is not governed.
+    """
+    ExistenceKind: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ExistenceKind:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Existence Kind')
+    """
+    Where does this data resource sit in the cradle-to-grave span of its existence?
+    """
+    TechnicalAssuranceID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TechnicalAssuranceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Technical Assurance ID')
+    """
+    DEPRECATED: Describes a record's overall suitability for general business consumption based on data quality. Clarifications: Since Certified is the highest classification of suitable quality, any further change or versioning of a Certified record should be carefully considered and justified. If a Technical Assurance value is not populated then one can assume the data has not been evaluated or its quality is unknown (=Unevaluated). Technical Assurance values are not intended to be used for the identification of a single "preferred" or "definitive" record by comparison with other records.
+    """
+    Datasets: (
+        list[constr(pattern=r'^[\w\-\.]+:dataset\-\-[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$')]
+        | None
+    ) = None
+    """
+    The record id, which identifies this OSDU File or dataset resource.
+    """
+    DDMSDatasets: (
+        list[
+            constr(
+                pattern=r'^(([^:/?#]+):)(\/\/([^/?#]+))(\/[^?#]+)(\?([^#]*))?(#(.*))?'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            [
+                'urn://wddms-3/uuid:20840361-adc0-4842-999b-5639bd07bb38',
+                "eml://rddms-1/dataspace('demo/Volve')/resqml20.obj_ContinuousProperty(1615d8d2-2a2d-482c-885e-14225b89e90c)",
+            ]
+        ],
+        title='DDMS Datasets',
+    )
+    """
+    An array of references to content in Domain Data Management Services represented by this work-product-component. The references are formed as URI following https://www.rfc-editor.org/rfc/rfc3986#page-16. This property is exclusively populated by DDMSs. If a work-product-component is represented in more than one DDMS, DDMSs are obliged to find the specific reference by inspecting the URI's authority values matching the DDMS id.
+    """
+    Artefacts: list[Artefact] | None = None
+    """
+    An array of Artefacts - each artefact has a Role, Resource tuple. An artefact is distinct from the file, in the sense certain valuable information is generated during loading process (Artefact generation process). Examples include retrieving location data, performing an OCR which may result in the generation of artefacts which need to be preserved distinctly
+    """
+    IsExtendedLoad: bool | None = None
+    """
+    A flag that indicates if the work product component is undergoing an extended load.  It reflects the fact that the work product component is in an early stage and may be updated before finalization.
+    """
+    IsDiscoverable: bool | None = None
+    """
+    A flag that indicates if the work product component is searchable, which means covered in the search index.
+    """
+    TechnicalAssurances: list[v1_2_0.AbstractTechnicalAssurance] | None = Field(
+        None, title='Technical Assurances'
+    )
+    """
+    Describes a record's overall suitability for general business consumption based on data quality. Clarifications: Since Certified is the highest classification of suitable quality, any further change or versioning of a Certified record should be carefully considered and justified. If a Technical Assurance value is not populated then one can assume the data has not been evaluated or its quality is unknown (=Unevaluated). Technical Assurance values are not intended to be used for the identification of a single "preferred" or "definitive" record by comparison with other records.
+    """
+    NameAliases: list[v1_0_0.AbstractAliasNames] | None = None
+    """
+    Alternative names, including historical, by which this work-product-component is/has been known (it should include all the identifiers).
+    """
+    Name: str | None = None
+    """
+    Name
+    """
+    Description: str | None = Field(
+        None, examples=['Bow Centralizers'], title='Description'
+    )
+    """
+    External Component Description
+    """
+    CreationDateTime: str | None = None
+    """
+    Date that a resource (work  product component here) is formed outside of OSDU before loading (e.g. publication date).
+    """
+    Tags: list[str] | None = None
+    """
+    Array of key words to identify the work product, especially to help in search.
+    """
+    SpatialPoint: v1_1_0.AbstractSpatialLocation | None = None
+    """
+    A centroid point that reflects the locale of the content of the work product component (location of the subject matter).
+    """
+    SpatialArea: v1_1_0.AbstractSpatialLocation | None = None
+    """
+    A polygon boundary that reflects the locale of the content of the work product component (location of the subject matter).
+    """
+    GeoContexts: list[v1_0_0_1.AbstractGeoContext] | None = None
+    """
+    List of geographic entities which provide context to the WPC.  This may include multiple types or multiple values of the same type.
+    """
+    SubmitterName: str | None = None
+    """
+    Name of the person that first submitted the work product component to OSDU.
+    """
+    BusinessActivities: list[str] | None = None
+    """
+    Array of business processes/workflows that the work product component has been through (ex. well planning, exploration).
+    """
+    AuthorIDs: list[str] | None = Field(None, title='Author IDs')
+    """
+    Array of Authors' names of the work product component.  Could be a person or company entity.
+    """
+    LineageAssertions: list[LineageAssertion] | None = None
+    """
+    Defines relationships with other objects (any kind of Resource) upon which this work product component depends.  The assertion is directed only from the asserting WPC to ancestor objects, not children.  It should not be used to refer to files or artefacts within the WPC -- the association within the WPC is sufficient and Artefacts are actually children of the main WPC file. They should be recorded in the data.Artefacts[] array.
+    """
+    ParentWellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:master-data--Wellbore:100000040217:'],
+        title='Parent Wellbore Identifier',
+    )
+    """
+    Identifier of the Parent Wellbore
+    """
+    ParentAssemblyID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=[
+            'namespace:work-product-component--TubularAssembly:100000040217.abcde:'
+        ],
+        title='Parent Tubular Assembly Identifier',
+    )
+    """
+    Identifier of the Parent Tubular Assembly
+    """
+    ExternalComponentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularExtCompType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularExtCompType:BowCentralizer:'],
+        title='External Component Type Identifier',
+    )
+    """
+    Identifier of the External Component Type
+    """
+    NumberOfItems: int | None = Field(None, examples=[1767], title='Number of Items')
+    """
+    Number of Items
+    """
+    TopMeasuredDepth: float | None = Field(
+        None, examples=['5600 ft'], title='Top Measured Depth'
+    )
+    """
+    Top of the Measured Depth interval where the External Components are installed
+    """
+    BaseMeasuredDepth: float | None = Field(
+        None, examples=['10900 ft'], title='Base Measured Depth'
+    )
+    """
+    Base of the Measured Depth interval where the External Components are installed
+    """
+    Spacing: float | None = Field(None, examples=['40 ft'], title='Spacing')
+    """
+    External Components spacing (length)
+    """
+    AttachMechanismID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularExtCompAttachMechanism:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularExtCompAttachMechanism:Clamped:'],
+        title='Attach Mechanism ID',
+    )
+    """
+    Attach Mechanism
+    """
+    AttachPatternID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularExtCompAttachPattern:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularExtCompAttachPattern:11:'],
+        title='Attach Pattern ID',
+    )
+    """
+    Attach pattern describing placement frequency
+    """
+    Weight: float | None = Field(
+        None, examples=['5 lbm'], title='External Component weight per item'
+    )
+    """
+    External Component weight per item
+    """
+    Length: float | None = Field(
+        None, examples=['2 ft'], title='External component length'
+    )
+    """
+    External component length of each item
+    """
+    Remark: str | None = Field(
+        None, examples=['Attached at connection'], title='Remarks'
+    )
+    """
+    Any additional comments/remarks
+    """
+    OuterDiameter: float | None = Field(
+        None, examples=['9.625 in'], title='Outer Diameter'
+    )
+    """
+    The outer diameter of the external component.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/tubular_umbilical/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/workproductcomponent/tubular_umbilical/v1_0_0.py

@@ -0,0 +1,74 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/tubular_umbilical/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_0_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_0_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for TubularUmbilical 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ParentWellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Parent Wellbore Identifier')
+    """
+    Identifier of the Parent Wellbore
+    """
+    ParentAssemblyID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Parent Tubular Assembly Identifier')
+    """
+    Identifier of the Parent Tubular Assembly
+    """
+    ConnectedTubularComponentID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularComponent:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Parent Tubular Component')
+    """
+    Identifier of the Wellhead Outlet the Umbilical is connected to
+    """
+    WellheadOutletKeyID: str | None = Field(None, title='WellHead Outlet Identifier')
+    """
+    Identifier of the Wellhead Outlet the Umbilical is connected to
+    """
+    UmbilicalTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularUmbilicalType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Umbilical Type Identifier')
+    """
+    Identifier of the Umbilical Type
+    """
+    Cut: bool | None = Field(None, title='Cut')
+    """
+    Flag describing the existence of a cut (accidentally or intentionally) in the line
+    """
+    CutDate: str | None = Field(None, title='Cut Date')
+    """
+    The date the cut has happened
+    """
+    CutMD: float | None = Field(None, title='Cut Measured Depth')
+    """
+    Measured Depth at which the cut has happened
+    """
+    ServiceTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularUmbilicalServiceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Service Type Identifier')
+    """
+    Identifier of the Type of Service the umbilical is facilitating
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/tubular_umbilical/v1_1_0.py

@@ -0,0 +1,74 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/tubular_umbilical/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_1_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for TubularUmbilical 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ParentWellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Parent Wellbore Identifier')
+    """
+    Identifier of the Parent Wellbore
+    """
+    ParentAssemblyID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Parent Tubular Assembly Identifier')
+    """
+    Identifier of the Parent Tubular Assembly
+    """
+    ConnectedTubularComponentID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularComponent:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Parent Tubular Component')
+    """
+    Identifier of the Wellhead Outlet the Umbilical is connected to
+    """
+    WellheadOutletKeyID: str | None = Field(None, title='WellHead Outlet Identifier')
+    """
+    Identifier of the Wellhead Outlet the Umbilical is connected to
+    """
+    UmbilicalTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularUmbilicalType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Umbilical Type Identifier')
+    """
+    Identifier of the Umbilical Type
+    """
+    Cut: bool | None = Field(None, title='Cut')
+    """
+    Flag describing the existence of a cut (accidentally or intentionally) in the line
+    """
+    CutDate: str | None = Field(None, title='Cut Date')
+    """
+    The date the cut has happened
+    """
+    CutMD: float | None = Field(None, title='Cut Measured Depth')
+    """
+    Measured Depth at which the cut has happened
+    """
+    ServiceTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularUmbilicalServiceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Service Type Identifier')
+    """
+    Identifier of the Type of Service the umbilical is facilitating
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/tubular_umbilical/v1_2_0.py

@@ -0,0 +1,74 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/tubular_umbilical/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for TubularUmbilical 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ParentWellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Parent Wellbore Identifier')
+    """
+    Identifier of the Parent Wellbore
+    """
+    ParentAssemblyID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Parent Tubular Assembly Identifier')
+    """
+    Identifier of the Parent Tubular Assembly
+    """
+    ConnectedTubularComponentID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularComponent:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Parent Tubular Component')
+    """
+    Identifier of the Wellhead Outlet the Umbilical is connected to
+    """
+    WellheadOutletKeyID: str | None = Field(None, title='WellHead Outlet Identifier')
+    """
+    Identifier of the Wellhead Outlet the Umbilical is connected to
+    """
+    UmbilicalTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularUmbilicalType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Umbilical Type Identifier')
+    """
+    Identifier of the Umbilical Type
+    """
+    Cut: bool | None = Field(None, title='Cut')
+    """
+    Flag describing the existence of a cut (accidentally or intentionally) in the line
+    """
+    CutDate: str | None = Field(None, title='Cut Date')
+    """
+    The date the cut has happened
+    """
+    CutMD: float | None = Field(None, title='Cut Measured Depth')
+    """
+    Measured Depth at which the cut has happened
+    """
+    ServiceTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularUmbilicalServiceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Service Type Identifier')
+    """
+    Identifier of the Type of Service the umbilical is facilitating
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/unsealed_surface_framework/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4