QueueLengthExceptionTrigger Class

Trigger for an exception action on exceeding queue length.

All required parameters must be populated in order to send to server.

Inheritance

azure.communication.jobrouter.models._models.ExceptionTrigger

QueueLengthExceptionTrigger

Constructor

QueueLengthExceptionTrigger(*args: Any, **kwargs: Any)

Variables

Name	Description
threshold	int Threshold of number of jobs ahead in the queue to for this trigger to fire. Required.
kind	str or <xref:azure.communication.jobrouter.models.QUEUE_LENGTH> The type discriminator describing a sub-type of ExceptionTrigger. Required. Discriminator value for QueueLengthExceptionTrigger.

Methods

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

copy

copy() -> Model

get

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default Required	Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default Required

popitem

popitem() -> Tuple[str, Any]

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default Required

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Attributes

kind

The type discriminator describing a sub-type of ExceptionTrigger. Required. Discriminator value for QueueLengthExceptionTrigger.

kind: QUEUE_LENGTH: 'queueLength'>]

threshold

Threshold of number of jobs ahead in the queue to for this trigger to fire. Required.

threshold: int