public static interface CfnRecipe.RecipeParametersProperty
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnRecipe.RecipeParametersProperty.Builder
A builder for
CfnRecipe.RecipeParametersProperty |
static class |
CfnRecipe.RecipeParametersProperty.Jsii$Proxy
An implementation for
CfnRecipe.RecipeParametersProperty |
Modifier and Type | Method and Description |
---|---|
static CfnRecipe.RecipeParametersProperty.Builder |
builder() |
default java.lang.String |
getAggregateFunction()
The name of an aggregation function to apply.
|
default java.lang.String |
getBase()
The number of digits used in a counting system.
|
default java.lang.String |
getCaseStatement()
A case statement associated with a recipe.
|
default java.lang.String |
getCategoryMap()
A category map used for one-hot encoding.
|
default java.lang.String |
getCharsToRemove()
Characters to remove from a step that applies one-hot encoding or tokenization.
|
default java.lang.String |
getCollapseConsecutiveWhitespace()
Remove any non-word non-punctuation character.
|
default java.lang.String |
getColumnDataType()
The data type of the column.
|
default java.lang.String |
getColumnRange()
A range of columns to which a step is applied.
|
default java.lang.String |
getCount()
The number of times a string needs to be repeated.
|
default java.lang.String |
getCustomCharacters()
One or more characters that can be substituted or removed, depending on the context.
|
default java.lang.String |
getCustomStopWords()
A list of words to ignore in a step that applies word tokenization.
|
default java.lang.String |
getCustomValue()
A list of custom values to use in a step that requires that you provide a value to finish the operation.
|
default java.lang.String |
getDatasetsColumns()
A list of the dataset columns included in a project.
|
default java.lang.String |
getDateAddValue()
A value that specifies how many units of time to add or subtract for a date math operation.
|
default java.lang.String |
getDateTimeFormat()
A date format to apply to a date.
|
default java.lang.String |
getDateTimeParameters()
A set of parameters associated with a datetime.
|
default java.lang.String |
getDeleteOtherRows()
Determines whether unmapped rows in a categorical mapping should be deleted.
|
default java.lang.String |
getDelimiter()
The delimiter to use when parsing separated values in a text file.
|
default java.lang.String |
getEndPattern()
The end pattern to locate.
|
default java.lang.String |
getEndPosition()
The end position to locate.
|
default java.lang.String |
getEndValue()
The end value to locate.
|
default java.lang.String |
getExpandContractions()
A list of word contractions and what they expand to.
|
default java.lang.String |
getExponent()
The exponent to apply in an exponential operation.
|
default java.lang.String |
getFalseString()
A value that represents `FALSE` .
|
default java.lang.String |
getGroupByAggFunctionOptions()
Specifies options to apply to the `GROUP BY` used in an aggregation.
|
default java.lang.String |
getGroupByColumns()
The columns to use in the `GROUP BY` clause.
|
default java.lang.String |
getHiddenColumns()
A list of columns to hide.
|
default java.lang.String |
getIgnoreCase()
Indicates that lower and upper case letters are treated equally.
|
default java.lang.String |
getIncludeInSplit()
Indicates if this column is participating in a split transform.
|
default java.lang.Object |
getInput()
The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog .
|
default java.lang.String |
getInterval()
The number of characters to split by.
|
default java.lang.String |
getIsText()
Indicates if the content is text.
|
default java.lang.String |
getJoinKeys()
The keys or columns involved in a join.
|
default java.lang.String |
getJoinType()
The type of join to use, for example, `INNER JOIN` , `OUTER JOIN` , and so on.
|
default java.lang.String |
getLeftColumns()
The columns on the left side of the join.
|
default java.lang.String |
getLimit()
The number of times to perform `split` or `replaceBy` in a string.
|
default java.lang.String |
getLowerBound()
The lower boundary for a value.
|
default java.lang.String |
getMapType()
The type of mappings to apply to construct a new dynamic frame.
|
default java.lang.String |
getModeType()
Determines the manner in which mode value is calculated, in case there is more than one mode value.
|
default java.lang.Object |
getMultiLine()
Specifies whether JSON input contains embedded new line characters.
|
default java.lang.String |
getNumRows()
The number of rows to consider in a window.
|
default java.lang.String |
getNumRowsAfter()
The number of rows to consider after the current row in a window.
|
default java.lang.String |
getNumRowsBefore()
The number of rows to consider before the current row in a window.
|
default java.lang.String |
getOrderByColumn()
A column to sort the results by.
|
default java.lang.String |
getOrderByColumns()
The columns to sort the results by.
|
default java.lang.String |
getOther()
The value to assign to unmapped cells, in categorical mapping.
|
default java.lang.String |
getPattern()
The pattern to locate.
|
default java.lang.String |
getPatternOption1()
The starting pattern to split between.
|
default java.lang.String |
getPatternOption2()
The ending pattern to split between.
|
default java.lang.String |
getPatternOptions()
For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format.
|
default java.lang.String |
getPeriod()
The size of the rolling window.
|
default java.lang.String |
getPosition()
The character index within a string.
|
default java.lang.String |
getRemoveAllPunctuation()
If `true` , removes all of the following characters: `.` `.!` `.,` `.?`.
|
default java.lang.String |
getRemoveAllQuotes()
If `true` , removes all single quotes and double quotes.
|
default java.lang.String |
getRemoveAllWhitespace()
If `true` , removes all whitespaces from the value.
|
default java.lang.String |
getRemoveCustomCharacters()
If `true` , removes all chraracters specified by `CustomCharacters` .
|
default java.lang.String |
getRemoveCustomValue()
If `true` , removes all chraracters specified by `CustomValue` .
|
default java.lang.String |
getRemoveLeadingAndTrailingPunctuation()
If `true` , removes the following characters if they occur at the start or end of the value: `.` `!` `,` `?`.
|
default java.lang.String |
getRemoveLeadingAndTrailingQuotes()
If `true` , removes single quotes and double quotes from the beginning and end of the value.
|
default java.lang.String |
getRemoveLeadingAndTrailingWhitespace()
If `true` , removes all whitespaces from the beginning and end of the value.
|
default java.lang.String |
getRemoveLetters()
If `true` , removes all uppercase and lowercase alphabetic characters (A through Z;
|
default java.lang.String |
getRemoveNumbers()
If `true` , removes all numeric characters (0 through 9).
|
default java.lang.String |
getRemoveSourceColumn()
If `true` , the source column will be removed after un-nesting that column.
|
default java.lang.String |
getRemoveSpecialCharacters()
If `true` , removes all of the following characters: `!
|
default java.lang.String |
getRightColumns()
The columns on the right side of a join.
|
default java.lang.String |
getSampleSize()
The number of rows in the sample.
|
default java.lang.String |
getSampleType()
The sampling type to apply to the dataset.
|
default java.lang.Object |
getSecondaryInputs()
A list of secondary inputs in a UNION transform.
|
default java.lang.String |
getSecondInput()
A object value to indicate the second dataset used in a join.
|
default java.lang.Object |
getSheetIndexes()
One or more sheet numbers in the Excel file, which will be included in a dataset.
|
default java.util.List<java.lang.String> |
getSheetNames()
Oone or more named sheets in the Excel file, which will be included in a dataset.
|
default java.lang.String |
getSourceColumn()
A source column needed for an operation, step, or transform.
|
default java.lang.String |
getSourceColumn1()
A source column needed for an operation, step, or transform.
|
default java.lang.String |
getSourceColumn2()
A source column needed for an operation, step, or transform.
|
default java.lang.String |
getSourceColumns()
A list of source columns needed for an operation, step, or transform.
|
default java.lang.String |
getStartColumnIndex()
The index number of the first column used by an operation, step, or transform.
|
default java.lang.String |
getStartPattern()
The starting pattern to locate.
|
default java.lang.String |
getStartPosition()
The starting position to locate.
|
default java.lang.String |
getStartValue()
The starting value to locate.
|
default java.lang.String |
getStemmingMode()
Indicates this operation uses stems and lemmas (base words) for word tokenization.
|
default java.lang.String |
getStepCount()
The total number of transforms in this recipe.
|
default java.lang.String |
getStepIndex()
The index ID of a step.
|
default java.lang.String |
getStopWordsMode()
Indicates this operation uses stop words as part of word tokenization.
|
default java.lang.String |
getStrategy()
The resolution strategy to apply in resolving ambiguities.
|
default java.lang.String |
getTargetColumn()
The column targeted by this operation.
|
default java.lang.String |
getTargetColumnNames()
The names to give columns altered by this operation.
|
default java.lang.String |
getTargetDateFormat()
The date format to convert to.
|
default java.lang.String |
getTargetIndex()
The index number of an object that is targeted by this operation.
|
default java.lang.String |
getTimeZone()
The current timezone that you want to use for dates.
|
default java.lang.String |
getTokenizerPattern()
A regex expression to use when splitting text into terms, also called words or tokens.
|
default java.lang.String |
getTrueString()
A value to use to represent `TRUE` .
|
default java.lang.String |
getUdfLang()
The language that's used in the user-defined function.
|
default java.lang.String |
getUnits()
Specifies a unit of time.
|
default java.lang.String |
getUnpivotColumn()
Cast columns as rows, so that each value is a different row in a single column.
|
default java.lang.String |
getUpperBound()
The upper boundary for a value.
|
default java.lang.String |
getUseNewDataFrame()
Create a new container to hold a dataset.
|
default java.lang.String |
getValue()
A static value that can be used in a comparison, a substitution, or in another context-specific way.
|
default java.lang.String |
getValue1()
A value that's used by this operation.
|
default java.lang.String |
getValue2()
A value that's used by this operation.
|
default java.lang.String |
getValueColumn()
The column that is provided as a value that's used by this operation.
|
default java.lang.String |
getViewFrame()
The subset of rows currently available for viewing.
|
default java.lang.String getAggregateFunction()
default java.lang.String getBase()
default java.lang.String getCaseStatement()
default java.lang.String getCategoryMap()
default java.lang.String getCharsToRemove()
default java.lang.String getCollapseConsecutiveWhitespace()
default java.lang.String getColumnDataType()
default java.lang.String getColumnRange()
default java.lang.String getCount()
default java.lang.String getCustomCharacters()
default java.lang.String getCustomStopWords()
default java.lang.String getCustomValue()
default java.lang.String getDatasetsColumns()
default java.lang.String getDateAddValue()
default java.lang.String getDateTimeFormat()
default java.lang.String getDateTimeParameters()
default java.lang.String getDeleteOtherRows()
default java.lang.String getDelimiter()
default java.lang.String getEndPattern()
default java.lang.String getEndPosition()
default java.lang.String getEndValue()
default java.lang.String getExpandContractions()
For eample: can't ; cannot ; can not .
default java.lang.String getExponent()
default java.lang.String getFalseString()
default java.lang.String getGroupByAggFunctionOptions()
default java.lang.String getGroupByColumns()
default java.lang.String getHiddenColumns()
default java.lang.String getIgnoreCase()
default java.lang.String getIncludeInSplit()
default java.lang.Object getInput()
default java.lang.String getInterval()
default java.lang.String getIsText()
default java.lang.String getJoinKeys()
default java.lang.String getJoinType()
default java.lang.String getLeftColumns()
default java.lang.String getLimit()
default java.lang.String getLowerBound()
default java.lang.String getMapType()
default java.lang.String getModeType()
Valid values: NONE
| AVERAGE
| MINIMUM
| MAXIMUM
default java.lang.Object getMultiLine()
default java.lang.String getNumRows()
default java.lang.String getNumRowsAfter()
default java.lang.String getNumRowsBefore()
default java.lang.String getOrderByColumn()
default java.lang.String getOrderByColumns()
default java.lang.String getOther()
default java.lang.String getPattern()
default java.lang.String getPatternOption1()
default java.lang.String getPatternOption2()
default java.lang.String getPatternOptions()
For example: [{\"pattern\":\"1\",\"includeInSplit\":true}]
default java.lang.String getPeriod()
default java.lang.String getPosition()
default java.lang.String getRemoveAllPunctuation()
default java.lang.String getRemoveAllQuotes()
default java.lang.String getRemoveAllWhitespace()
default java.lang.String getRemoveCustomCharacters()
default java.lang.String getRemoveCustomValue()
default java.lang.String getRemoveLeadingAndTrailingPunctuation()
default java.lang.String getRemoveLeadingAndTrailingQuotes()
default java.lang.String getRemoveLeadingAndTrailingWhitespace()
default java.lang.String getRemoveLetters()
a through z).
default java.lang.String getRemoveNumbers()
default java.lang.String getRemoveSourceColumn()
(Used with nested column types, such as Map, Struct, or Array.)
default java.lang.String getRemoveSpecialCharacters()
" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~
default java.lang.String getRightColumns()
default java.lang.String getSampleSize()
default java.lang.String getSampleType()
Valid values: FIRST_N
| LAST_N
| RANDOM
default java.lang.Object getSecondaryInputs()
default java.lang.String getSecondInput()
default java.lang.Object getSheetIndexes()
default java.util.List<java.lang.String> getSheetNames()
default java.lang.String getSourceColumn()
default java.lang.String getSourceColumn1()
default java.lang.String getSourceColumn2()
default java.lang.String getSourceColumns()
default java.lang.String getStartColumnIndex()
default java.lang.String getStartPattern()
default java.lang.String getStartPosition()
default java.lang.String getStartValue()
default java.lang.String getStemmingMode()
default java.lang.String getStepCount()
default java.lang.String getStepIndex()
default java.lang.String getStopWordsMode()
default java.lang.String getStrategy()
default java.lang.String getTargetColumn()
default java.lang.String getTargetColumnNames()
default java.lang.String getTargetDateFormat()
default java.lang.String getTargetIndex()
default java.lang.String getTimeZone()
default java.lang.String getTokenizerPattern()
default java.lang.String getTrueString()
default java.lang.String getUdfLang()
default java.lang.String getUnits()
For example: MINUTES
; SECONDS
; HOURS
; etc.
default java.lang.String getUnpivotColumn()
default java.lang.String getUpperBound()
default java.lang.String getUseNewDataFrame()
default java.lang.String getValue()
A Value
can be a number, string, or other datatype, depending on the recipe action in which it's used.
default java.lang.String getValue1()
default java.lang.String getValue2()
default java.lang.String getValueColumn()
default java.lang.String getViewFrame()
static CfnRecipe.RecipeParametersProperty.Builder builder()