GXEVOOBJMETA class

class GXEVOOBJMETA(handle=0)[source]

GXEVOOBJMETA class.

The GXEVOOBJMETA class is used to create Evo object metadata including object uuid, object path, version id, created at, created by, etag, workspace id, modified at, modified by and bounding box properties.

Note:

__init__(handle=0)[source]
classmethod create(metadata)[source]

Create an GXEVOOBJMETA object.

Parameters:

metadata (str) – Evo object metadata in JSON string, refer to H_EVOOBJMETA or annotations for Seequent.Evo.Client.Api.Core.GeoscienceObjectMetadata

Returns:

GXEVOOBJMETA object

Return type:

GXEVOOBJMETA

Added in version 2025.1.0.

License: Geosoft Open License

classmethod create_default()[source]

Create an empty GXEVOOBJMETA object.

Returns:

GXEVOOBJMETA object

Return type:

GXEVOOBJMETA

Added in version 2025.1.0.

License: Geosoft Open License

get_blob_hash(index, blob_hash)[source]

Return a blob hash by index.

Parameters:
  • index (int) – zero-based index of the blob hash to retrieve

  • blob_hash (str_ref) – blob content hash hex string

Returns:

0 on success, 1 if index out of range

Return type:

int

Added in version 2026.2.0.

License: Geosoft Open License

Note: Returns the blob hash at the specified index. Use get_blob_hash_count to determine the valid range of indices. Index 0 typically corresponds to the main data blob, with subsequent indices for auxiliary data (e.g., additional elevation grids or attributes). Returns 0 on success, 1 if the index is out of range.

get_blob_hash_count()[source]

Return the number of blob hashes stored.

Returns:

Number of blob hashes

Return type:

int

Added in version 2026.2.0.

License: Geosoft Open License

Note: Returns the count of blob content hashes stored in this metadata object. Blob hashes are the content-addressable identifiers for the Parquet data files that comprise the geoscience object.

get_bounding_box(bounding_box)[source]

Get Evo object bounding box in JSON string.

Parameters:

bounding_box (str_ref) – JSON string for bounding box, refer to H_EVOBOUNDINGBOX or annotations for Seequent.Evo.Client.Api.Core.Goose.Model.BoundingBox

Added in version 2025.1.0.

License: Geosoft Open License

get_manifest_hash(manifest_hash)[source]

Return the manifest hash stored after translation.

Parameters:

manifest_hash (str_ref) – SHA-256 hash hex string of the JSON manifest

Added in version 2026.2.0.

License: Geosoft Open License

Note: Returns the SHA-256 hash of the JSON manifest file that was computed after translating the source file to a geoscience object. The manifest hash uniquely identifies the translated object (structure + data references). Returns an empty string if no manifest hash has been stored.

get_modified_at(modified_at)[source]

Return the Evo object modified at.

Parameters:

modified_at (str_ref) – modified at

Added in version 2025.1.0.

License: Geosoft Open License

get_object_id(object_id)[source]

Return the Evo object Id.

Parameters:

object_id (str_ref) – object id

Added in version 2025.1.0.

License: Geosoft Open License

get_source_checksum(checksum)[source]

Return the source file checksum stored at publish time.

Parameters:

checksum (str_ref) – SHA-256 checksum hex string of the source file

Added in version 2026.1.0.

License: Geosoft Open License

Note: Returns the SHA-256 checksum of the local source file (e.g. the Geosoft grid file) that was computed when the object was last published to the Evo workspace. Returns an empty string if no checksum has been stored. The checksum is stored in the metadata JSON via create and is not modifiable through a setter — to update it, create a new GXEVOOBJMETA from an updated JSON string that includes the source_checksum field.

get_version_id(version_id)[source]

Return the Evo object version Id.

Parameters:

version_id (str_ref) – version id of the Evo object at the time of the last publish

Added in version 2026.1.0.

License: Geosoft Open License

get_workspace_id(workspace_id)[source]

Return the Evo workspace Id.

Parameters:

workspace_id (str_ref) – workspace id

Added in version 2025.1.0.

License: Geosoft Open License

is_null()[source]

Check if this is a null (undefined) instance

Returns:

True if this is a null (undefined) instance, False otherwise.

Return type:

bool

classmethod null()[source]

A null (undefined) instance of GXEVOOBJMETA

Returns:

A null GXEVOOBJMETA

Return type:

GXEVOOBJMETA

set_blob_hashes(blob_hashes_json)[source]

Replace the blob hash list on an existing GXEVOOBJMETA object.

Parameters:

blob_hashes_json (str) – JSON array string of blob content hash hex strings, e.g. ["hash1","hash2"]

Added in version 2026.2.0.

License: Geosoft Open License

Note: Replaces the entire blob_hashes list in a single call using a JSON array string (e.g. ["hash1","hash2"]). Passing an empty array ([]) clears the list. All other metadata fields are left unchanged. Blob hashes are the content-addressable identifiers for the Parquet data files that comprise the geoscience object.

set_manifest_hash(manifest_hash)[source]

Set the manifest hash on an existing GXEVOOBJMETA object.

Parameters:

manifest_hash (str) – SHA-256 hash hex string of the JSON manifest

Added in version 2026.2.0.

License: Geosoft Open License

Note: Updates the manifest_hash field in place without affecting any other fields. The manifest hash is the SHA-256 hash of the translated geoscience object’s JSON manifest and is used as the Tier 2 cache key.

set_source_checksum(checksum)[source]

Set the source file checksum on an existing GXEVOOBJMETA object.

Parameters:

checksum (str) – SHA-256 checksum hex string of the source file

Added in version 2026.2.0.

License: Geosoft Open License

Note: Updates the source_checksum field in place without affecting any other fields (object id, version id, workspace id, path, etc.). Intended for cache-update workflows where only the local-file checksum needs to be written back after a successful translation or publish, avoiding a full JSON round-trip.