Skip to content

Commit fed9886

Browse files
authored
Merge pull request #597 from boozallen/596-meta-model-collection-type-doc-update
#596 update metamodel collection type documentation
2 parents 2f7ea82 + 905bfdd commit fed9886

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

docs/modules/ROOT/pages/pipeline-metamodel.adoc

+12-13
Original file line numberDiff line numberDiff line change
@@ -366,10 +366,10 @@ channel from which input should be received.
366366
| `steps/step/inbound/nativeCollectionType` (xref:#_pipeline_step_inbound_native_collection_type_options[details])
367367
| No
368368
| Yes
369-
| If using native as the `inbound` type, `nativeCollectionType` allows the implementation of the collection object being
370-
passed into the step to be customized to any valid xref:type-metamodel.adoc[Type Manager] type. If not
371-
specified, it will default to dataset (which in turn is defaulted to `org.apache.spark.sql.Dataset` for a Spark-based
372-
implementation).
369+
| If using native as the `inbound` type, the name of the `nativeCollectionType` must be defined in the dictionary where
370+
its `simpleType` can be any valid xref:type-metamodel.adoc[Type Manager] type. The Type Manger type will determine the
371+
collection implementation being passed into the step. If not specified, it will default to dataset (which in turn is
372+
defaulted to `org.apache.spark.sql.Dataset` for a Spark-based implementation).
373373
374374
| `steps/step/inbound/recordType` (xref:#_pipeline_step_inbound_record_type_options[details])
375375
| No
@@ -496,12 +496,10 @@ channel to which output should be sent.
496496
| `steps/step/outbound/nativeCollectionType` (xref:#_pipeline_step_outbound_native_collection_type_options[details])
497497
| No
498498
| Yes
499-
| If using native as the `outbound` type, `nativeCollectionType` allows the implementation of the collection object being
500-
returned from the step to be customized to any valid xref:type-metamodel.adoc[Type Manager] type. If
501-
not specified, it will default to dataset (which in turn is defaulted to `org.apache.spark.sql.Dataset` for a
502-
Spark-based implementation).
503-
504-
This has been changed to be defined to a valid dictionary type.
499+
| If using native as the `outbound` type, the name of the `nativeCollectionType` must be defined in the dictionary where
500+
its `simplyType` can be any valid xref:type-metamodel.adoc[Type Manager] type. The Type Manager type will determine
501+
the collection implementation return from the step. If not specified, it will default to dataset (which in turn is
502+
defaulted to `org.apache.spark.sql.Dataset` for a Spark-based implementation).
505503
506504
| `steps/step/outbound/recordType` (xref:_pipeline_step_outbound_record_type_options[details])
507505
| No
@@ -640,9 +638,10 @@ modes] for details on the options.
640638
| `steps/step/persist/collectionType` (xref:_pipeline_step_persist_collection_type_options[details])
641639
| No
642640
| Yes
643-
| Allows the implementation of the collection object being persisted from the step to be customized to
644-
any valid xref:type-metamodel.adoc[Type Manager] type. If not specified, it will default to dataset
645-
(which in turn is defaulted to `org.apache.spark.sql.Dataset` for a Spark-based implementation).
641+
| The name of the `collectionType` must be defined in the dictionary where its `simpleType` can be any valid
642+
xref:type-metamodel.adoc[Type Manager] type, which is also the implementation of the collection object being persisted
643+
from the step to be customized to. If not specified, it will default to dataset (which in turn is defaulted to
644+
`org.apache.spark.sql.Dataset` for a Spark-based implementation).
646645
647646
| `steps/step/persist/recordType` (xref:_pipeline_step_persist_record_type_options[details])
648647
| No

0 commit comments

Comments
 (0)