GoogleApi.Dataplex.V1.Model.GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations (google_api_dataplex v0.21.0)

Definition of the annotations of a field.

Attributes

deprecated (type: String.t, default: nil) - Optional. Marks a field as deprecated. You can include a deprecation message.
description (type: String.t, default: nil) - Optional. Description for a field.
displayName (type: String.t, default: nil) - Optional. Display name for a field.
displayOrder (type: integer(), default: nil) - Optional. Display order for a field. You can use this to reorder where a field is rendered.
stringType (type: String.t, default: nil) - 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.
stringValues (type: list(String.t), default: nil) - Optional. Suggested hints for string fields. You can use them to suggest values to users through console.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@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

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.