Class: UpsertWorkflowSearchAttributes
coresdk.workflow_commands.UpsertWorkflowSearchAttributes
Represents an UpsertWorkflowSearchAttributes.
Implements
Constructors
constructor
• new UpsertWorkflowSearchAttributes(properties?): UpsertWorkflowSearchAttributes
Constructs a new UpsertWorkflowSearchAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpsertWorkflowSearchAttributes | Properties to set |
Returns
UpsertWorkflowSearchAttributes
Properties
searchAttributes
• searchAttributes: Object
SearchAttributes fields - equivalent to indexed_fields on api. Key = search index, Value = value?
Index signature
▪ [k: string]: IPayload
Implementation of
IUpsertWorkflowSearchAttributes.searchAttributes
Methods
toJSON
▸ toJSON(): Object
Converts this UpsertWorkflowSearchAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpsertWorkflowSearchAttributes
Creates a new UpsertWorkflowSearchAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpsertWorkflowSearchAttributes | Properties to set |
Returns
UpsertWorkflowSearchAttributes
UpsertWorkflowSearchAttributes instance
decode
▸ decode(reader, length?): UpsertWorkflowSearchAttributes
Decodes an UpsertWorkflowSearchAttributes message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
UpsertWorkflowSearchAttributes
UpsertWorkflowSearchAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpsertWorkflowSearchAttributes
Decodes an UpsertWorkflowSearchAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpsertWorkflowSearchAttributes
UpsertWorkflowSearchAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified UpsertWorkflowSearchAttributes message. Does not implicitly coresdk.workflow_commands.UpsertWorkflowSearchAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpsertWorkflowSearchAttributes | UpsertWorkflowSearchAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpsertWorkflowSearchAttributes message, length delimited. Does not implicitly coresdk.workflow_commands.UpsertWorkflowSearchAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpsertWorkflowSearchAttributes | UpsertWorkflowSearchAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpsertWorkflowSearchAttributes
Creates an UpsertWorkflowSearchAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpsertWorkflowSearchAttributes
UpsertWorkflowSearchAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpsertWorkflowSearchAttributes
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from an UpsertWorkflowSearchAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpsertWorkflowSearchAttributes | UpsertWorkflowSearchAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object