Class Annotations (2.3.1)

Annotations(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Definition of the annotations of a field

Attributes

Name Description
deprecated str
Optional. Marks a field as deprecated, a deprecation message can be included.
display_name str
Optional. Specify a displayname for a field.
description str
Optional. Specify a description for a field
display_order int
Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered
string_type str
Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.
string_values MutableSequence[str]
Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.