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

osdu_models/workproductcomponent/document/v1_3_0.py

@@ -0,0 +1,88 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/document/v1_3_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 Document 1.3.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DocumentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DocumentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    DEPRECATED: Use the DocumentTaxonomyID. The kind of document--from a business standpoint, e.g., seismic processing report, etc.
+    """
+    DocumentTaxonomyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DocumentTaxonomy:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Document Taxonomy  ID')
+    """
+    The Document Taxonomy provides a structured taxonomy for categorising document types. This taxonomy adheres to a consistent naming convention of a DISCIPLINE followed by a relevant DocumentType. In the practical implementation it uses a dot-based nomenclature e.g., <DISCIPLINE>.<DocumentType>, allowing for a two level hierarchy of the document type to support classification and search. This a recommended property.
+    """
+    NumberOfPages: int | None = None
+    """
+    Number of pages in the document, useful in cases where if it was described in the acquired manifest as opposed to a derived/calculated value
+    """
+    SubTitle: str | None = None
+    """
+    The sub-title of the document.
+    """
+    DocumentSubject: str | None = None
+    """
+    A description text or an array of subjects covered by the document. If present this information must compliment the Tag and SubTitle
+    """
+    DatePublished: str | None = None
+    """
+    The UTC date time and date of the document publication
+    """
+    DateModified: str | None = None
+    """
+    The UTC date time and date of the document when it was last modified
+    """
+    DocumentLanguage: str | None = None
+    """
+    Document language as listed in the ISO 639-3 https://en.wikipedia.org/wiki/ISO_639, https://en.wikipedia.org/wiki/List_of_ISO_639-3_codes
+    """
+    DateReviewDue: str | None = Field(None, title='Date Review Due')
+    """
+    Date when a next review/revision of the document is due.
+    """
+    DateIssued: str | None = Field(None, title='Date Issued')
+    """
+    Formal sign-off / approval date (may be different from DatePublished)
+    """
+    RetentionPeriod: float | None = Field(None, examples=[5], title='Retention Period')
+    """
+    Number of years the document needs to be retained after the last modification (see data.DataModified property).
+    """
+    Summary: str | None = Field(None, title='Summary')
+    """
+    Summary of document contents
+    """
+    TableOfContents: str | None = Field(None, title='Table Of Contents')
+    """
+    Table of contents of the document
+    """
+    Keywords: list[str] | None = Field(None, title='Keywords')
+    """
+    Array of key words describing the document
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/document/v2_0_0.py

