Class SearchAttributeUpdate

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

A single mutation to a search attribute key. This can be a set or, if HasValue is false, an unset.

public abstract class SearchAttributeUpdate

Inheritance

object

SearchAttributeUpdate

Derived

SearchAttributeUpdate<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

HasValue

Gets a value indicating whether this update has a value to set or represents an unset.

public bool HasValue { get; }

Property Value

bool

UntypedKey

Gets the untyped form of the key to update.

public abstract SearchAttributeKey UntypedKey { get; }

Property Value

SearchAttributeKey

UntypedValue

Gets the untyped value to update.

public abstract object UntypedValue { get; }

Property Value

object

Exceptions

InvalidOperationException

If there is no value.

Methods

ValueSet<T>(SearchAttributeKey<T>, T)

Create an update to set a key. Users may prefer ValueSet(T) instead.

public static SearchAttributeUpdate<T> ValueSet<T>(SearchAttributeKey<T> key, T value) where T : notnull

Parameters

key SearchAttributeKey<T>

Key to set.

value T

Value to set.

Returns

SearchAttributeUpdate<T>

Search attribute update.

Type Parameters

T

Key type.

ValueUnset<T>(SearchAttributeKey<T>)

Create an update to unset a key. Users may prefer ValueUnset() instead.

public static SearchAttributeUpdate<T> ValueUnset<T>(SearchAttributeKey<T> key) where T : notnull

Parameters

key SearchAttributeKey<T>

Key to unset.

Returns

SearchAttributeUpdate<T>

Search attribute update.

Type Parameters

T

Key type.