Alias Class

The alias type.

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

Inheritance
Alias

Constructor

Alias(*, name: typing.Union[str, NoneType] = None, paths: typing.Union[typing.List[_ForwardRef('AliasPath')], NoneType] = None, type: typing.Union[str, _ForwardRef('AliasType'), NoneType] = None, default_path: typing.Union[str, NoneType] = None, default_pattern: typing.Union[_ForwardRef('AliasPattern'), NoneType] = None, **kwargs)

Parameters

name
str
Required

The alias name.

paths
list[AliasPath]
Required

The paths for an alias.

type
str or AliasType
Required

The type of the alias. Possible values include: "NotSpecified", "PlainText", "Mask".

default_path
str
Required

The default path for an alias.

default_pattern
AliasPattern
Required

The default pattern for an alias.

Variables

default_metadata
AliasPathMetadata

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