Optional. Marks a field as deprecated. You can include a deprecation message.
↳ display_name
string
Optional. Display name for a field.
↳ description
string
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
string
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
array
Optional. Suggested hints for string fields. You can use them to suggest values to users through console.
getDeprecated
Optional. Marks a field as deprecated. You can include a deprecation
message.
Returns
Type
Description
string
setDeprecated
Optional. Marks a field as deprecated. You can include a deprecation
message.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
Optional. Display name for a field.
Returns
Type
Description
string
setDisplayName
Optional. Display name for a field.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
Optional. Description for a field.
Returns
Type
Description
string
setDescription
Optional. Description for a field.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayOrder
Optional. Display order for a field. You can use this to reorder where
a field is rendered.
Returns
Type
Description
int
setDisplayOrder
Optional. Display order for a field. You can use this to reorder where
a field is rendered.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getStringType
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.
Returns
Type
Description
string
setStringType
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getStringValues
Optional. Suggested hints for string fields. You can use them to
suggest values to users through console.
[[["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-09-09 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class Annotations (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.AspectType.MetadataTemplate.Annotations)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.AspectType.MetadataTemplate.Annotations)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.AspectType.MetadataTemplate.Annotations)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.AspectType.MetadataTemplate.Annotations)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.AspectType.MetadataTemplate.Annotations)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.AspectType.MetadataTemplate.Annotations)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.AspectType.MetadataTemplate.Annotations)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.AspectType.MetadataTemplate.Annotations)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.AspectType.MetadataTemplate.Annotations)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.AspectType.MetadataTemplate.Annotations)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.AspectType.MetadataTemplate.Annotations)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.AspectType.MetadataTemplate.Annotations)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.AspectType.MetadataTemplate.Annotations)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.AspectType.MetadataTemplate.Annotations)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.AspectType.MetadataTemplate.Annotations) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class Annotations.\n\nDefinition of the annotations of a field.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1 \\\\ AspectType \\\\ MetadataTemplate\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDeprecated\n\nOptional. Marks a field as deprecated. You can include a deprecation\nmessage.\n\n### setDeprecated\n\nOptional. Marks a field as deprecated. You can include a deprecation\nmessage.\n\n### getDisplayName\n\nOptional. Display name for a field.\n\n### setDisplayName\n\nOptional. Display name for a field.\n\n### getDescription\n\nOptional. Description for a field.\n\n### setDescription\n\nOptional. Description for a field.\n\n### getDisplayOrder\n\nOptional. Display order for a field. You can use this to reorder where\na field is rendered.\n\n### setDisplayOrder\n\nOptional. Display order for a field. You can use this to reorder where\na field is rendered.\n\n### getStringType\n\nOptional. You can use String Type annotations to specify special\nmeaning to string fields. The following values are supported:\n\n- richText: The field must be interpreted as a rich text field.\n\n- url: A fully qualified URL link.\n\n- resource: A service qualified resource reference.\n\n### setStringType\n\nOptional. You can use String Type annotations to specify special\nmeaning to string fields. The following values are supported:\n\n- richText: The field must be interpreted as a rich text field.\n\n- url: A fully qualified URL link.\n\n- resource: A service qualified resource reference.\n\n### getStringValues\n\nOptional. Suggested hints for string fields. You can use them to\nsuggest values to users through console.\n\n### setStringValues\n\nOptional. Suggested hints for string fields. You can use them to\nsuggest values to users through console."]]
