kappa_sdk.WellPropertyContainer#

class kappa_sdk.WellPropertyContainer(field_id, well_id, well_property_container_id, name, aliases, labels, is_master, cluster_apis, dto_converter)[source]#

Well property container object.

Presents a KAPPA Automate well property container object.

Attributes

WellPropertyContainer.id

Gets the id of the WellPropertyContainer object.

WellPropertyContainer.is_master

Gets a value indicating whether this contains is a master one.

WellPropertyContainer.labels

Gets the labels of the WellPropertyContainer object.

WellPropertyContainer.name

Gets the name of the WellPropertyContainer.

Methods

WellPropertyContainer.delete_well_property_values(...)

Deletes values of a given well property for a given range in this WellPropertyContainer, all values will be deleted if from_time and to_time are undefined.

WellPropertyContainer.get_well_properties([...])

Gets a dictionary of alias/value pairs for all well properties in this WellPropertyContainer.

WellPropertyContainer.get_well_property_values(...)

Gets a vector of values for a given well property from this WellPropertyContainer.

WellPropertyContainer.set_well_property_value(...)

Updates a value of a given well property in this WellPropertyContainer.
Parameters:

  • field_id (str)

  • well_id (str)

  • well_property_container_id (str)

  • name (str)

  • aliases (List[str])

  • labels (List[str])

  • is_master (bool)

  • cluster_apis (ClusterAPIS)

  • dto_converter (WellPropertyDtoConverter)

__init__(field_id, well_id, well_property_container_id, name, aliases, labels, is_master, cluster_apis, dto_converter)[source]#
Parameters:

  • field_id (str)

  • well_id (str)

  • well_property_container_id (str)

  • name (str)

  • aliases (List[str])

  • labels (List[str])

  • is_master (bool)

  • cluster_apis (ClusterAPIS)

  • dto_converter (WellPropertyDtoConverter)

property id: str#

Gets the id of the WellPropertyContainer object.

property name: str#

Gets the name of the WellPropertyContainer.

property is_master: bool#

Gets a value indicating whether this contains is a master one.

property labels: List[str]#

Gets the labels of the WellPropertyContainer object.

get_well_properties(validity_date=None)[source]#

Gets a dictionary of alias/value pairs for all well properties in this WellPropertyContainer.

Parameters:

validity_date (datetime | None) – The validity date of values. If not specified, latest values will be returned.

Return type:

Dict[str, Any]

get_well_property_values(well_property_alias, from_time=None, to_time=None, count=-1, last=False, unit=None)[source]#

Gets a vector of values for a given well property from this WellPropertyContainer.

Parameters:

  • well_property_alias (str) – The alias of the well property.

  • from_time (datetime | None) – Date to start reading from.

  • to_time (datetime | None) – Date to read the data up to.

  • count (int) – Maximum count of points to return, regardless of from/to settings.

  • last (bool) – Will return last (count) of points if set to true.

  • unit (UnitEnum | None) – Convert values from internal units to a specific unit.

Returns:

Vector – Vector that contains the requested data values.

Return type:

Vector

delete_well_property_values(well_property_alias, from_time=None, to_time=None)[source]#

Deletes values of a given well property for a given range in this WellPropertyContainer, all values will be deleted if from_time and to_time are undefined.

Parameters:

  • well_property_alias (str) – The alias of well property to update.

  • from_time (datetime | None) – The date from where values have to be removed, can be None

  • to_time (datetime | None) – The date until where values have to be removed, can be None

Return type:

None

set_well_property_value(well_property_alias, value, timestamp=datetime.datetime(2025, 10, 16, 16, 12, 16, 645986, tzinfo=datetime.timezone.utc))[source]#

Updates a value of a given well property in this WellPropertyContainer.

Parameters:

  • well_property_alias (str) – The alias of well property to update.

  • value (str | bool | float | None) – The new value of the well property.

  • timestamp (datetime | None) – The timestamp that will be applied to the property value. If not specified, it will be set to the current date/time.

Return type:

None