Module Values.ConnectorEntityFieldSource

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.

Sourcetype nonrec t = {
  1. identifier : Identifier.t option;
    (*

    The unique identifier of the connector field.

    *)
  2. parentIdentifier : Identifier.t option;
    (*

    The parent identifier of the connector field.

    *)
  3. label : Label.t option;
    (*

    The label applied to a connector entity field.

    *)
  4. isPrimaryKey : Boolean.t option;
    (*

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

    *)
  5. defaultValue : String_.t option;
    (*

    Default value that can be assigned to this field.

    *)
  6. isDeprecated : Boolean.t option;
    (*

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

    *)
  7. supportedFieldTypeDetails : SupportedFieldTypeDetails.t option;
    (*

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

    *)
  8. description : Description.t option;
    (*

    A description of the connector entity field.

    *)
  9. sourceProperties : SourceFieldProperties.t option;
    (*

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

    *)
  10. destinationProperties : DestinationFieldProperties.t option;
    (*

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

    *)
  11. customProperties : CustomProperties.t option;
    (*

    A map that has specific properties related to the ConnectorEntityField.

    *)
}
Sourceval make : ?identifier:??? -> ?parentIdentifier:??? -> ?label:??? -> ?isPrimaryKey:??? -> ?defaultValue:??? -> ?isDeprecated:??? -> ?supportedFieldTypeDetails:??? -> ?description:??? -> ?sourceProperties:??? -> ?destinationProperties:??? -> ?customProperties:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Map of ([> `String of CustomPropertyKey.t ] * [> `String of CustomPropertyValue.t ]) list | `String of Identifier.t | `Structure of (string * [> `Boolean of Boolean.t | `List of [> `Enum of string ] list | `Structure of (string * [> `List of [> `Enum of string | `String of Value.t ] list | `String of FieldType.t | `Structure of (string * [> `Double of Double.t ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t