Class SearchAttributeKey

Namespace

Temporalio.Common

Assembly

Temporalio.dll

A search attribute key and value type. Use one of the "Create" methods to create.

public class SearchAttributeKey : IComparable<SearchAttributeKey>

Inheritance

object

SearchAttributeKey

Implements

IComparable<SearchAttributeKey>

Derived

SearchAttributeKey<T>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Name

Gets the key name.

public string Name { get; }

Property Value

string

ValueType

Gets the key value type.

public IndexedValueType ValueType { get; }

Property Value

IndexedValueType

Methods

CompareTo(SearchAttributeKey?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(SearchAttributeKey? other)

Parameters

other SearchAttributeKey

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings: Value

Meaning

Less than zero

This instance precedes other in the sort order.

Zero

This instance occurs in the same position in the sort order as other.

Greater than zero

This instance follows other in the sort order.

CreateBool(string)

Create a "bool" search attribute key.

public static SearchAttributeKey<bool> CreateBool(string name)

Parameters

name string

Key name.

Returns

SearchAttributeKey<bool>

Search attribute key.

CreateDateTimeOffset(string)

Create a "datetime" search attribute key.

public static SearchAttributeKey<DateTimeOffset> CreateDateTimeOffset(string name)

Parameters

name string

Key name.

Returns

SearchAttributeKey<DateTimeOffset>

Search attribute key.

CreateDouble(string)

Create a "double" search attribute key.

public static SearchAttributeKey<double> CreateDouble(string name)

Parameters

name string

Key name.

Returns

SearchAttributeKey<double>

Search attribute key.

CreateKeyword(string)

Create a "keyword" search attribute key.

public static SearchAttributeKey<string> CreateKeyword(string name)

Parameters

name string

Key name.

Returns

SearchAttributeKey<string>

Search attribute key.

CreateKeywordList(string)

Create a "keyword list" search attribute key.

public static SearchAttributeKey<IReadOnlyCollection<string>> CreateKeywordList(string name)

Parameters

name string

Key name.

Returns

SearchAttributeKey<IReadOnlyCollection<string>>

Search attribute key.

CreateLong(string)

Create an "int" search attribute key.

public static SearchAttributeKey<long> CreateLong(string name)

Parameters

name string

Key name.

Returns

SearchAttributeKey<long>

Search attribute key.

CreateText(string)

Create a "text" search attribute key.

public static SearchAttributeKey<string> CreateText(string name)

Parameters

name string

Key name.

Returns

SearchAttributeKey<string>

Search attribute key.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(SearchAttributeKey?)

Test for equality.

public bool Equals(SearchAttributeKey? other)

Parameters

other SearchAttributeKey

Other key.

Returns

bool

Whether equal.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

Operators

operator ==(SearchAttributeKey?, SearchAttributeKey?)

Test equal.

public static bool operator ==(SearchAttributeKey? left, SearchAttributeKey? right)

Parameters

left SearchAttributeKey

Left.

right SearchAttributeKey

Right.

Returns

bool

Result.

operator >(SearchAttributeKey?, SearchAttributeKey?)

Test greater than.

public static bool operator >(SearchAttributeKey? left, SearchAttributeKey? right)

Parameters

left SearchAttributeKey

Left.

right SearchAttributeKey

Right.

Returns

bool

Result.

operator >=(SearchAttributeKey?, SearchAttributeKey?)

Test greater than or equal.

public static bool operator >=(SearchAttributeKey? left, SearchAttributeKey? right)

Parameters

left SearchAttributeKey

Left.

right SearchAttributeKey

Right.

Returns

bool

Result.

operator !=(SearchAttributeKey?, SearchAttributeKey?)

Test not equal.

public static bool operator !=(SearchAttributeKey? left, SearchAttributeKey? right)

Parameters

left SearchAttributeKey

Left.

right SearchAttributeKey

Right.

Returns

bool

Result.

operator <(SearchAttributeKey?, SearchAttributeKey?)

Test less than.

public static bool operator <(SearchAttributeKey? left, SearchAttributeKey? right)

Parameters

left SearchAttributeKey

Left.

right SearchAttributeKey

Right.

Returns

bool

Result.

operator <=(SearchAttributeKey?, SearchAttributeKey?)

Test less than or equal.

public static bool operator <=(SearchAttributeKey? left, SearchAttributeKey? right)

Parameters

left SearchAttributeKey

Left.

right SearchAttributeKey

Right.

Returns

bool

Result.