Class CreateConnectionRequestDataAttributes

Attributes defining the data source connection, including join configuration and custom fields.

Hierarchy

  • CreateConnectionRequestDataAttributes

Constructors

constructor

Properties

additionalProperties? details? fields? joinAttribute joinType metadata? name? type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional details

details?: ListConnectionsResponseDataAttributesConnectionsItemsDetails

Type-specific configuration of the connection. Only the field matching the connection type is set.

Optional fields

fields?: CreateConnectionRequestDataAttributesFieldsItems[]

List of custom attribute fields to import from the data source.

joinAttribute

joinAttribute: string

The attribute in the data source used to join records with the entity.

joinType

joinType: string

The type of join key used to link the data source to the entity (for example, email or user_id).

Optional metadata

metadata?: {
    [key: string]: string;
}

Additional key-value metadata associated with the connection.

Type declaration

  • [key: string]: string

Optional name

name?: string

Display name of the connection.

type

type: string

The type of data source connection (for example, ref_table).

Settings

Member Visibility

Theme

Generated using TypeDoc