Class: Sync
v1.StartOperationResponse.Sync
An operation completed successfully.
Implements
Constructors
constructor
• new Sync(properties?): Sync
Constructs a new Sync.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISync | Properties to set |
Returns
Properties
payload
• Optional payload: null | IPayload
Sync payload.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Sync to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Sync
Creates a new Sync instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISync | Properties to set |
Returns
Sync instance
decode
▸ decode(reader, length?): Sync
Decodes a Sync 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
Sync
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Sync
Decodes a Sync message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Sync
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 Sync message. Does not implicitly temporal.api.nexus.v1.StartOperationResponse.Sync.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISync | Sync message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Sync message, length delimited. Does not implicitly temporal.api.nexus.v1.StartOperationResponse.Sync.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISync | Sync message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Sync
Creates a Sync message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Sync
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Sync
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 a Sync message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Sync | Sync |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object