View Source GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations (google_api_dataplex v0.10.0)

Definition of the annotations of a field

Attributes

  • deprecated (type: String.t, default: nil) - Optional. Marks a field as deprecated, a deprecation message can be included.
  • description (type: String.t, default: nil) - Optional. Specify a description for a field
  • displayName (type: String.t, default: nil) - Optional. Specify a displayname for a field.
  • displayOrder (type: integer(), default: nil) - Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered
  • stringType (type: String.t, default: nil) - 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.
  • stringValues (type: list(String.t), default: nil) - Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations{
    deprecated: String.t() | nil,
    description: String.t() | nil,
    displayName: String.t() | nil,
    displayOrder: integer() | nil,
    stringType: String.t() | nil,
    stringValues: [String.t()] | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.