Skip to main content

Class: BackfillRequest

Represents a BackfillRequest.

Properties​

endTime?​

optional endTime?: $Properties | null

BackfillRequest endTime.

overlapPolicy​

overlapPolicy: ScheduleOverlapPolicy

If set, override overlap policy for this request.

startTime?​

optional startTime?: $Properties | null

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()​

Call Signature​

static create(properties?): BackfillRequest & $Properties

Creates a new BackfillRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BackfillRequest & $Properties

BackfillRequest instance

Call Signature​

static create(properties?): BackfillRequest

Creates a new BackfillRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BackfillRequest

BackfillRequest instance

decode()​

static decode(reader, length?): BackfillRequest & $Properties

Decodes a BackfillRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

BackfillRequest & $Properties

BackfillRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BackfillRequest & $Properties

Decodes a BackfillRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BackfillRequest & $Properties

BackfillRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified BackfillRequest message. Does not implicitly temporal.api.schedule.v1.BackfillRequest.verify|verify messages.

Parameters​

message​

$Properties

BackfillRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified BackfillRequest message, length delimited. Does not implicitly temporal.api.schedule.v1.BackfillRequest.verify|verify messages.

Parameters​

message​

$Properties

BackfillRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BackfillRequest

Creates a BackfillRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

BackfillRequest

BackfillRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a BackfillRequest message. Also converts values to other types if specified.

Parameters​

message​

BackfillRequest

BackfillRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object