Skip to main content

Class: AutoscalingPollerBehavior

v1.WorkerConfig.AutoscalingPollerBehavior

Represents an AutoscalingPollerBehavior.

Implements

Constructors

constructor

new AutoscalingPollerBehavior(properties?): AutoscalingPollerBehavior

Constructs a new AutoscalingPollerBehavior.

Parameters

NameTypeDescription
properties?IAutoscalingPollerBehaviorProperties to set

Returns

AutoscalingPollerBehavior

Properties

initialPollers

initialPollers: number

This many polls will be attempted initially before scaling kicks in. Must be between minimum and maximum.

Implementation of

IAutoscalingPollerBehavior.initialPollers


maxPollers

maxPollers: number

At most this many poll calls will ever be open at once. Must be >= minimum.

Implementation of

IAutoscalingPollerBehavior.maxPollers


minPollers

minPollers: number

At least this many poll calls will always be attempted (assuming slots are available). Cannot be zero.

Implementation of

IAutoscalingPollerBehavior.minPollers

Methods

toJSON

toJSON(): Object

Converts this AutoscalingPollerBehavior to JSON.

Returns

Object

JSON object


create

create(properties?): AutoscalingPollerBehavior

Creates a new AutoscalingPollerBehavior instance using the specified properties.

Parameters

NameTypeDescription
properties?IAutoscalingPollerBehaviorProperties to set

Returns

AutoscalingPollerBehavior

AutoscalingPollerBehavior instance


decode

decode(reader, length?): AutoscalingPollerBehavior

Decodes an AutoscalingPollerBehavior message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

AutoscalingPollerBehavior

AutoscalingPollerBehavior

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): AutoscalingPollerBehavior

Decodes an AutoscalingPollerBehavior message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

AutoscalingPollerBehavior

AutoscalingPollerBehavior

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 AutoscalingPollerBehavior message. Does not implicitly temporal.api.sdk.v1.WorkerConfig.AutoscalingPollerBehavior.verify|verify messages.

Parameters

NameTypeDescription
messageIAutoscalingPollerBehaviorAutoscalingPollerBehavior message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified AutoscalingPollerBehavior message, length delimited. Does not implicitly temporal.api.sdk.v1.WorkerConfig.AutoscalingPollerBehavior.verify|verify messages.

Parameters

NameTypeDescription
messageIAutoscalingPollerBehaviorAutoscalingPollerBehavior message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): AutoscalingPollerBehavior

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

AutoscalingPollerBehavior

AutoscalingPollerBehavior


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for AutoscalingPollerBehavior

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageAutoscalingPollerBehaviorAutoscalingPollerBehavior
options?IConversionOptionsConversion options

Returns

Object

Plain object