Class WorkflowQueryDefinition

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Definition of a workflow query.

public class WorkflowQueryDefinition

Inheritance

object

WorkflowQueryDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Description

Gets the optional query description.

public string? Description { get; }

Property Value

string

Dynamic

Gets a value indicating whether the query is dynamic.

public bool Dynamic { get; }

Property Value

bool

Name

Gets the query name. This is null if the query is dynamic.

public string? Name { get; }

Property Value

string

Methods

CreateWithoutAttribute(string?, Delegate, string?)

Creates a query definition from an explicit name and method. Most users should use FromMethod(MethodInfo) with attributes instead.

public static WorkflowQueryDefinition CreateWithoutAttribute(string? name, Delegate del, string? description = null)

Parameters

name string

Query name. Null for dynamic query.

del Delegate

Query delegate.

description string

Optional description. WARNING: This setting is experimental.

Returns

WorkflowQueryDefinition

Query definition.

FromMethod(MethodInfo)

Get a query definition from a method or fail. The result is cached.

public static WorkflowQueryDefinition FromMethod(MethodInfo method)

Parameters

method MethodInfo

Query method.

Returns

WorkflowQueryDefinition

Query definition.

FromProperty(PropertyInfo)

Get a query definition from a property getter or fail. The result is cached.

public static WorkflowQueryDefinition FromProperty(PropertyInfo property)

Parameters

property PropertyInfo

Query property.

Returns

WorkflowQueryDefinition

Query definition.