Class Annotations (2.4.0)

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. You can include a deprecation message.
display_name str
Optional. Display name for a field.
description str
Optional. Description for a field.
display_order int
Optional. Display order for a field. You can use this to reorder where a field is rendered.
string_type str
Optional. You can use String Type annotations 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. You can use them to suggest values to users through console.