WaveRecipe

Represents the WaveRecipe type in the Analytics application. A recipe is a saved set of steps to perform on a specific source dataset or connected data. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

Important

File Suffix and Directory Location

WaveRecipe components have the suffix .wdpr and are stored in the wave folder.

Version

WaveRecipe components are available in API version 41.0 and later.

Fields

Field Name	Field Type	Description
dataflow	string	Required. The dataflow ID for the Analytics recipe.
format	string	The format of the current recipe definition. Valid values are: `R2` - recipes created with Data Prep `R3` - recipes created with Data Prep (API version 49.0)
masterLabel	string	Required. The recipe name that appears in the user interface.
securityPredicate	string	A filter condition that defines row-level access to records in a recipe.
targetDatasetAlias	string	The name of the dataset the recipe saves data results into.

Declarative Metadata Sample Definition

The following is an example of a WaveRecipe component.

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide