Class: RecordMarkerCommandAttributes
command.v1.RecordMarkerCommandAttributes
Represents a RecordMarkerCommandAttributes.
Properties
details
• details: Object
RecordMarkerCommandAttributes details.
Index signature
▪ [k: string]: $Properties
failure
• Optional failure: null | $Properties
RecordMarkerCommandAttributes failure.
header
• Optional header: null | $Properties
RecordMarkerCommandAttributes header.
markerName
• markerName: string
RecordMarkerCommandAttributes markerName.
Methods
toJSON
▸ toJSON(): Object
Converts this RecordMarkerCommandAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RecordMarkerCommandAttributes & $Shape
Creates a new RecordMarkerCommandAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
RecordMarkerCommandAttributes & $Shape
RecordMarkerCommandAttributes instance
▸ create(properties?): RecordMarkerCommandAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): RecordMarkerCommandAttributes & $Shape
Decodes a RecordMarkerCommandAttributes 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
RecordMarkerCommandAttributes & $Shape
RecordMarkerCommandAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RecordMarkerCommandAttributes & $Shape
Decodes a RecordMarkerCommandAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RecordMarkerCommandAttributes & $Shape
RecordMarkerCommandAttributes
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 RecordMarkerCommandAttributes message. Does not implicitly temporal.api.command.v1.RecordMarkerCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RecordMarkerCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RecordMarkerCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.RecordMarkerCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RecordMarkerCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RecordMarkerCommandAttributes
Creates a RecordMarkerCommandAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RecordMarkerCommandAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RecordMarkerCommandAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RecordMarkerCommandAttributes | RecordMarkerCommandAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object