View Source GoogleApi.Connectors.V2.Model.Field (google_api_connectors v0.8.0)

Message contains EntityType's Field metadata.

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.
  • jsonSchema (type: GoogleApi.Connectors.V2.Model.JsonSchema.t, default: nil) - JsonSchema of the field, applicable only if field is of type STRUCT
  • 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.
  • name (type: String.t, default: nil) - Name of the Field.
  • nullable (type: boolean(), default: nil) - Specifies whether a null value is allowed.
  • reference (type: GoogleApi.Connectors.V2.Model.Reference.t, default: nil) - Reference captures the association between two different entity types. Value links to the reference of another entity type.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

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

Functions

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

Unwrap a decoded JSON object into its complex fields.