AcknowledgeResult Class

The result of the Acknowledge operation.

Constructor

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

Variables

Name	Description
failed_lock_tokens	list[FailedLockToken] Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). Required.
succeeded_lock_tokens	list[str] Array of lock tokens for the successfully acknowledged cloud events. Required.

Methods

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

as_dict

Return a dict that can be turned into json 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. Default value: False

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	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

popitem

popitem() -> Tuple[str, Any]

setdefault

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

Parameters

Name	Description
key Required
default

update

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

values

values() -> ValuesView[Any]

Attributes

failed_lock_tokens

Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). Required.

failed_lock_tokens: List[_models.FailedLockToken]

succeeded_lock_tokens

Array of lock tokens for the successfully acknowledged cloud events. Required.

succeeded_lock_tokens: List[str]