Interface CfnRecipe.RecipeParametersProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRecipe.RecipeParametersProperty.Jsii$Proxy
- Enclosing class:
- CfnRecipe
@Stability(Stable)
public static interface CfnRecipe.RecipeParametersProperty
extends software.amazon.jsii.JsiiSerializable
Parameters that are used as inputs for various recipe actions.
The parameters are specific to the context in which they're used.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.databrew.*;
Object input;
RecipeParametersProperty recipeParametersProperty = RecipeParametersProperty.builder()
.aggregateFunction("aggregateFunction")
.base("base")
.caseStatement("caseStatement")
.categoryMap("categoryMap")
.charsToRemove("charsToRemove")
.collapseConsecutiveWhitespace("collapseConsecutiveWhitespace")
.columnDataType("columnDataType")
.columnRange("columnRange")
.count("count")
.customCharacters("customCharacters")
.customStopWords("customStopWords")
.customValue("customValue")
.datasetsColumns("datasetsColumns")
.dateAddValue("dateAddValue")
.dateTimeFormat("dateTimeFormat")
.dateTimeParameters("dateTimeParameters")
.deleteOtherRows("deleteOtherRows")
.delimiter("delimiter")
.endPattern("endPattern")
.endPosition("endPosition")
.endValue("endValue")
.expandContractions("expandContractions")
.exponent("exponent")
.falseString("falseString")
.groupByAggFunctionOptions("groupByAggFunctionOptions")
.groupByColumns("groupByColumns")
.hiddenColumns("hiddenColumns")
.ignoreCase("ignoreCase")
.includeInSplit("includeInSplit")
.input(input)
.interval("interval")
.isText("isText")
.joinKeys("joinKeys")
.joinType("joinType")
.leftColumns("leftColumns")
.limit("limit")
.lowerBound("lowerBound")
.mapType("mapType")
.modeType("modeType")
.multiLine(false)
.numRows("numRows")
.numRowsAfter("numRowsAfter")
.numRowsBefore("numRowsBefore")
.orderByColumn("orderByColumn")
.orderByColumns("orderByColumns")
.other("other")
.pattern("pattern")
.patternOption1("patternOption1")
.patternOption2("patternOption2")
.patternOptions("patternOptions")
.period("period")
.position("position")
.removeAllPunctuation("removeAllPunctuation")
.removeAllQuotes("removeAllQuotes")
.removeAllWhitespace("removeAllWhitespace")
.removeCustomCharacters("removeCustomCharacters")
.removeCustomValue("removeCustomValue")
.removeLeadingAndTrailingPunctuation("removeLeadingAndTrailingPunctuation")
.removeLeadingAndTrailingQuotes("removeLeadingAndTrailingQuotes")
.removeLeadingAndTrailingWhitespace("removeLeadingAndTrailingWhitespace")
.removeLetters("removeLetters")
.removeNumbers("removeNumbers")
.removeSourceColumn("removeSourceColumn")
.removeSpecialCharacters("removeSpecialCharacters")
.rightColumns("rightColumns")
.sampleSize("sampleSize")
.sampleType("sampleType")
.secondaryInputs(List.of(SecondaryInputProperty.builder()
.dataCatalogInputDefinition(DataCatalogInputDefinitionProperty.builder()
.catalogId("catalogId")
.databaseName("databaseName")
.tableName("tableName")
.tempDirectory(S3LocationProperty.builder()
.bucket("bucket")
// the properties below are optional
.key("key")
.build())
.build())
.s3InputDefinition(S3LocationProperty.builder()
.bucket("bucket")
// the properties below are optional
.key("key")
.build())
.build()))
.secondInput("secondInput")
.sheetIndexes(List.of(123))
.sheetNames(List.of("sheetNames"))
.sourceColumn("sourceColumn")
.sourceColumn1("sourceColumn1")
.sourceColumn2("sourceColumn2")
.sourceColumns("sourceColumns")
.startColumnIndex("startColumnIndex")
.startPattern("startPattern")
.startPosition("startPosition")
.startValue("startValue")
.stemmingMode("stemmingMode")
.stepCount("stepCount")
.stepIndex("stepIndex")
.stopWordsMode("stopWordsMode")
.strategy("strategy")
.targetColumn("targetColumn")
.targetColumnNames("targetColumnNames")
.targetDateFormat("targetDateFormat")
.targetIndex("targetIndex")
.timeZone("timeZone")
.tokenizerPattern("tokenizerPattern")
.trueString("trueString")
.udfLang("udfLang")
.units("units")
.unpivotColumn("unpivotColumn")
.upperBound("upperBound")
.useNewDataFrame("useNewDataFrame")
.value("value")
.value1("value1")
.value2("value2")
.valueColumn("valueColumn")
.viewFrame("viewFrame")
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnRecipe.RecipeParametersPropertystatic final classAn implementation forCfnRecipe.RecipeParametersProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe name of an aggregation function to apply.default StringgetBase()The number of digits used in a counting system.default StringA case statement associated with a recipe.default StringA category map used for one-hot encoding.default StringCharacters to remove from a step that applies one-hot encoding or tokenization.default StringRemove any non-word non-punctuation character.default StringThe data type of the column.default StringA range of columns to which a step is applied.default StringgetCount()The number of times a string needs to be repeated.default StringOne or more characters that can be substituted or removed, depending on the context.default StringA list of words to ignore in a step that applies word tokenization.default StringA list of custom values to use in a step that requires that you provide a value to finish the operation.default StringA list of the dataset columns included in a project.default StringA value that specifies how many units of time to add or subtract for a date math operation.default StringA date format to apply to a date.default StringA set of parameters associated with a datetime.default StringDetermines whether unmapped rows in a categorical mapping should be deleted.default StringThe delimiter to use when parsing separated values in a text file.default StringThe end pattern to locate.default StringThe end position to locate.default StringThe end value to locate.default StringA list of word contractions and what they expand to.default StringThe exponent to apply in an exponential operation.default StringA value that representsFALSE.default StringSpecifies options to apply to theGROUP BYused in an aggregation.default StringThe columns to use in theGROUP BYclause.default StringA list of columns to hide.default StringIndicates that lower and upper case letters are treated equally.default StringIndicates if this column is participating in a split transform.default ObjectgetInput()The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog .default StringThe number of characters to split by.default StringIndicates if the content is text.default StringThe keys or columns involved in a join.default StringThe type of join to use, for example,INNER JOIN,OUTER JOIN, and so on.default StringThe columns on the left side of the join.default StringgetLimit()The number of times to performsplitorreplaceByin a string.default StringThe lower boundary for a value.default StringThe type of mappings to apply to construct a new dynamic frame.default StringDetermines the manner in which mode value is calculated, in case there is more than one mode value.default ObjectSpecifies whether JSON input contains embedded new line characters.default StringThe number of rows to consider in a window.default StringThe number of rows to consider after the current row in a window.default StringThe number of rows to consider before the current row in a window.default StringA column to sort the results by.default StringThe columns to sort the results by.default StringgetOther()The value to assign to unmapped cells, in categorical mapping.default StringThe pattern to locate.default StringThe starting pattern to split between.default StringThe ending pattern to split between.default StringFor splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format.default StringThe size of the rolling window.default StringThe character index within a string.default StringIftrue, removes all of the following characters:..!.,.?.default StringIftrue, removes all single quotes and double quotes.default StringIftrue, removes all whitespaces from the value.default StringIftrue, removes all chraracters specified byCustomCharacters.default StringIftrue, removes all chraracters specified byCustomValue.default StringIftrue, removes the following characters if they occur at the start or end of the value:.!,?.default StringIftrue, removes single quotes and double quotes from the beginning and end of the value.default StringIftrue, removes all whitespaces from the beginning and end of the value.default StringIftrue, removes all uppercase and lowercase alphabetic characters (A through Z;default StringIftrue, removes all numeric characters (0 through 9).default StringIftrue, the source column will be removed after un-nesting that column.default StringIftrue, removes all of the following characters: `!default StringThe columns on the right side of a join.default StringThe number of rows in the sample.default StringThe sampling type to apply to the dataset.default ObjectA list of secondary inputs in a UNION transform.default StringA object value to indicate the second dataset used in a join.default ObjectOne or more sheet numbers in the Excel file, which will be included in a dataset.Oone or more named sheets in the Excel file, which will be included in a dataset.default StringA source column needed for an operation, step, or transform.default StringA source column needed for an operation, step, or transform.default StringA source column needed for an operation, step, or transform.default StringA list of source columns needed for an operation, step, or transform.default StringThe index number of the first column used by an operation, step, or transform.default StringThe starting pattern to locate.default StringThe starting position to locate.default StringThe starting value to locate.default StringIndicates this operation uses stems and lemmas (base words) for word tokenization.default StringThe total number of transforms in this recipe.default StringThe index ID of a step.default StringIndicates this operation uses stop words as part of word tokenization.default StringThe resolution strategy to apply in resolving ambiguities.default StringThe column targeted by this operation.default StringThe names to give columns altered by this operation.default StringThe date format to convert to.default StringThe index number of an object that is targeted by this operation.default StringThe current timezone that you want to use for dates.default StringA regex expression to use when splitting text into terms, also called words or tokens.default StringA value to use to representTRUE.default StringThe language that's used in the user-defined function.default StringgetUnits()Specifies a unit of time.default StringCast columns as rows, so that each value is a different row in a single column.default StringThe upper boundary for a value.default StringCreate a new container to hold a dataset.default StringgetValue()A static value that can be used in a comparison, a substitution, or in another context-specific way.default StringA value that's used by this operation.default StringA value that's used by this operation.default StringThe column that is provided as a value that's used by this operation.default StringThe subset of rows currently available for viewing.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAggregateFunction
The name of an aggregation function to apply. -
getBase
The number of digits used in a counting system. -
getCaseStatement
A case statement associated with a recipe. -
getCategoryMap
A category map used for one-hot encoding. -
getCharsToRemove
Characters to remove from a step that applies one-hot encoding or tokenization. -
getCollapseConsecutiveWhitespace
Remove any non-word non-punctuation character. -
getColumnDataType
The data type of the column. -
getColumnRange
A range of columns to which a step is applied. -
getCount
The number of times a string needs to be repeated. -
getCustomCharacters
One or more characters that can be substituted or removed, depending on the context. -
getCustomStopWords
A list of words to ignore in a step that applies word tokenization. -
getCustomValue
A list of custom values to use in a step that requires that you provide a value to finish the operation. -
getDatasetsColumns
A list of the dataset columns included in a project. -
getDateAddValue
A value that specifies how many units of time to add or subtract for a date math operation. -
getDateTimeFormat
A date format to apply to a date. -
getDateTimeParameters
A set of parameters associated with a datetime. -
getDeleteOtherRows
Determines whether unmapped rows in a categorical mapping should be deleted. -
getDelimiter
The delimiter to use when parsing separated values in a text file. -
getEndPattern
The end pattern to locate. -
getEndPosition
The end position to locate. -
getEndValue
The end value to locate. -
getExpandContractions
A list of word contractions and what they expand to.For eample: can't ; cannot ; can not .
-
getExponent
The exponent to apply in an exponential operation. -
getFalseString
A value that representsFALSE. -
getGroupByAggFunctionOptions
Specifies options to apply to theGROUP BYused in an aggregation. -
getGroupByColumns
The columns to use in theGROUP BYclause. -
getHiddenColumns
A list of columns to hide. -
getIgnoreCase
Indicates that lower and upper case letters are treated equally. -
getIncludeInSplit
Indicates if this column is participating in a split transform. -
getInput
The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog . -
getInterval
The number of characters to split by. -
getIsText
Indicates if the content is text. -
getJoinKeys
The keys or columns involved in a join. -
getJoinType
The type of join to use, for example,INNER JOIN,OUTER JOIN, and so on. -
getLeftColumns
The columns on the left side of the join. -
getLimit
The number of times to performsplitorreplaceByin a string. -
getLowerBound
The lower boundary for a value. -
getMapType
The type of mappings to apply to construct a new dynamic frame. -
getModeType
Determines the manner in which mode value is calculated, in case there is more than one mode value.Valid values:
NONE|AVERAGE|MINIMUM|MAXIMUM -
getMultiLine
Specifies whether JSON input contains embedded new line characters. -
getNumRows
The number of rows to consider in a window. -
getNumRowsAfter
The number of rows to consider after the current row in a window. -
getNumRowsBefore
The number of rows to consider before the current row in a window. -
getOrderByColumn
A column to sort the results by. -
getOrderByColumns
The columns to sort the results by. -
getOther
The value to assign to unmapped cells, in categorical mapping. -
getPattern
The pattern to locate. -
getPatternOption1
The starting pattern to split between. -
getPatternOption2
The ending pattern to split between. -
getPatternOptions
For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format.For example:
[{\"pattern\":\"1\",\"includeInSplit\":true}] -
getPeriod
The size of the rolling window. -
getPosition
The character index within a string. -
getRemoveAllPunctuation
Iftrue, removes all of the following characters:..!.,.?. -
getRemoveAllQuotes
Iftrue, removes all single quotes and double quotes. -
getRemoveAllWhitespace
Iftrue, removes all whitespaces from the value. -
getRemoveCustomCharacters
Iftrue, removes all chraracters specified byCustomCharacters. -
getRemoveCustomValue
Iftrue, removes all chraracters specified byCustomValue. -
getRemoveLeadingAndTrailingPunctuation
Iftrue, removes the following characters if they occur at the start or end of the value:.!,?. -
getRemoveLeadingAndTrailingQuotes
Iftrue, removes single quotes and double quotes from the beginning and end of the value. -
getRemoveLeadingAndTrailingWhitespace
Iftrue, removes all whitespaces from the beginning and end of the value. -
getRemoveLetters
Iftrue, removes all uppercase and lowercase alphabetic characters (A through Z;a through z).
-
getRemoveNumbers
Iftrue, removes all numeric characters (0 through 9). -
getRemoveSourceColumn
Iftrue, the source column will be removed after un-nesting that column.(Used with nested column types, such as Map, Struct, or Array.)
-
getRemoveSpecialCharacters
Iftrue, removes all of the following characters: `!" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _
{ | } ~ -
getRightColumns
The columns on the right side of a join. -
getSampleSize
The number of rows in the sample. -
getSampleType
The sampling type to apply to the dataset.Valid values:
FIRST_N|LAST_N|RANDOM -
getSecondaryInputs
A list of secondary inputs in a UNION transform. -
getSecondInput
A object value to indicate the second dataset used in a join. -
getSheetIndexes
One or more sheet numbers in the Excel file, which will be included in a dataset. -
getSheetNames
Oone or more named sheets in the Excel file, which will be included in a dataset. -
getSourceColumn
A source column needed for an operation, step, or transform. -
getSourceColumn1
A source column needed for an operation, step, or transform. -
getSourceColumn2
A source column needed for an operation, step, or transform. -
getSourceColumns
A list of source columns needed for an operation, step, or transform. -
getStartColumnIndex
The index number of the first column used by an operation, step, or transform. -
getStartPattern
The starting pattern to locate. -
getStartPosition
The starting position to locate. -
getStartValue
The starting value to locate. -
getStemmingMode
Indicates this operation uses stems and lemmas (base words) for word tokenization. -
getStepCount
The total number of transforms in this recipe. -
getStepIndex
The index ID of a step. -
getStopWordsMode
Indicates this operation uses stop words as part of word tokenization. -
getStrategy
The resolution strategy to apply in resolving ambiguities. -
getTargetColumn
The column targeted by this operation. -
getTargetColumnNames
The names to give columns altered by this operation. -
getTargetDateFormat
The date format to convert to. -
getTargetIndex
The index number of an object that is targeted by this operation. -
getTimeZone
The current timezone that you want to use for dates. -
getTokenizerPattern
A regex expression to use when splitting text into terms, also called words or tokens. -
getTrueString
A value to use to representTRUE. -
getUdfLang
The language that's used in the user-defined function. -
getUnits
Specifies a unit of time.For example:
MINUTES;SECONDS;HOURS; etc. -
getUnpivotColumn
Cast columns as rows, so that each value is a different row in a single column. -
getUpperBound
The upper boundary for a value. -
getUseNewDataFrame
Create a new container to hold a dataset. -
getValue
A static value that can be used in a comparison, a substitution, or in another context-specific way.A
Valuecan be a number, string, or other datatype, depending on the recipe action in which it's used. -
getValue1
A value that's used by this operation. -
getValue2
A value that's used by this operation. -
getValueColumn
The column that is provided as a value that's used by this operation. -
getViewFrame
The subset of rows currently available for viewing. -
builder
-