View Source GoogleApi.Connectors.V1.Model.JsonSchema (google_api_connectors v0.13.0)

JsonSchema representation of schema metadata

Attributes

  • default (type: any(), default: nil) - The default value of the field or object described by this schema.
  • description (type: String.t, default: nil) - A description of this schema.
  • enum (type: list(any()), default: nil) - Possible values for an enumeration. This works in conjunction with type to represent types with a fixed set of legal values
  • format (type: String.t, default: nil) - Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
  • items (type: GoogleApi.Connectors.V1.Model.JsonSchema.t, default: nil) - Schema that applies to array values, applicable only if this is of type array.
  • jdbcType (type: String.t, default: nil) - JDBC datatype of the field.
  • properties (type: %{optional(String.t) => GoogleApi.Connectors.V1.Model.JsonSchema.t}, default: nil) - The child schemas, applicable only if this is of type object. The key is the name of the property and the value is the json schema that describes that property
  • required (type: list(String.t), default: nil) - Whether this property is required.
  • type (type: list(String.t), default: nil) - JSON Schema Validation: A Vocabulary for Structural Validation of JSON

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.Connectors.V1.Model.JsonSchema{
  default: any() | nil,
  description: String.t() | nil,
  enum: [any()] | nil,
  format: String.t() | nil,
  items: t() | nil,
  jdbcType: String.t() | nil,
  properties: %{optional(String.t()) => t()} | nil,
  required: [String.t()] | nil,
  type: [String.t()] | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.