Newer Version Available

This content describes an older version of this product. View Latest

Recipe REST API Enums

Enums specific to the /wave/recipes namespace

Enums are not versioned. Enum Values are returned in all API versions. Clients should handle values they don't understand gracefully.

Enum Description
Connect​Analytics​License​Type​Enum The Analytics license types. Valid values are:
  • Cdp (Data 360)
  • Data​Pipeline​Query (Data Pipeline Query)
  • Einstein​Analytics (CRM Analytics)
  • Intelligent​Apps (Intelligent Apps)
  • Mulesoft​Data​Path (Mulesoft Data Works)
  • Sonic (Salesforce Data Pipeline)
Connect​Email​Notification​Level​Enum Valid types of email notification levels you can set. Valid values are:
  • Always
  • Failures
  • Never
  • Warnings
Connect​Recipe​Conversion​Severity​Enum The severity of the conversion detail. Valid values are:
  • UserInfo
  • Warning
Connect​Recipe​Execution​Engine​Enum The recipe's execution engine. Valid values are:
  • V1
  • V2
Connect​Recipe​Format​Type​Enum Returns a collection filtered by the format of the current recipe definition. Valid values are:
  • R2 (Data Prep Classic)
  • R3 (Data Prep)
Connect​Recipe​Publishing​Target​Enum The target format or system to publish the recipe to. Valid values are:
  • Dataset (Publish to Dataset)
Connect​Recipe​Schedule​Type​Enum The schedule type of the recipe. Valid values are:
  • Event​Driven
  • Time​Driven
Connect​Recipe​Status​Enum The status of the recipe. Valid values are:
  • Cancelled
  • Failure
  • New (Never run or has no recent run)
  • Queued
  • Running
  • Success
  • Warning
Connect​Recipe​Validation​Context​Enum The recipe validation context. Valid values are:
  • Default
  • Editor
Connect​Wave​Data​Connector​Type​Enum The type of Analytics connector. The valid values are:
  • Amazon​Athena
  • Amazon​Redshift​Output
  • Amazon​S3
  • Amazon​S3​Output
  • Amazon​S3​Private
  • Aws​Rds​Aurora​My​SQL
  • Aws​Rds​Aurora​Postgres
  • Aws​Rds​Maria​DB
  • Aws​Rds​My​SQL
  • Aws​Rds​Postgres
  • Aws​Rds​Sql​Server
  • Azure​Data​Lake​Gen2​Output
  • Azure​Sql​Database
  • Azure​Sql​Datawarehouse
  • Databricks (Beta)
  • Google​Analytics​4
  • Google​Big​Query
  • Google​Big​Query​Direct
  • Google​Big​Query​Standard​SQL
  • Google​Spanner
  • Heroku​Postgres
  • Hub​Spot
  • MarketoV2
  • Net​Suite
  • Oracle​Eloqua
  • Redshift
  • Redshift​Private
  • Salesforce​External
  • Salesforce​Marketing​Cloud​OAuth2
  • Sap​Hana​Cloud
  • Sfdc​Local
  • Snowflake​Computing
  • Snowflake​Direct
  • Snowflake​Output
  • Snowflake​Private
  • Snowflake​Private​Output
  • Tableau​Online
  • Tableau​Hyper​Output
  • Zendesk
Connection​Mode​Enum The mode for accessing connected datasets. Valid values are:
  • AUTO
  • DIRECT
  • SYNCED
Detect​Sentiment​Output​Type​Enum The output type. Valid values are:
  • Dimension
  • Measure
Input​Run​Mode​Enum The input run mode. Valid values are:
  • Full
  • Incremental
  • Streaming
Measure​Scaling​Type​Enum The scaling type. Valid values are:
  • Min​Max​Scaling
Operation​Enum The operation type for append. Valid values are:
  • Append
  • Delete
  • Upsert
Output​Mode​Enum The output mode. Valid values are:
  • Append
  • Complete
  • Update
Recipe​Aggregate​Node​Enum The aggregate type for the node. Valid values are:
  • Hierarchical
  • Standard
Recipe​Aggregate​Type The recipe aggregation type. Valid values are:
  • Avg
  • Count
  • Maximum
  • Median
  • Minimum
  • StdDev
  • StdDevP
  • Sum
  • Unique
  • Var
  • VarP
Recipe​Bucket​Algorithm​Type The recipe bucket field algorithm type. Valid values are:
  • Typographic​Clustering
Recipe​Bucket​Grain The recipe bucket date grain type. Valid values are:
  • Absolute​Date
  • Days
  • Fiscal​Quarters
  • Fiscal​Years
  • Months
  • Quarters
  • Weeks
  • Years
Recipe​Configuration​Fiscal​Offset​Year​Based​On​Enum The recipe configuration fiscal offset year based on type. Valid values are:
  • End
  • Start
Recipe​Configuration​Fiscal​Type​Enum The recipe configuration fiscal type. Valid values are:
  • Offset
Recipe​D360​Output​Type The output type. Valid values are:
  • Date​Lake​Object
Recipe​Data​Cloud​Output​Type​Enum The output type. Valid values are:
  • Date​Lake​Object
Recipe​Data​Type The recipe data type. Valid values are:
  • Date​Only
  • Date​Time
  • Multivalue
  • Number
  • Text
Recipe​Date​Grain The extract grain type. Valid values are:
  • Day
  • Day​Epoch
  • Fiscal​Month
  • Fiscal​Quarter
  • Fiscal​Week
  • Fiscal​Year
  • Hour
  • Minute
  • Month
  • Quarter
  • Second
  • Second​Epoch
  • Week
  • Year
Recipe​Dataset​Type The type of the dataset. Valid values are:
  • Analytics
  • Connected
  • Data​Lake​Object
  • Data​Model​Object
Recipe​Export​Csv​Header​Row​Value​Type The type of the recipe export CSV header row value. Valid values are:
  • Fully​Qualified​Name
  • Label
Recipe​Export​Format The format of the export. Valid values are:
  • CSV.
Recipe​Formula​Expression​Type The formula expression type. Valid values are:
  • Legacy
  • Sql
Recipe​Group​Dates​By The value to group dates by. Valid values are:
  • Year
  • Year​Month
  • Year​Month​Day
  • Year​Quarter
  • Year​Week
Recipe​Group​Dates​By​V2 The value to group dates by. Valid values are:
  • Fiscal​Year
  • Fiscal​Year​Month
  • Fiscal​Year​Quarter
  • Fiscal​Year​Week
  • Year​Month
  • Year​Month​Day
  • Year​Quarter
  • Year​Week
Recipe​Join​Type The join type. Valid values are:
  • Cross
  • Inner
  • Left​Outer
  • Lookup
  • Multi​Value​Lookup
  • Outer
  • Right​Outer
Recipe​Node​Action The recipe node action. Valid recipe actions are:
  • Aggregate
  • Append
  • Append_V2
  • Bucket
  • Bucket V2
  • Clustering
  • Compute​Relative
  • Date​Format​Conversion
  • Detect​Sentiment
  • Discovery​Predict
  • Export
  • Extension
  • Extract
  • Filter
  • Flatten
  • Formula
  • Join
  • Load
  • Optimized​Append​Output
  • Optimized​Update​Output
  • Output​D360
  • Output​External
  • Predict​Missing​Values
  • Recommendation
  • Save
  • Schema
  • Split
  • Sql​Filter
  • Time​Series
  • Time​Series​V2
  • Type​Cast
  • Updatei
  • Update​Data​Cloud​Object
  • Write​Data​Cloud​Object
Recipe​Output​External​Operation The output external operation type. Valid values are:
  • Empty
  • Insert
  • Update
  • Upsert
Recipe​Run​Mode The recipe run mode. Valid values are:
  • Full
  • Incremental
  • Streaming
Recipe​Slice​Mode The slice mode. Valid values are:
  • SELECT
  • DROP
Recipe​Sort​Order​Enum The recipe sort order. Valid values are:
  • Ascending
  • Descending
Recipe​Time​Series​Confidence​Interval​Type The confidence interval. Valid values are:
  • Eighty
  • Ninety​Five
  • None
Recipe​Time​Series​Model The time series model. Valid values are:
  • Additive
  • Auto
  • Multiplicative
Sample​Type The recipe sample type. Valid values are:
  • Custom
  • Random
  • Top​N
  • Unique
Sentiment​Score​Type​Enum The sentiment score type. Valid values are:
  • All
  • None
Time​Series​V2​Forecast​Algorithm​Enum The forecast algorithm. Valid values are:
  • Holt​Winters
Time​Series​V2​Forecast​Length​Type​Enum The forecast length type. Valid values are:
  • Rolling
Time​Series​V2​Partial​Data​Handling​Enum The partial data handling value. Valid values are:
  • Ignore​Last
  • None
Trigger​Type​Enum The trigger type. Valid values are:
  • Fixed
Property Name Enum Description Required or Optional Available Version
sort Connect​Wave​Sort​Order​Type​Enum The type of sort order to be applied to the returned collection. Valid values are:
  • App
  • Created​By
  • Created​By​Id
  • Created​Date
  • Folder​Name
  • Last​Modified
  • Last​Modified​By
  • Last​Modified​By​Id
  • Last​Modified​Date
  • Location
  • Mru (Most Recently Used, last viewed date)
  • Name
  • Outcome
  • Refresh​Date (for assets like datasets)
  • Run​Date (for assets like reports)
  • Status
  • Title
  • Type
Optional 38.0