Class: BackfillRequest
Represents a BackfillRequest.
Properties
endTime
• Optional endTime: null | $Properties
BackfillRequest endTime.
overlapPolicy
• overlapPolicy: ScheduleOverlapPolicy
If set, override overlap policy for this request.
startTime
• Optional startTime: null | $Properties
Time range to evaluate schedule in. Currently, this time range is exclusive on start_time and inclusive on end_time. (This is admittedly counterintuitive and it may change in the future, so to be safe, use a start time strictly before a scheduled time.) Also note that an action nominally scheduled in the interval but with jitter that pushes it after end_time will not be included.
Methods
toJSON
▸ toJSON(): Object
Converts this BackfillRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BackfillRequest & $Properties
Creates a new BackfillRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
BackfillRequest instance
▸ create(properties?): BackfillRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): BackfillRequest & $Properties
Decodes a BackfillRequest 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
BackfillRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BackfillRequest & $Properties
Decodes a BackfillRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BackfillRequest
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 BackfillRequest message. Does not implicitly temporal.api.schedule.v1.BackfillRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BackfillRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BackfillRequest message, length delimited. Does not implicitly temporal.api.schedule.v1.BackfillRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BackfillRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BackfillRequest
Creates a BackfillRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BackfillRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a BackfillRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BackfillRequest | BackfillRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object