Skip to content

Document SearchAttributes parsing #154

Open
@lorensr

Description

@lorensr

Is your feature request related to a problem? Please describe.

SearchAttributes:

// A user-defined set of *indexed* fields that are used/exposed when listing/searching workflows.
// The payload is not serialized in a user-defined way.
message SearchAttributes {
map<string, Payload> indexed_fields = 1;
}

I don't know from reading this proto how to specify search attribute types in StartWorkflowExecution. Possible types are:

enum IndexedValueType {
INDEXED_VALUE_TYPE_UNSPECIFIED = 0;
INDEXED_VALUE_TYPE_TEXT = 1;
INDEXED_VALUE_TYPE_KEYWORD = 2;
INDEXED_VALUE_TYPE_INT = 3;
INDEXED_VALUE_TYPE_DOUBLE = 4;
INDEXED_VALUE_TYPE_BOOL = 5;
INDEXED_VALUE_TYPE_DATETIME = 6;
}

image

https://docs.temporal.io/docs/concepts/what-is-a-search-attribute/#custom-search-attributes

Describe the solution you'd like

A comment explaining how the Payloads are parsed, for example:

// Each Payload has a metadata.type: IndexedValueType
// If payload.metata.type is INDEXED_VALUE_TYPE_DATETIME, payload.data should be an integer with milliseconds since epoch.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions