Newer Version Available
Recipe Node Representation
- RecipeNodeRepresentation
-
- AggregateNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters AggregateParametersRepresentation The parameters for the node. Small, v51.0 51.0 - AggregateParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version aggregations AggregateRepresentation[] The list of aggregations for the node. Small, v51.0 51.0 groupings String[] The list of groupings for the node. Small, v51.0 51.0 pivots PivotRepresentation[] The list of pivots for the node. Small, v51.0 51.0 - AggregateRepresentation
-
Property Name Type Description Filter Group and Version Available Version action RecipeAggregateType The recipe aggregation type. Valid values are: - Avg
- Count
- Maximum
- Median
- Minimum
- StdDev
- StdDevP
- Sum
- Unique
- Var
- VarP
Small, v51.0 51.0 label String The label for the aggregate. Small, v51.0 51.0 name String The name for the aggregate. Small, v51.0 51.0 source String The source for the aggregate. Small, v51.0 51.0 - PivotRepresentation
-
Property Name Type Description Filter Group and Version Available Version source String The source for the pivot. Small, v51.0 51.0 values String[] The list of values for the pivot. Small, v51.0 51.0 - AppendNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters AppendParametersRepresentation The parameters for the node. Small, v51.0 49.0-50.0 - AppendV2NodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters AppendParametersRepresentation The parameters for the node. Small, v51.0 51.0 - AppendParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version fieldMappings AppendMappingRepresentation[] The list of mappings for the node. Small, v51.0 51.0 - AppendMappingRepresentation
-
Property Name Type Description Filter Group and Version Available Version bottom String The bottom dataset field. Small, v51.0 51.0 top String The top dataset field. Small, v51.0 51.0 - BucketNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters BucketParametersRepresentation The parameters for the bucket node. Small, v51.0 51.0 - BucketParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version fields BucketFieldRepresentation[] The list of parameter fields. Small, v51.0 51.0 - BucketFieldRepresentation
-
Property Name Type Description Filter Group and Version Available Version bucketsSetup BucketSetupRepresentation The bucket field property label. Small, v51.0 51.0 label String The bucket field property label. Small, v51.0 51.0 name String The bucket field property name. Small, v51.0 51.0 type RecipeDataType The data type to convert to. Valid values are: - DateOnly Type
- DateTime Type
- Number Type
- Text Type
Small, v51.0 51.0 - BucketSetupRepresentation
-
Property Name Type Description Filter Group and Version Available Version buckets BucketRepresentation The buckets. Valid values are: Small, v51.0 51.0 defaultBucketValue String The default bucket value. Small, v51.0 51.0 isPassThroughEnabled Boolean Indicates whether pass through is enabled or not. Small, v51.0 51.0 nullBucketValue String The null bucket value Small, v51.0 51.0 sourceField BucketSourceFieldRepresentation The bucket source fields. Small, v51.0 51.0 - BucketDateBucketRepresentation
-
BucketDateBucketRepresentation inherits properties from the abstract BucketRepresentation. These base properties appear alongside BucketDateBucketRepresentation specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version rangeEnd BucketDateArgumentRepresentation The date range end. Small, v51.0 51.0 rangeStart BucketDateArgumentRepresentation The date range start. Small, v51.0 51.0 - BucketDimensionBucketRepresentation
-
BucketDimensionBucketRepresentation inherits properties from the abstract BucketRepresentation. These base properties appear alongside BucketDimensionBucketRepresentation specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version sourceValues String[] The list of source values Small, v51.0 51.0 - BucketMeasureBucketRepresentation
-
BucketMeasureBucketRepresentation inherits properties from the abstract BucketRepresentation. These base properties appear alongside BucketMeasureBucketRepresentation specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version rangeEnd Double The range end. Small, v51.0 51.0 rangeStart Double The range start. Small, v51.0 51.0 - BucketRepresentation
-
Property Name Type Description Filter Group and Version Available Version value String The bucket value. Small, v51.0 51.0 - BucketSourceFieldRepresentation
-
Property Name Type Description Filter Group and Version Available Version name String The bucket source field name. Small, v51.0 51.0 type RecipeDataType The data type to convert to. Valid values are: - DateOnly Type
- DateTime Type
- Number Type
- Text Type
Small, v51.0 51.0 - BucketDateArgumentRepresentation
-
Property Name Type Description Filter Group and Version Available Version argument Long The date argument. Small, v51.0 51.0 type RecipeBucketGrain Small, v51.0 51.0 - ClusterNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters ClusterParametersRepresentation The parameters for the node. Small, v51.0 51.0 - ClusterParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version clusterCount Integer The cluster count. Small, v51.0 51.0 sourceFields String[] The source fields. Small, v51.0 51.0 targetField RecipeNameLabelRepresentation The target field. Small, v51.0 51.0 - RecipeNameLabelRepresentation
-
Property Name Type Description Filter Group and Version Available Version label String The label. Small, v51.0 51.0 name String The name. Small, v51.0 51.0 - ComputeRelativeNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters ComputeRelativeParametersRepresentation The parameters for the node. Small, v51.0 51.0 - ComputeRelativeParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version expressionType RecipeFormulaExpressionType The formula expression type. Valid values are: - Legacy
- Sql
Small, v51.0 51.0 fields SqlFormulaFieldRepresentation[] The list of formula fields. Small, v51.0 51.0 orderBy ComputeRelativeSortParametersRepresentation[] The list of sort fields. Small, v51.0 51.0 partitionBy String[] The list of partition by values. Small, v51.0 51.0 - ComputeRelativeSortParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version direction RecipeSortOrderEnum The sort direction. Valid values are: - Ascending
- Descending
Small, v51.0 51.0 fieldName String The field name. Small, v51.0 51.0 - SqlFormulaFieldRepresentation
-
Property Name Type Description Filter Group and Version Available Version formulaExpression String The formula expression Small, v51.0 51.0 label String The formula label. Small, v51.0 51.0 name String The formula name. Small, v51.0 51.0 type RecipeDataType The data type to convert to. Valid values are: - DateOnly Type
- DateTime Type
- Number Type
- Text Type
Small, v51.0 51.0 - FormatDateNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters FormatDateParametersRepresentation The parameters for the node. Small, v51.0 51.0 - FormatDateParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version sourceField String The source field. Small, v51.0 51.0 sourceFormats FormatDatePatternRepresentation[] The list of source date formats. Small, v51.0 51.0 targetField RecipeNameLabelRepresentation The target field. Small, v51.0 51.0 targetFormat FormatDatePatternRepresentation The target date format. Small, v51.0 51.0 - FormatDatePatternRepresentation
-
Property Name Type Description Filter Group and Version Available Version construction String The construction for the date format. Small, v51.0 51.0 groups String[] The list of date format groups. Small, v51.0 51.0 regex String The regular expression for the date format. Small, v51.0 51.0 - DetectSentimentNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters DetectSentimentParametersRepresentation The parameters for the node. Small, v51.0 51.0 - DetectSentimentParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version sourceField String The source field. Small, v51.0 51.0 targetField RecipeNameLabelRepresentation The target field. Small, v51.0 51.0 - DiscoveryNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters DiscoveryParametersRepresentation The parameters for the node. Small, v51.0 51.0 - DiscoveryParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version columnMapping Map<String, String> The map of column mappings. Small, v51.0 51.0 predictSource DiscoverySourceRepresentation The prediction source. Small, v51.0 51.0 predictionFactorFields DiscoveryContributorRepresentation[] The list of prediction factor fields. Small, v51.0 51.0 predictionField RecipeNameLabelRepresentation The prediction field. Small, v51.0 51.0 prescriptionFields DiscoveryContributorRepresentation[] The list of prescription fields. Small, v51.0 51.0 - DiscoveryContributorRepresentation
-
Property Name Type Description Filter Group and Version Available Version field RecipeNameLabelRepresentation The discovery field. Small, v51.0 51.0 impact RecipeNameLabelRepresentation The discovery impact. Small, v51.0 51.0 - DiscoverySourceRepresentation
-
Property Name Type Description Filter Group and Version Available Version name String The source name. Small, v51.0 51.0 type String The source type. Small, v51.0 51.0 - RecipeTypeNameRepresentation
-
Property Name Type Description Filter Group and Version Available Version name String The label. Small, v51.0 51.0 type String The type. Small, v51.0 51.0 - ExportNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters ExportParametersRepresentation The parameters for the node. Small, v51.0 51.0 - ExportParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version fields String[] The list of fields to select. Small, v51.0 51.0 format RecipeExportFormat The format of the export. The valid value is CSV. Small, v51.0 51.0 limitsPerPart ExportLimitsRepresentation The limits to export. Small, v51.0 51.0 userId String The user ID with access to the exported data. Small, v51.0 51.0 - ExportLimitsRepresentation
-
Property Name Type Description Filter Group and Version Available Version maxFileSizeInBytes Integer The maximum file size for the export partition. Small, v51.0 51.0 maxRowCount Integer The maximum row count for the export partition. Small, v51.0 51.0 - ExtractNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters ExtractParametersRepresentation The parameters for the node. Small, v51.0 51.0 - ExtractParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version grainExtractions ExtractParameterRepresentation[] The date fields to extract grains for. Small, v51.0 51.0 - ExtractParameterRepresentation
-
Property Name Type Description Filter Group and Version Available Version source String The source field. Small, v51.0 51.0 targets ExtractFieldRepresentation[] The list of grain fields. Small, v51.0 51.0 - ExtractFieldRepresentation
-
Property Name Type Description Filter Group and Version Available Version grainType RecipeDateGrain The extract grain type. Valid values are: - Day
- DayEpoch
- FiscalMonth
- FiscalQuarter
- FiscalWeek
- FiscalYear
- Hour
- Minute
- Month
- Quarter
- Second
- SecondEpoch
- Week
- Year
Small, v51.0 51.0 label String The extract field label. Small, v51.0 51.0 name String The extract field name. Small, v51.0 51.0 - FilterNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters FilterParametersRepresentation The parameters for the node. Small, v51.0 51.0 - FilterParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version grainExtractions FilterExpressionRepresentation[] The list of filter expressions. Small, v51.0 51.0 - FilterExpressionRepresentation
-
Property Name Type Description Filter Group and Version Available Version field String The field to filter on. Small, v51.0 51.0 operands String[] The list of operands. Small, v51.0 51.0 operator String The operator to use for the filter. Small, v51.0 51.0 type RecipeDataType The data type to convert to. Valid values are: - DateOnly Type
- DateTime Type
- Number Type
- Text Type
Small, v51.0 51.0 - FlattenNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters FlattenParametersRepresentation The parameters for the node. Small, v51.0 51.0 - FlattenParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version includeSelfId Boolean Indicates whether to include the self-ID or not. Small, v51.0 51.0 multiField FlattenFieldRepresentation The multi field. Small, v51.0 51.0 parentField String The parent field. Small, v51.0 51.0 pathField FlattenFieldRepresentation The path field. Small, v51.0 51.0 selfField String The self-field. Small, v51.0 51.0 - FilterFieldRepresentation
-
Property Name Type Description Filter Group and Version Available Version isSystemField Boolean Indicates whether the field is a system field or not. Small, v51.0 51.0 label String The field label. Small, v51.0 51.0 name String The field name. Small, v51.0 51.0 - FormulaNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters FormulaParametersRepresentation The parameters for the node. Small, v51.0 51.0 - FormulaParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version expressionType RecipeFormulaExpressionType The formula expression type. Valid values are: - Legacy
- Sql
Small, v51.0 51.0 - JoinNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters JoinParametersRepresentation The parameters for the node. Small, v51.0 51.0 - JoinParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version joinType RecipeJoinType The join type. Valid values are: - Inner
- LeftOuter
- Lookup
- MultiValueLookup
- Outer
- RightOuter
Small, v51.0 51.0 leftKeys String[] The list of left keys. Small, v51.0 51.0 leftQualifier String The left qualifier. Small, v51.0 51.0 rightKeys String[] The list of right keys. Small, v51.0 51.0 rightQualifier String The right qualifier. Small, v51.0 51.0 - LoadNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters LoadParametersRepresentation The parameters for the node. Small, v51.0 51.0 - LoadParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version dataset LoadDatasetRepresentation The dataset to load Small, v51.0 51.0 fields String[] The list of fields to load. Small, v51.0 51.0 sampleSize Integer The number of rows to load. Small, v51.0 51.0 - LoadDatasetRepresentation
-
Property Name Type Description Filter Group and Version Available Version label String The dataset label. Small, v51.0 51.0 type RecipeDatasetType The type of the dataset. Valid values are: - Analytics
- Connected
Small, v51.0 51.0 - LoadAnalyticsDatasetRepresentation
-
LoadAnalyticsDatasetRepresentation inherits properties from the abstract LoadDatasetRepresentation. These base properties appear alongside LoadAnalyticsDatasetRepresentation specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version name String The dataset name. Small, v51.0 51.0 - LoadConnectedDatasetRepresentation
-
LoadConnectedDatasetRepresentation inherits properties from the abstract LoadDatasetRepresentation. These base properties appear alongside LoadConnectedDatasetRepresentation specific properties in the following table.
Property Name Type Description Filter Group and Version Available Version connectionName String The name of the connection. Small, v51.0 51.0 sourceObjectName String The name of the source object. Small, v51.0 51.0 - OutputExternalNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters OutputExternalParametersRepresentation The parameters for the node. Small, v51.0 51.0 - OutputExternalParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version connectionName String The connection name. Small, v51.0 51.0 externalIdFieldName String The field name for the external ID. Small, v51.0 51.0 fieldsMapping OutputExternalFieldMappingRepresentation[] The list of field mappings. Small, v51.0 51.0 object String The object name. Small, v51.0 51.0 operation RecipeOutputExternalOperation The output external operation type. Valid values are: - Empty
- Insert
- Update
- Upsert
Small, v51.0 51.0 - OutputExternalFieldMappingRepresentation
-
Property Name Type Description Filter Group and Version Available Version sourceField String The name of the source field. Small, v51.0 51.0 targetField String The name of the target field. Small, v51.0 51.0 - PredictValuesNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters PredictValuesParametersRepresentation The parameters for the node. Small, v51.0 51.0 - PredictValuesParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version fields PredictValuesFieldRepresentation[] The list of fields. Small, v51.0 51.0 - PredictValuesFieldRepresentation
-
Property Name Type Description Filter Group and Version Available Version label String The label for the field. Small, v51.0 51.0 name String The name for the field. Small, v51.0 51.0 predictionSetup PredictValuesSetupRepresentation[] The self-field . Small, v51.0 51.0 - PredictValuesSetupRepresentation
-
Property Name Type Description Filter Group and Version Available Version modelInputFields PredictValuesInputFieldRepresentation[] The list of input fields for the model. Small, v51.0 51.0 sourceField PredictValuesInputFieldRepresentation The source field. Small, v51.0 51.0 - PredictValuesInputFieldRepresentation
-
Property Name Type Description Filter Group and Version Available Version name String The field name. Small, v51.0 51.0 - SaveNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters SaveParametersRepresentation The parameters for the node. Small, v51.0 51.0 - SaveParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version dataset SaveDatasetRepresentation The dataset to save. Small, v51.0 51.0 fields String[] The list of fields to save. Small, v51.0 51.0 - SaveDatasetRepresentation
-
Property Name Type Description Filter Group and Version Available Version folderName String The Analytics folder for the dataset. Small, v51.0 51.0 label String The label for the dataset. Small, v51.0 51.0 name String The name of the dataset. Small, v51.0 51.0 rowLevelSecurityFilter String The security predicate. Small, v51.0 51.0 rowLevelSharingSource String The sObject security sharing source. Small, v51.0 51.0 type String The type of the dataset. Small, v51.0 51.0 - SchemaNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version fields SchemaParametersRepresentation[] The schema fields for the node. Small, v51.0 51.0 slice SchemaSliceRepresentation[] The schema slice definition for the node. Small, v51.0 51.0 - SchemaParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version fields SchemaFieldRepresentation[] The schema fields for the node. Small, v51.0 51.0 slice SchemaSliceRepresentation The schema slice definition for the node. Small, v51.0 51.0 - SchemaFieldRepresentation
-
Property Name Type Description Filter Group and Version Available Version name String The schema field name. Small, v51.0 51.0 newProperties SchemaFieldNewPropertiesRepresentation The new schema field properties. Small, v51.0 51.0 - SchemaSliceRepresentation
-
Property Name Type Description Filter Group and Version Available Version fields String[] The list of fields for SELECT or DROP. Small, v51.0 51.0 ignoreMissingFields Boolean Indicates whether the node action ignores missing fields or not. Small, v51.0 51.0 mode String The slice mode. Valid values are: - SELECT
- DROP
Small, v51.0 51.0 - SchemaFieldNewPropertiesRepresentation
-
Property Name Type Description Filter Group and Version Available Version label String The schema field property label. Small, v51.0 51.0 name String The schema field property name. Small, v51.0 51.0 typeProperties SchemaFieldTypePropertiesRepresentation The new schema field type properties. Small, v51.0 51.0 - SchemaFieldTypePropertiesRepresentation
-
Property Name Type Description Filter Group and Version Available Version format String The DateTime format. Small, v51.0 51.0 length Integer The total length of the text. Small, v51.0 51.0 precision Integer The length of an arbitrary precision value. Optional 51.0 scale Integer The number of digits to the right of the decimal point. Small, v51.0 51.0 symbols SchemaFieldFormatSymbolsRepresentation The number format. Small, v51.0 51.0 type RecipeDataType The data type to convert to. Valid values are: - DateOnly Type
- DateTime Type
- Number Type
- Text Type
Small, v51.0 51.0 - SchemaFieldFormatSymbolsRepresentation
-
Property Name Type Description Filter Group and Version Available Version currencySymbol String The currency symbol format. Small, v51.0 51.0 decimalSymbol String The decimal symbol format. Small, v51.0 51.0 groupingSymbol String The grouping symbol format. Small, v51.0 51.0 - SplitNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters SplitParametersRepresentation The parameters for the node. Small, v51.0 51.0 - SplitParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version delimiter String The split delimiter. Small, v51.0 51.0 sourceField String The source field. Small, v51.0 51.0 targetFields RecipeNameLabelRepresentation[] The list of target fields. Small, v51.0 51.0 - SqlFilterNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters SqlFilterParametersRepresentation The parameters for the node. Small, v51.0 51.0 - SqlFilterParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version sqlFilterExpression String The SQL filter expression. Small, v51.0 51.0 - TimeSeriesNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters TimeSeriesParametersRepresentation The parameters for the node. Small, v51.0 51.0 - TimeSeriesParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version confidenceInterval String The confidence interval. Small, v51.0 51.0 dayField String The day field. Small, v51.0 51.0 forecastFields String[] The list of forecast fields. Small, v51.0 51.0 forecastLength Integer The forecast length. Small, v51.0 51.0 groupDatesBy RecipeGroupDatesBy The group dates by value. Valid values are: - Year
- YearMonth
- YearMonthDay
- YearQuarter
- YearWeek
Small, v51.0 51.0 ignoreLastTimePeriod Boolean Indicates whether to ignore the last time period or not. Small, v51.0 51.0 model RecipeTimeSeriesModel The time series model. Valid values are: - Additive
- Multiplicative
Small, v51.0 51.0 seasonality Integer The seasonality. Small, v51.0 51.0 subYearField String The sub year field. Small, v51.0 51.0 targetDateField RecipeNameLabelRepresentation The target date field. Small, v51.0 51.0 targetForecastFields RecipeNameLabelRepresentation[] The list of target forecast fields. Small, v51.0 51.0 yearField String The year field. Small, v51.0 51.0 - TypecastNodeRepresentation
-
Property Name Type Description Filter Group and Version Available Version parameters TypecastParametersRepresentation The parameters for the node. Small, v51.0 51.0 - TypecastParametersRepresentation
-
Property Name Type Description Filter Group and Version Available Version fields SchemaFieldRepresentation[] The list of fields to typecast. Small, v51.0 51.0