Číst v angličtině

Sdílet prostřednictvím


RetentionPolicy Třída

Zásady uchovávání informací, které určují, jak dlouho se mají přidružená data uchovávat.

Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.

Dědičnost
azure.storage.queue._generated.models._models_py3.RetentionPolicy
RetentionPolicy

Konstruktor

RetentionPolicy(enabled: bool = False, days: int | None = None)

Parametry

Name Description
enabled

Povinná hodnota. Určuje, jestli je pro službu úložiště povolená zásada uchovávání informací.

výchozí hodnota: False
days
int

Označuje počet dnů, po který se mají metriky, protokolování nebo obnovitelně odstraněná data uchovávat. Všechna data starší než tato hodnota budou odstraněna.

výchozí hodnota: None

Metody

as_dict

Vrátí dikt, který lze serializovat pomocí json.dump.

Rozšířené využití může volitelně použít zpětné volání jako parametr:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

enable_additional_properties_sending
from_dict

Analýza diktu pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).

is_xml_model
serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

as_dict

Vrátí dikt, který lze serializovat pomocí json.dump.

Rozšířené využití může volitelně použít zpětné volání jako parametr:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parametry

Name Description
key_transformer
<xref:function>

Funkce klíčového transformátoru.

keep_readonly
výchozí hodnota: True

Návraty

Typ Description

Objekt kompatibilní s diktem JSON

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parametry

Name Description
data
Vyžadováno
str

Str používající strukturu RestAPI. Ve výchozím nastavení JSON.

content_type
str

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

výchozí hodnota: None

Návraty

Typ Description

Instance tohoto modelu

Výjimky

Typ Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analýza diktu pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parametry

Name Description
data
Vyžadováno

Diktování pomocí struktury RestAPI

content_type
str

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

výchozí hodnota: None
key_extractors
výchozí hodnota: None

Návraty

Typ Description

Instance tohoto modelu

Výjimky

Typ Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parametry

Name Description
keep_readonly

Pokud chcete serializovat atributy readonly

výchozí hodnota: False

Návraty

Typ Description

Objekt kompatibilní s diktem JSON

Atributy

days

Označuje počet dnů, po který se mají metriky, protokolování nebo obnovitelně odstraněná data uchovávat.

days: int | None = None

enabled

Určuje, jestli je pro službu úložiště povolená zásada uchovávání informací.

enabled: bool = False