Skip to main content

IEntityUpdateInfo<TEntity>

Namespace: Meshmakers.Octo.Runtime.Contracts

Interface for an entity update info.

public interface IEntityUpdateInfo<TEntity>

Type Parameters​

TEntity

Properties​

RtEntity​

Entity for modification.

public abstract TEntity RtEntity { get; }

Property Value​

TEntity

RtId​

Runtime Identifier of an existing entity.

public abstract Nullable<OctoObjectId> RtId { get; }

Property Value​

Nullable<OctoObjectId>

CkTypeId​

Construction Kit Type Identifier of entity to be modified.

public abstract RtCkId<CkTypeId> CkTypeId { get; }

Property Value​

RtCkId<CkTypeId>

ModOption​

MOD option.

public abstract EntityModOptions ModOption { get; }

Property Value​

EntityModOptions

UpdateGuard​

Optional optimistic-concurrency guard applied to EntityModOptions.Update operations. When set, the write is skipped if the guard does not match — see AttributeNewerThanGuard. Ignored for non-update mod options.

public abstract AttributeNewerThanGuard UpdateGuard { get; }

Property Value​

AttributeNewerThanGuard

ClearSecretAttributes​

Names (PascalCase, as in RtTypeWithAttributes.Attributes) of top-level Secret attributes to clear explicitly (AB#5532, concept §4.3 clearSecretAttributes). Clearing is the only way to remove a stored secret through an update: an omitted, "" or (at the API) null secret means "unchanged". Applies to EntityModOptions.Update and EntityModOptions.Replace; on EntityModOptions.Insert a listed attribute is simply not set. The rule engine rejects a name that is not a Secret attribute of the type, a required secret, and a non-empty value for the same attribute in the same operation. null or empty = nothing to clear.

public IReadOnlyCollection<string> ClearSecretAttributes { get; }

Property Value​

IReadOnlyCollection<String>

Methods​

GetRtEntityId()​

Gets the runtime entity identifier.

RtEntityId GetRtEntityId()

Returns​

RtEntityId