Class Recipe
- java.lang.Object
-
- software.amazon.awssdk.services.databrew.model.Recipe
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Recipe.Builder,Recipe>
@Generated("software.amazon.awssdk:codegen") public final class Recipe extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Recipe.Builder,Recipe>
Represents one or more actions to be performed on a DataBrew dataset.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRecipe.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Recipe.Builderbuilder()InstantcreateDate()The date and time that the recipe was created.StringcreatedBy()The Amazon Resource Name (ARN) of the user who created the recipe.Stringdescription()The description of the recipe.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSteps()For responses, this returns true if the service returned a value for the Steps property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringlastModifiedBy()The Amazon Resource Name (ARN) of the user who last modified the recipe.InstantlastModifiedDate()The last modification date and time of the recipe.Stringname()The unique name for the recipe.StringprojectName()The name of the project that the recipe is associated with.StringpublishedBy()The Amazon Resource Name (ARN) of the user who published the recipe.InstantpublishedDate()The date and time when the recipe was published.StringrecipeVersion()The identifier for the version for the recipe.StringresourceArn()The Amazon Resource Name (ARN) for the recipe.List<SdkField<?>>sdkFields()static Class<? extends Recipe.Builder>serializableBuilderClass()List<RecipeStep>steps()A list of steps that are defined by the recipe.Map<String,String>tags()Metadata tags that have been applied to the recipe.Recipe.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
createdBy
public final String createdBy()
The Amazon Resource Name (ARN) of the user who created the recipe.
- Returns:
- The Amazon Resource Name (ARN) of the user who created the recipe.
-
createDate
public final Instant createDate()
The date and time that the recipe was created.
- Returns:
- The date and time that the recipe was created.
-
lastModifiedBy
public final String lastModifiedBy()
The Amazon Resource Name (ARN) of the user who last modified the recipe.
- Returns:
- The Amazon Resource Name (ARN) of the user who last modified the recipe.
-
lastModifiedDate
public final Instant lastModifiedDate()
The last modification date and time of the recipe.
- Returns:
- The last modification date and time of the recipe.
-
projectName
public final String projectName()
The name of the project that the recipe is associated with.
- Returns:
- The name of the project that the recipe is associated with.
-
publishedBy
public final String publishedBy()
The Amazon Resource Name (ARN) of the user who published the recipe.
- Returns:
- The Amazon Resource Name (ARN) of the user who published the recipe.
-
publishedDate
public final Instant publishedDate()
The date and time when the recipe was published.
- Returns:
- The date and time when the recipe was published.
-
description
public final String description()
The description of the recipe.
- Returns:
- The description of the recipe.
-
name
public final String name()
The unique name for the recipe.
- Returns:
- The unique name for the recipe.
-
resourceArn
public final String resourceArn()
The Amazon Resource Name (ARN) for the recipe.
- Returns:
- The Amazon Resource Name (ARN) for the recipe.
-
hasSteps
public final boolean hasSteps()
For responses, this returns true if the service returned a value for the Steps property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
steps
public final List<RecipeStep> steps()
A list of steps that are defined by the recipe.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSteps()method.- Returns:
- A list of steps that are defined by the recipe.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final Map<String,String> tags()
Metadata tags that have been applied to the recipe.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- Metadata tags that have been applied to the recipe.
-
recipeVersion
public final String recipeVersion()
The identifier for the version for the recipe. Must be one of the following:
-
Numeric version (
X.Y) -XandYstand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. BothXandYare required, and "0.0" isn't a valid version. -
LATEST_WORKING- the most recent valid version being developed in a DataBrew project. -
LATEST_PUBLISHED- the most recent published version.
- Returns:
- The identifier for the version for the recipe. Must be one of the following:
-
Numeric version (
X.Y) -XandYstand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. BothXandYare required, and "0.0" isn't a valid version. -
LATEST_WORKING- the most recent valid version being developed in a DataBrew project. -
LATEST_PUBLISHED- the most recent published version.
-
-
-
toBuilder
public Recipe.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Recipe.Builder,Recipe>
-
builder
public static Recipe.Builder builder()
-
serializableBuilderClass
public static Class<? extends Recipe.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-