ConnectorEntityField

import type { ConnectorEntityField } from "https://aws-api.deno.dev/v0.4/services/appflow.ts?docs=full";

Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.

interface ConnectorEntityField {

customProperties?: {

[key: string]: string | null | undefined;

} | null;

defaultValue?: string | null;

description?: string | null;

destinationProperties?: DestinationFieldProperties | null;

identifier: string;

isDeprecated?: boolean | null;

isPrimaryKey?: boolean | null;

label?: string | null;

parentIdentifier?: string | null;

sourceProperties?: SourceFieldProperties | null;

supportedFieldTypeDetails?: SupportedFieldTypeDetails | null;

}

§Properties

customProperties?: {

[key: string]: string | null | undefined;

} | null

[src]

A map that has specific properties related to the ConnectorEntityField.

defaultValue?: string | null

[src]

Default value that can be assigned to this field.

description?: string | null

[src]

A description of the connector entity field.

destinationProperties?: DestinationFieldProperties | null

[src]

The properties applied to a field when the connector is being used as a destination.

identifier: string

[src]

The unique identifier of the connector field.

isDeprecated?: boolean | null

[src]

Booelan value that indicates whether this field is deprecated or not.

isPrimaryKey?: boolean | null

[src]

Booelan value that indicates whether this field can be used as a primary key.

label?: string | null

[src]

The label applied to a connector entity field.

parentIdentifier?: string | null

[src]

The parent identifier of the connector field.

sourceProperties?: SourceFieldProperties | null

[src]

The properties that can be applied to a field when the connector is being used as a source.

supportedFieldTypeDetails?: SupportedFieldTypeDetails | null

[src]

Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.