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

osdu_models/dataset/file_prodml/v1_1_0.py

@@ -0,0 +1,169 @@
+# generated by datamodel-codegen:
+#   filename:  dataset/file_prodml/v1_1_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_file_source_info import v1_0_1
+from typing import Any
+
+
+class Endian(Enum):
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+
+    BIG = 'BIG'
+    LITTLE = 'LITTLE'
+
+
+class DatasetProperties(BaseModel):
+    """
+    The dataset properties for a single file.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileSourceInfo: v1_0_1.AbstractFileSourceInfo | None = Field(
+        None, title='File Source Info'
+    )
+    """
+    Information about the single file.
+    """
+
+
+class Data(BaseModel):
+    """
+    The schema fragment representing single files
+    """
+
+    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.
+    """
+    Name: str | None = Field(None, examples=['Dataset X221/15'], title='Name')
+    """
+    An optional name of the dataset, e.g. a user friendly file or file collection name.
+    """
+    Description: str | None = Field(
+        None, examples=['As originally delivered by ACME.com.'], title='Description'
+    )
+    """
+    An optional, textual description of the dataset.
+    """
+    TotalSize: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=['42949672960'], title='Total Size'
+    )
+    """
+    Total size of the dataset in bytes; for files it is the same as declared in FileSourceInfo.FileSize or the sum of all individual files. Implemented as string. The value must be convertible to a long integer (sizes can become very large).
+    """
+    EncodingFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-EncodingFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--EncodingFormatType:text%2Fcsv:'],
+        title='Encoding Format Type ID',
+    )
+    """
+    EncodingFormatType ID reference value relationship. It can be a mime-type or media-type.
+    """
+    SchemaFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SchemaFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SchemaFormatType:CWLS%20LAS3:'],
+        title='Schema Format Type ID',
+    )
+    """
+    Relationship to the SchemaFormatType reference value.
+    """
+    Endian_1: Endian | None = Field(None, alias='Endian')
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+    DatasetProperties_1: DatasetProperties = Field(
+        ..., alias='DatasetProperties', examples=[{}], title='Dataset Properties'
+    )
+    """
+    The dataset properties for a single file.
+    """
+    Checksum: constr(pattern=r'^[0-9a-fA-F]{32}') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='MD5 Checksum'
+    )
+    """
+    MD5 checksum of file bytes - a 32 byte hexadecimal number.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/dataset/file_seismic_histogram/__init__.py

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

osdu_models/dataset/file_seismic_histogram/v1_0_0.py

@@ -0,0 +1,179 @@
+# generated by datamodel-codegen:
+#   filename:  dataset/file_seismic_histogram/v1_0_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_file_source_info import v1_0_0
+from typing import Any
+
+
+class Endian(Enum):
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+
+    BIG = 'BIG'
+    LITTLE = 'LITTLE'
+
+
+class DatasetProperties(BaseModel):
+    """
+    The dataset properties for a single file.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileSourceInfo: v1_0_0.AbstractFileSourceInfo | None = Field(
+        None, title='File Source Info'
+    )
+    """
+    Information about the single file.
+    """
+
+
+class Data(BaseModel):
+    """
+    The schema fragment representing single files
+    """
+
+    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.
+    """
+    Name: str | None = Field(None, examples=['Dataset X221/15'], title='Name')
+    """
+    An optional name of the dataset, e.g. a user friendly file or file collection name.
+    """
+    Description: str | None = Field(
+        None, examples=['As originally delivered by ACME.com.'], title='Description'
+    )
+    """
+    An optional, textual description of the dataset.
+    """
+    TotalSize: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=[13245217273], title='Total Size'
+    )
+    """
+    Total size of the dataset in bytes; for files it is the same as declared in FileSourceInfo.FileSize or the sum of all individual files. Implemented as string. The value must be convertible to a long integer (sizes can become very large).
+    """
+    EncodingFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-EncodingFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--EncodingFormatType:text%2Fcsv:'],
+        title='Encoding Format Type ID',
+    )
+    """
+    EncodingFormatType ID reference value relationship. It can be a mime-type or media-type.
+    """
+    SchemaFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SchemaFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SchemaFormatType:CWLS%20LAS3:'],
+        title='Schema Format Type ID',
+    )
+    """
+    Relationship to the SchemaFormatType reference value.
+    """
+    Endian_1: Endian | None = Field(None, alias='Endian')
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+    DatasetProperties_1: DatasetProperties = Field(
+        ..., alias='DatasetProperties', examples=[{}], title='Dataset Properties'
+    )
+    """
+    The dataset properties for a single file.
+    """
+    Checksum: constr(pattern=r'^[0-9a-fA-F]{32}') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='MD5 Checksum'
+    )
+    """
+    MD5 checksum of file bytes - a 32 byte hexadecimal number.
+    """
+    ContentSchemaKind: (
+        constr(pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$') | None
+    ) = Field(
+        None,
+        examples=['osdu:wks:content--SeismicHistogram:1.0.0'],
+        title='Content Schema Kind',
+    )
+    """
+    The schema kind used for the content in the associated file.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/dataset/file_seismic_histogram/v1_1_0.py

