Package-level declarations

Types

Link copied to clipboard
sealed interface AirbyteType

Base interface for all Airbyte types in declarative destinations.

Link copied to clipboard
data class ArrayType(val items: FieldType) : AirbyteType
Link copied to clipboard
Link copied to clipboard
data object BooleanType : AirbyteType
Link copied to clipboard
sealed interface CatalogOperation

Base interface for all operation types in declarative destinations.

Link copied to clipboard

Configuration for destination check operations. Performs a HTTP request to the destination API to check if the configuration is valid.

Link copied to clipboard
data object DateType : AirbyteType
Link copied to clipboard
sealed interface DestinationObjects

Base interface for all destination object types in declarative destinations.

Link copied to clipboard
data class DynamicCatalogOperation(val objects: DestinationObjects, val schema: SchemaConfiguration, val schemaRetriever: Retriever? = null, val insertionMethods: List<InsertionMethod>) : CatalogOperation

Configuration for destination discovery operations which use a dynamic schema where operations and schema are derived by accessing the API

Link copied to clipboard
data class DynamicDestinationObjects(val retriever: Retriever, val namePath: List<String>? = null) : DestinationObjects

Configuration for the objects which can be written to by the destination that are determined by making requests to the destination API.

Link copied to clipboard
data class FieldType(val type: AirbyteType, val nullable: Boolean)
Link copied to clipboard
data class InsertionMethod(val type: String = "InsertionMethod", val destinationImportMode: DestinationImportMode, val availabilityPredicate: String, val matchingKeyPredicate: String? = null, val requiredPredicate: String)

Component that defines the details of a specific operation will perform the insertion such as sync mode and field predicates.

Link copied to clipboard
data object IntegerType : AirbyteType
Link copied to clipboard
data object NumberType : AirbyteType
Link copied to clipboard
data class ObjectType(val properties: Map<String, FieldType>, val additionalProperties: Boolean, val required: List<String>? = null) : AirbyteType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class SchemaConfiguration(val type: String = "SchemaConfiguration", val propertiesPath: List<String>, val propertyNamePath: List<String>, val typePath: List<String>, val typeMapping: List<TypesMap>? = null)

Component that represents the configuration for extracting and mapping schema information.

Link copied to clipboard
data class StaticCatalogOperation(val objectName: String, val destinationImportMode: DestinationImportMode, val schema: JsonNode, val matchingKeys: List<List<String>>? = null) : CatalogOperation

Configuration for destination discovery operations which use a static schema where operations and schema are known at compile time.

Link copied to clipboard

Configuration for the objects which can be written to by the destination and are known ahead of time and therefore can be defined statically.

Link copied to clipboard
data object StringType : AirbyteType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class TypesMap(val type: String = "TypesMap", val apiType: List<String>, val airbyteType: List<AirbyteType>)

Represents a mapping between a current type and its corresponding target type.

Link copied to clipboard
data class UnionType(val options: List<AirbyteType>, val isLegacyUnion: Boolean) : AirbyteType
Link copied to clipboard
data class UnknownType(val schema: JsonNode) : AirbyteType