GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField (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.
  • isRequired (type: boolean(), default: nil) - Whether this is a required field. Defaults to false.
  • name (type: String.t, default: nil) - Output only. Identifier. The resource name of the tag template field in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field} Note that this TagTemplateField may not actually be stored in the location in this name.
  • order (type: integer(), default: nil) - The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
  • type (type: GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1FieldType.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.V1beta1.Model.GoogleCloudDatacatalogV1beta1TagTemplateField{
    description: String.t() | nil,
    displayName: String.t() | nil,
    isRequired: boolean() | nil,
    name: String.t() | nil,
    order: integer() | nil,
    type:
      GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1FieldType.t()
      | nil
  }

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.