Class: ResolveNexusOperationStart
coresdk.workflow_activation.ResolveNexusOperationStart
Represents a ResolveNexusOperationStart.
Implements
Constructors
constructor
• new ResolveNexusOperationStart(properties?
): ResolveNexusOperationStart
Constructs a new ResolveNexusOperationStart.
Parameters
Name | Type | Description |
---|---|---|
properties? | IResolveNexusOperationStart | Properties to set |
Returns
Properties
failed
• Optional
failed: null
| IFailure
The operation either failed to start, was cancelled before it started, timed out, or failed synchronously. Details are included inside the message. In this case, the subsequent ResolveNexusOperation will never be sent.
Implementation of
IResolveNexusOperationStart.failed
operationToken
• Optional
operationToken: null
| string
The operation started asynchronously. Contains a token that can be used to perform
operations on the started operation by, ex, clients. A ResolveNexusOperation
job will
follow at some point.
Implementation of
IResolveNexusOperationStart.operationToken
seq
• seq: number
Sequence number as provided by lang in the corresponding ScheduleNexusOperation command
Implementation of
IResolveNexusOperationStart.seq
startedSync
• Optional
startedSync: null
| boolean
If true the operation "started" but only because it's also already resolved. A
ResolveNexusOperation
job will be in the same activation.
Implementation of
IResolveNexusOperationStart.startedSync
status
• Optional
status: "failed"
| "operationToken"
| "startedSync"
ResolveNexusOperationStart status.
Methods
toJSON
▸ toJSON(): Object
Converts this ResolveNexusOperationStart to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): ResolveNexusOperationStart
Creates a new ResolveNexusOperationStart instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IResolveNexusOperationStart | Properties to set |
Returns
ResolveNexusOperationStart instance
decode
▸ decode(reader
, length?
): ResolveNexusOperationStart
Decodes a ResolveNexusOperationStart 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
ResolveNexusOperationStart
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): ResolveNexusOperationStart
Decodes a ResolveNexusOperationStart message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ResolveNexusOperationStart
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 ResolveNexusOperationStart message. Does not implicitly coresdk.workflow_activation.ResolveNexusOperationStart.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IResolveNexusOperationStart | ResolveNexusOperationStart message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message
, writer?
): Writer
Encodes the specified ResolveNexusOperationStart message, length delimited. Does not implicitly coresdk.workflow_activation.ResolveNexusOperationStart.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IResolveNexusOperationStart | ResolveNexusOperationStart message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object
): ResolveNexusOperationStart
Creates a ResolveNexusOperationStart message from a plain object. Also converts values to their respective internal types.
Parameters
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
ResolveNexusOperationStart
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for ResolveNexusOperationStart
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 ResolveNexusOperationStart message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | ResolveNexusOperationStart | ResolveNexusOperationStart |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object