@@ -0,0 +1,95 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/document/v2_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_1 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 Document 2.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    TaxonomyIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-DocumentTaxonomy:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Taxonomy IDs')
+    """
+    The Document Taxonomy provides a structured taxonomy for categorising document types. This taxonomy adheres to a consistent naming convention of a DISCIPLINE followed by a document type, using a dot-based nomenclature e.g., <DISCIPLINE>.<Document Type>. This creates a two level hierarchy of the document type to support classification and search. This a recommended property. A Document may have one or more document types (for example, End of Well Reports may contain a wide range of information).
+    """
+    NumberOfPages: int | None = None
+    """
+    Number of pages in the document, useful in cases where if it was described in the acquired manifest as opposed to a derived/calculated value
+    """
+    SubTitle: str | None = None
+    """
+    The sub-title of the document.
+    """
+    Subject: str | None = None
+    """
+    A description text or an array of subjects covered by the document. If present this information must complement the Tag and SubTitle
+    """
+    DatePublished: str | None = None
+    """
+    The UTC date time and date of the document publication
+    """
+    DateModified: str | None = None
+    """
+    The UTC date time and date of the document when it was last modified
+    """
+    Languages: list[str] | None = None
+    """
+    The language(s) in which the document is written, provided as one or more three letter language codes as listed in ISO 639-3. https://en.wikipedia.org/wiki/ISO_639, https://en.wikipedia.org/wiki/List_of_ISO_639-3_codes
+    """
+    DateReviewDue: str | None = Field(None, title='Date Review Due')
+    """
+    Date when a next review/revision of the document is due.
+    """
+    DateIssued: str | None = Field(None, title='Date Issued')
+    """
+    Formal sign-off / approval date (may be different from DatePublished)
+    """
+    RetentionPeriod: float | None = Field(None, examples=[5], title='Retention Period')
+    """
+    Number of years the document needs to be retained after the last modification (see data.DataModified property).
+    """
+    Summary: str | None = Field(None, title='Summary')
+    """
+    Summary of document contents
+    """
+    TableOfContents: str | None = Field(None, title='Table Of Contents')
+    """
+    Table of contents of the document
+    """
+    Keywords: list[str] | None = Field(None, title='Keywords')
+    """
+    Array of key words describing the document
+    """
+    ProducedByOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Produced By Organisation ID')
+    """
+    The organisation or institution that produced this document
+    """
+    ProducedForOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Produced For Organisation ID')
+    """
+    The organisation or institution that this document was produced this for
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/downtime_event/__init__.py

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

osdu_models/workproductcomponent/downtime_event/v1_0_0.py

@@ -0,0 +1,323 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/downtime_event/v1_0_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 = Field(None, title='Name')
+    """
+    The name of this downtime event.
+    """
+    Description: str | None = None
+    """
+    Description.  Summary of the work product component.  Not the same as Remark which captures thoughts of creator about the wpc.
+    """
+    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.
+    """
+    ReportingEntityID: constr(
+        pattern=r'^[\w\-\.]+:(master-data\-\-Field|master-data\-\-Reservoir|master-data\-\-ReservoirSegment|master-data\-\-Well|master-data\-\-Wellbore|master-data\-\-IsolatedInterval|master-data\-\-WellboreOpening):[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Reporting Entity')
+    """
+    Reporting entity which provides the reference to the master entity the downtime event occurred at.
+    """
+    EventStartTime: str = Field(..., title='Event Start Time')
+    """
+    The date and time the downtime event began
+    """
+    EventEndTime: str | None = Field(None, title='Event End Time')
+    """
+    The date and time the downtime event ended
+    """
+    DowntimeComponentID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DowntimeComponentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--DowntimeComponentType:S_COMP_GAS:'],
+        title='Downtime Component',
+    )
+    """
+    Identifies the "Where" condition of the downtime event; i.e. which component of the system was affected? The downtime component values are further sorted into Surface and Subsurface components
+    """
+    DowntimeReasonID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DowntimeReasonType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--DowntimeReasonType:10_OPTIMIZE:'],
+        title='Downtime Reason',
+    )
+    """
+    Identifies the "What" condition of the downtime event; i.e. what general type of activity or issue was involved? The downtime reason codes are grouped into Planned and Unplanned categories
+    """
+    DowntimeReasonDetailID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DowntimeReasonDetailType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--DowntimeReasonDetailType:CAPACITY:'],
+        title='Downtime Reason Detail',
+    )
+    """
+    Identifies the "Why" condition of the downtime event; i.e. why did it occur? These are the basic reasons for, or causes of the event
+    """
+    EquipmentIdentifier: str | None = Field(None, title='Equipment Identifier')
+    """
+    The identifier of the piece of equipment that caused the downtime. This is an identifier to an external system, not an OSDU resource.
+    """
+    WorkOrderIdentifier: str | None = Field(None, title='Work Order Identifier')
+    """
+    The identifier of a work order which is associated with an event caused by a piece of equipment. This is an identifier to an external system, not an OSDU resource.
+    """
+    ParentDowntimeEventID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-DowntimeEvent:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Parent Downtime Event')
+    """
+    If there is a parent downtime event which has caused this event (e.g. a production processing facility is down, causing downtime for connected wells), then this attribute specifies the unique identifier of the entity associated with the parent event. If there is no parent event then this value is null
+    """
+    DownTimeTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DownTimeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Down Time Type ID')
+    """
+    Identifier of the record that specifies the loss caused by this event, or the type of the down time event is Planned, Unplanned or External.
+    """
+    EventStatusID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DowntimeEventStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Event Status ID')
+    """
+    Identifier of the record that specifies the event status, such as is suspended'' or complete''.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/earth_model_interpretation/__init__.py

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