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