Send feedback
Class Annotations (2.11.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
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.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Class Annotations (2.11.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.11.0 (latest)](/python/docs/reference/dataplex/latest/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.10.2](/python/docs/reference/dataplex/2.10.2/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.9.0](/python/docs/reference/dataplex/2.9.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.8.0](/python/docs/reference/dataplex/2.8.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.7.1](/python/docs/reference/dataplex/2.7.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.6.0](/python/docs/reference/dataplex/2.6.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.5.0](/python/docs/reference/dataplex/2.5.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.4.0](/python/docs/reference/dataplex/2.4.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.3.1](/python/docs/reference/dataplex/2.3.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.2.2](/python/docs/reference/dataplex/2.2.2/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.1.0](/python/docs/reference/dataplex/2.1.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [2.0.1](/python/docs/reference/dataplex/2.0.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.13.0](/python/docs/reference/dataplex/1.13.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.12.3](/python/docs/reference/dataplex/1.12.3/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.11.0](/python/docs/reference/dataplex/1.11.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.10.0](/python/docs/reference/dataplex/1.10.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.9.0](/python/docs/reference/dataplex/1.9.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.8.1](/python/docs/reference/dataplex/1.8.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.7.0](/python/docs/reference/dataplex/1.7.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.6.2](/python/docs/reference/dataplex/1.6.2/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.5.1](/python/docs/reference/dataplex/1.5.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.4.3](/python/docs/reference/dataplex/1.4.3/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.3.0](/python/docs/reference/dataplex/1.3.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.2.0](/python/docs/reference/dataplex/1.2.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.1.3](/python/docs/reference/dataplex/1.1.3/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [1.0.1](/python/docs/reference/dataplex/1.0.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [0.2.1](/python/docs/reference/dataplex/0.2.1/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations)\n- [0.1.0](/python/docs/reference/dataplex/0.1.0/google.cloud.dataplex_v1.types.AspectType.MetadataTemplate.Annotations) \n\n Annotations(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nDefinition of the annotations of a field."]]