@@ -0,0 +1,179 @@
+# generated by datamodel-codegen:
+#   filename:  dataset/file_seismic_histogram/v1_1_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_file_source_info import v1_0_1
+from typing import Any
+
+
+class Endian(Enum):
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+
+    BIG = 'BIG'
+    LITTLE = 'LITTLE'
+
+
+class DatasetProperties(BaseModel):
+    """
+    The dataset properties for a single file.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileSourceInfo: v1_0_1.AbstractFileSourceInfo | None = Field(
+        None, title='File Source Info'
+    )
+    """
+    Information about the single file.
+    """
+
+
+class Data(BaseModel):
+    """
+    The schema fragment representing single files
+    """
+
+    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.
+    """
+    Name: str | None = Field(None, examples=['Dataset X221/15'], title='Name')
+    """
+    An optional name of the dataset, e.g. a user friendly file or file collection name.
+    """
+    Description: str | None = Field(
+        None, examples=['As originally delivered by ACME.com.'], title='Description'
+    )
+    """
+    An optional, textual description of the dataset.
+    """
+    TotalSize: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=['42949672960'], title='Total Size'
+    )
+    """
+    Total size of the dataset in bytes; for files it is the same as declared in FileSourceInfo.FileSize or the sum of all individual files. Implemented as string. The value must be convertible to a long integer (sizes can become very large).
+    """
+    EncodingFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-EncodingFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--EncodingFormatType:text%2Fcsv:'],
+        title='Encoding Format Type ID',
+    )
+    """
+    EncodingFormatType ID reference value relationship. It can be a mime-type or media-type.
+    """
+    SchemaFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SchemaFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SchemaFormatType:CWLS%20LAS3:'],
+        title='Schema Format Type ID',
+    )
+    """
+    Relationship to the SchemaFormatType reference value.
+    """
+    Endian_1: Endian | None = Field(None, alias='Endian')
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+    DatasetProperties_1: DatasetProperties = Field(
+        ..., alias='DatasetProperties', examples=[{}], title='Dataset Properties'
+    )
+    """
+    The dataset properties for a single file.
+    """
+    Checksum: constr(pattern=r'^[0-9a-fA-F]{32}') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='MD5 Checksum'
+    )
+    """
+    MD5 checksum of file bytes - a 32 byte hexadecimal number.
+    """
+    ContentSchemaKind: (
+        constr(pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$') | None
+    ) = Field(
+        None,
+        examples=['osdu:wks:content--SeismicHistogram:1.0.0'],
+        title='Content Schema Kind',
+    )
+    """
+    The schema kind used for the content in the associated file.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/dataset/file_seismic_line_geometry/__init__.py

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