io.cdap.wrangler.store.recipe

Class RecipeStore

java.lang.Object

io.cdap.wrangler.store.recipe.RecipeStore

public class RecipeStore
extends Object

Recipe store for v2 endpoint

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE_TIME_COL
static String	GENERATION_COL
static String	NAMESPACE_FIELD
static String	RECIPE_ID_FIELD
static String	RECIPE_INFO_COL
static String	RECIPE_NAME_FIELD
static io.cdap.cdap.spi.data.table.StructuredTableSpecification	RECIPE_TABLE_SPEC
static String	UPDATE_TIME_COL

Constructor Summary

Constructors

Constructor and Description
RecipeStore(io.cdap.cdap.spi.data.transaction.TransactionRunner transactionRunner)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	createRecipe(RecipeId recipeId, RecipeRow recipeRow) Create a new recipe
void	deleteRecipe(RecipeId recipeId) Delete the specified Recipe
Recipe	getRecipeById(RecipeId recipeId) Get the Recipe associated with given recipe Id
Recipe	getRecipeByName(io.cdap.cdap.api.NamespaceSummary namespace, String recipeName) Get the Recipe associated with given recipe name if it exists, else throws RecipeNotFoundException
RecipeListResponse	listRecipes(RecipePageRequest request) Get a paginated list of recipes in given namespace
void	updateRecipe(RecipeId recipeId, RecipeRow recipeRow) Update a recipe

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAMESPACE_FIELD

public static final String NAMESPACE_FIELD

See Also:

Constant Field Values

GENERATION_COL

public static final String GENERATION_COL

See Also:

Constant Field Values

RECIPE_ID_FIELD

public static final String RECIPE_ID_FIELD

See Also:

Constant Field Values

RECIPE_NAME_FIELD

public static final String RECIPE_NAME_FIELD

See Also:

Constant Field Values

CREATE_TIME_COL

public static final String CREATE_TIME_COL

See Also:

Constant Field Values

UPDATE_TIME_COL

public static final String UPDATE_TIME_COL

See Also:

Constant Field Values

RECIPE_INFO_COL

public static final String RECIPE_INFO_COL

See Also:

Constant Field Values

RECIPE_TABLE_SPEC

public static final io.cdap.cdap.spi.data.table.StructuredTableSpecification RECIPE_TABLE_SPEC

Constructor Detail

RecipeStore

public RecipeStore(io.cdap.cdap.spi.data.transaction.TransactionRunner transactionRunner)

Method Detail

createRecipe

public void createRecipe(RecipeId recipeId,
                         RecipeRow recipeRow)

Create a new recipe

Parameters:

recipeId - id of the recipe

recipeRow - recipe to create/update

updateRecipe

public void updateRecipe(RecipeId recipeId,
                         RecipeRow recipeRow)

Update a recipe

Parameters:

recipeId - id of the recipe

recipeRow - recipe to create/update

getRecipeById

public Recipe getRecipeById(RecipeId recipeId)
                     throws RecipeNotFoundException

Get the Recipe associated with given recipe Id

Parameters:

recipeId - id of the recipe to fetch

Returns:

Recipe metadata for given recipe id

Throws:

RecipeNotFoundException - if recipe is not found

getRecipeByName

public Recipe getRecipeByName(io.cdap.cdap.api.NamespaceSummary namespace,
                              String recipeName)
                       throws RecipeNotFoundException

Get the Recipe associated with given recipe name if it exists, else throws RecipeNotFoundException

Parameters:

namespace -

recipeName -

Returns:

Recipe metadata for given recipe name if exists

Throws:

RecipeNotFoundException

listRecipes

public RecipeListResponse listRecipes(RecipePageRequest request)

Get a paginated list of recipes in given namespace

Parameters:

request - RecipePageRequest that contains necessary query parameters

Returns:

RecipeListResponse that contains a page of results and nextPageToken

deleteRecipe

public void deleteRecipe(RecipeId recipeId)
                  throws RecipeNotFoundException

Delete the specified Recipe

Parameters:

recipeId - id of the recipe to delete

Throws:

RecipeNotFoundException - if recipe with given id is not found

clear

public void clear()