GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1TagTemplateField (google_api_data_catalog v0.32.2)

View Source

The template for an individual field within a tag template.

Attributes

  • description (type: String.t, default: nil) - The description for this field. Defaults to an empty string.
  • displayName (type: String.t, default: nil) - The display name for this field. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
  • isRequired (type: boolean(), default: nil) - If true, this field is required. Defaults to false.
  • name (type: String.t, default: nil) - Identifier. The resource name of the tag template field in URL format. Example: projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD} Note: The tag template field itself might not be stored in the location specified in its name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters.
  • order (type: integer(), default: nil) - The order of this field with respect to other fields in this tag template. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order and field orders within a tag don't have to be sequential.
  • type (type: GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1FieldType.t, default: nil) - Required. The type of value this tag field can contain.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1TagTemplateField{
  description: String.t() | nil,
  displayName: String.t() | nil,
  isRequired: boolean() | nil,
  name: String.t() | nil,
  order: integer() | nil,
  type:
    GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1FieldType.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.