View Source GoogleApi.Connectors.V1.Model.Field (google_api_connectors v0.11.0)

Metadata of an entity field.

Attributes

additionalDetails (type: map(), default: nil) - The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
dataType (type: String.t, default: nil) - The data type of the Field.
defaultValue (type: any(), default: nil) - The following field specifies the default value of the Field provided by the external system if a value is not provided.
description (type: String.t, default: nil) - A brief description of the Field.
field (type: String.t, default: nil) - Name of the Field.
jsonSchema (type: GoogleApi.Connectors.V1.Model.JsonSchema.t, default: nil) - JsonSchema representation of this entity's schema
key (type: boolean(), default: nil) - The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
nullable (type: boolean(), default: nil) - Specifies whether a null value is allowed.
readonly (type: boolean(), default: nil) - Specifies if the Field is readonly.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Connectors.V1.Model.Field{
  additionalDetails: map() | nil,
  dataType: String.t() | nil,
  defaultValue: any() | nil,
  description: String.t() | nil,
  field: String.t() | nil,
  jsonSchema: GoogleApi.Connectors.V1.Model.JsonSchema.t() | nil,
  key: boolean() | nil,
  nullable: boolean() | nil,
  readonly: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.