-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Nishu Goel
committed
Mar 18, 2024
1 parent
ca577b7
commit fea0058
Showing
45 changed files
with
1,596 additions
and
266 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,240 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "epilot-entitymapping_entity_mapping Data Source - terraform-provider-epilot-entitymapping" | ||
| subcategory: "" | ||
| description: |- | ||
| EntityMapping DataSource | ||
| --- | ||
|
|
||
| # epilot-entitymapping_entity_mapping (Data Source) | ||
|
|
||
| EntityMapping DataSource | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| data "epilot-entitymapping_entity_mapping" "my_entitymapping" { | ||
| id = "70542580-2b38-4bfc-af8d-bb90102f9f47" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `id` (String) Mapping Config Id | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `source` (Attributes) (see [below for nested schema](#nestedatt--source)) | ||
| - `targets` (Attributes List) (see [below for nested schema](#nestedatt--targets)) | ||
|
|
||
| <a id="nestedatt--source"></a> | ||
| ### Nested Schema for `source` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `config` (Attributes) (see [below for nested schema](#nestedatt--source--config)) | ||
| - `type` (String) must be one of ["journey", "entity"] | ||
|
|
||
| <a id="nestedatt--source--config"></a> | ||
| ### Nested Schema for `source.config` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `entity_ref` (Attributes) (see [below for nested schema](#nestedatt--source--config--entity_ref)) | ||
| - `journey_ref` (Attributes) (see [below for nested schema](#nestedatt--source--config--journey_ref)) | ||
|
|
||
| <a id="nestedatt--source--config--entity_ref"></a> | ||
| ### Nested Schema for `source.config.entity_ref` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `entity_id` (String) id of the source entity to be mapped | ||
| - `entity_schema` (String) schema of the source entity | ||
|
|
||
|
|
||
| <a id="nestedatt--source--config--journey_ref"></a> | ||
| ### Nested Schema for `source.config.journey_ref` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `journey_id` (String) | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--targets"></a> | ||
| ### Nested Schema for `targets` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `allow_failure` (Boolean) Pass it as true, when you don't want failures to interrupt the mapping process. | ||
| - `condition_mode` (String) Parsed as JSON. | ||
| - `conditions` (String) Parsed as JSON. | ||
| - `id` (String) Identifier for target configuration. Useful for later usages when trying to identify which target config to map to. | ||
| - `linkback_relation_attribute` (String) Relation attribute on the main entity where the target entity will be linked. Set to false to disable linkback | ||
|
|
||
| Default: "mapped_entities" | ||
| - `linkback_relation_tags` (List of String) Relation tags (labels) to include in main entity linkback relation attribute | ||
| - `mapping_attributes` (Attributes List) Attribute mappings (see [below for nested schema](#nestedatt--targets--mapping_attributes)) | ||
| - `name` (String) A name for this configuration | ||
| - `relation_attributes` (Attributes List) Relation mappings (see [below for nested schema](#nestedatt--targets--relation_attributes)) | ||
| - `target_schema` (String) Schema of target entity | ||
| - `target_unique` (List of String) Unique key for target entity (see upsertEntity of Entity API) | ||
|
|
||
| <a id="nestedatt--targets--mapping_attributes"></a> | ||
| ### Nested Schema for `targets.mapping_attributes` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `mapping_attribute` (Attributes) (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute)) | ||
| - `mapping_attribute_v2` (Attributes) (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute_v2)) | ||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `append_value_mapper` (Attributes) (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute--append_value_mapper)) | ||
| - `copy_value_mapper` (Attributes) (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute--copy_value_mapper)) | ||
| - `set_value_mapper` (Attributes) (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute--set_value_mapper)) | ||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute--append_value_mapper"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute.set_value_mapper` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `mode` (String) - copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used together with value property. | ||
|
|
||
| must be one of ["copy_if_exists", "append_if_exists", "set_value"] | ||
| - `source` (String) JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price | ||
| - `target` (String) JSON like target path for the attribute. Eg. last_name | ||
| - `target_unique` (List of String) Array of keys which should be used when checking for uniqueness. Eg: [country, city, postal_code] | ||
| - `value_json` (String) To be provided only when mapping json objects into a target attribute. Eg array of addresses. | ||
|
|
||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute--copy_value_mapper"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute.set_value_mapper` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `mode` (String) - copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used together with value property. | ||
|
|
||
| must be one of ["copy_if_exists", "append_if_exists", "set_value"] | ||
| - `source` (String) JSON source path for the value to be extracted from the main entity. Eg: steps[1].['Product Info'].price | ||
| - `target` (String) JSON like target path for the attribute. Eg. last_name | ||
|
|
||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute--set_value_mapper"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute.set_value_mapper` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `mode` (String) - copy_if_exists - it replaces the target attribute with the source value - append_if_exists - it currently replaces target attribute with array like values. Useful when you have multiple values to be added into one attribute. - set_value - it sets a value to a predefined value. Must be used together with value property. | ||
|
|
||
| must be one of ["copy_if_exists", "append_if_exists", "set_value"] | ||
| - `target` (String) JSON like target path for the attribute. Eg. last_name | ||
| - `value` (String) Any value to be set: string, number, string[], number[], JSON object, etc. It will override existing values, if any. | ||
|
|
||
| Parsed as JSON. | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute_v2"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute_v2` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `operation` (Attributes) Mapping operation nodes are either primitive values or operation node objects (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute_v2--operation)) | ||
| - `origin` (String) Origin of an attribute. must be one of ["system_recommendation", "user_manually"] | ||
| - `target` (String) Target JSON path for the attribute to set | ||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute_v2--operation"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute_v2.target` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `any` (String) Parsed as JSON. | ||
| - `operation_object_node` (Attributes) (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node)) | ||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute_v2.target.operation_object_node` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `additional_properties` (String) Parsed as JSON. | ||
| - `append` (List of String) Append to array | ||
| - `copy` (String) Copy JSONPath value from source entity context | ||
| - `random` (Attributes) (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node--random)) | ||
| - `set` (String) Parsed as JSON. | ||
| - `template` (String) Define handlebars template to output a string | ||
| - `uniq` (Attributes) Unique array (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node--uniq)) | ||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node--random"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute_v2.target.operation_object_node.uniq` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `one` (Attributes) (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node--uniq--one)) | ||
| - `two` (Attributes) (see [below for nested schema](#nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node--uniq--two)) | ||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node--uniq--one"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute_v2.target.operation_object_node.uniq.two` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `type` (String) must be one of ["uuid", "nanoid"] | ||
|
|
||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node--uniq--two"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute_v2.target.operation_object_node.uniq.two` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `max` (Number) Default: 1 | ||
| - `min` (Number) Default: 0 | ||
| - `type` (String) must be one of ["number"] | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--targets--mapping_attributes--mapping_attribute_v2--target--operation_object_node--uniq"></a> | ||
| ### Nested Schema for `targets.mapping_attributes.mapping_attribute_v2.target.operation_object_node.uniq` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `array_ofstr` (List of String) | ||
| - `boolean` (Boolean) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--targets--relation_attributes"></a> | ||
| ### Nested Schema for `targets.relation_attributes` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `mode` (String) must be one of ["append", "prepend", "set"] | ||
| - `origin` (String) Origin of an attribute. must be one of ["system_recommendation", "user_manually"] | ||
| - `related_to` (Map of String) | ||
| - `source_filter` (Attributes) A filter to identify which source entities to pick as relations from main entity (see [below for nested schema](#nestedatt--targets--relation_attributes--source_filter)) | ||
| - `target` (String) Target attribute to store the relation in | ||
| - `target_tags` (List of String) Relation tags (labels) to set for the stored relations | ||
| - `target_tags_include_source` (Boolean) Include all relation tags (labels) present on the main entity relation. Default: false | ||
|
|
||
| <a id="nestedatt--targets--relation_attributes--source_filter"></a> | ||
| ### Nested Schema for `targets.relation_attributes.source_filter` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `attribute` (String) Filter by a specific relation attribute on the main entity | ||
| - `limit` (Number) Limit relations to maximum number (default, all matched relations) | ||
| - `relation_tag` (String) Filter by relation tag (label) on the main entity | ||
| - `schema` (String) Filter by specific schema | ||
| - `self` (Boolean) Picks main entity as relation (overrides other filters). Default: false | ||
| - `tag` (String) Filter by a specific tag on the related entity | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
examples/data-sources/epilot-entitymapping_entity_mapping/data-source.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| data "epilot-entitymapping_entity_mapping" "my_entitymapping" { | ||
| id = "70542580-2b38-4bfc-af8d-bb90102f9f47" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.