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