Share via

Alias Class

The alias type.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

Alias(*, name: str | None = None, paths: List[_models.AliasPath] | None = None, type: str | _models.AliasType | None = None, default_path: str | None = None, default_pattern: _models.AliasPattern | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

The alias name.

Default value: None
paths
list[AliasPath]

The paths for an alias.

Default value: None
type
str or AliasType

The type of the alias. Known values are: "NotSpecified", "PlainText", and "Mask".

Default value: None
default_path
str

The default path for an alias.

Default value: None
default_pattern
AliasPattern

The default pattern for an alias.

Default value: None

Variables

Name Description
name
str

The alias name.
paths
list[AliasPath]

The paths for an alias.
type
str or AliasType

The type of the alias. Known values are: "NotSpecified", "PlainText", and "Mask".
default_path
str

The default path for an alias.
default_pattern
AliasPattern

The default pattern for an alias.
default_metadata
AliasPathMetadata

The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata.