A data prep recipe.
Properties
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| conversionDetails | RecipeConversionDetailInput[] | The list of conversion details when converting the recipe to R3 that are saved. | Optional | 51.0 |
| dataflowDefinition | String | The recipe's definition. | Optional | 38.0 |
| executionEngine | ConnectRecipeExecutionEngineEnum | The recipe's execution engine. Valid values are:
|
Optional | 41.0 |
| fileContent | String | The recipe's JSON file content (see /wave/recipes/<recipeId>/file for more information). This property is internal to the recipe UI and is available for debugging and reference purposes only. This property is valid only for Data Prep Classic recipes. | Required for POST and PATCH | 38.0 |
| folder | AssetReferenceInput | The Analytics app the recipe is published in. | Required when dataflowDefinition is present | 38.0 |
| format | ConnectRecipeFormatTypeEnum | Specifies the format of the recipe. Valid values are:
|
Required | 48.0 |
| historyLabel | String | A history label to tag the version of the recipe. | Optional | 51.0 |
| label | String | A short label for the recipe. | Optional | 38.0 |
| licenseAttributes | LicensesAttributesInput | The recipe license type and other properties. | Optional | 51.0 |
| publishingTarget | ConnectRecipePublishingTargetEnum | The target format or system to publish the recipe to. Valid values are:
|
Optional | 42.0 |
| recipeDefinition | RecipeDefinitionInput | The recipe definition for the Data Prep recipe only. This property isn’t supported for Data Prep Classic recipes. | Optional | 49.0 |
| rowLevelSecurityPredicate | String | The security predicate of the target dataset. | Optional | 38.0 |
| schedule | String | The recipe's schedule dataflow run. | Optional | 38.0 |
| sourceDataflow | AssetReferenceInput | The source dataflow asset used to upconvert to the recipe to R3. | Optional | 51.0 |