Cloud Dataplex v1 API - Class AspectType.Types.MetadataTemplate.Types.Annotations (3.3.0)

public sealed class AspectType.Types.MetadataTemplate.Types.Annotations : IMessage<AspectType.Types.MetadataTemplate.Types.Annotations>, IEquatable<AspectType.Types.MetadataTemplate.Types.Annotations>, IDeepCloneable<AspectType.Types.MetadataTemplate.Types.Annotations>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class AspectType.Types.MetadataTemplate.Types.Annotations.

Definition of the annotations of a field

Inheritance

object > AspectType.Types.MetadataTemplate.Types.Annotations

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

Annotations()

public Annotations()

Annotations(Annotations)

public Annotations(AspectType.Types.MetadataTemplate.Types.Annotations other)
Parameter
Name Description
other AspectTypeTypesMetadataTemplateTypesAnnotations

Properties

Deprecated

public string Deprecated { get; set; }

Optional. Marks a field as deprecated, a deprecation message can be included.

Property Value
Type Description
string

Description

public string Description { get; set; }

Optional. Specify a description for a field

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Optional. Specify a displayname for a field.

Property Value
Type Description
string

DisplayOrder

public int DisplayOrder { get; set; }

Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered

Property Value
Type Description
int

StringType

public string StringType { get; set; }

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.

Property Value
Type Description
string

StringValues

public RepeatedField<string> StringValues { get; }

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

Property Value
Type Description
RepeatedFieldstring