Configuration

public struct Configuration : Codable, Equatable

A custom configuration for the environment.

  • The unique identifier of the configuration.

    Declaration

    Swift

    public var configurationID: String?

  • The name of the configuration.

    Declaration

    Swift

    public var name: String

  • The creation date of the configuration in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

    Declaration

    Swift

    public var created: Date?

  • The timestamp of when the configuration was last updated in the format yyyy-MM-dd’T'HH:mm:ss.SSS'Z’.

    Declaration

    Swift

    public var updated: Date?

  • The description of the configuration, if available.

    Declaration

    Swift

    public var description: String?

  • Document conversion settings.

    Declaration

    Swift

    public var conversions: Conversions?

  • An array of document enrichment settings for the configuration.

    Declaration

    Swift

    public var enrichments: [Enrichment]?

  • Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.

    Declaration

    Swift

    public var normalizations: [NormalizationOperation]?

  • Object containing source parameters for the configuration.

    Declaration

    Swift

    public var source: Source?

  • Initialize a Configuration with member variables.

    Declaration

    Swift

    public init(
    name: String,
    description: String? = nil,
    conversions: Conversions? = nil,
    enrichments: [Enrichment]? = nil,
    normalizations: [NormalizationOperation]? = nil,
    source: Source? = nil
)

    Parameters

    name

    The name of the configuration.
    description

    The description of the configuration, if available.
    conversions

    Document conversion settings.
    enrichments

    An array of document enrichment settings for the configuration.
    normalizations

    Defines operations that can be used to transform the final output JSON into a normalized form. Operations are executed in the order that they appear in the array.
    source

    Object containing source parameters for the configuration.

    Return Value

    An initialized Configuration.