Class Recipe
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Recipe.Builder,
Recipe>
Represents one or more actions to be performed on a DataBrew dataset.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Recipe.Builder
builder()
final Instant
The date and time that the recipe was created.final String
The Amazon Resource Name (ARN) of the user who created the recipe.final String
The description of the recipe.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasSteps()
For responses, this returns true if the service returned a value for the Steps property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of the user who last modified the recipe.final Instant
The last modification date and time of the recipe.final String
name()
The unique name for the recipe.final String
The name of the project that the recipe is associated with.final String
The Amazon Resource Name (ARN) of the user who published the recipe.final Instant
The date and time when the recipe was published.final String
The identifier for the version for the recipe.final String
The Amazon Resource Name (ARN) for the recipe.static Class
<? extends Recipe.Builder> final List
<RecipeStep> steps()
A list of steps that are defined by the recipe.tags()
Metadata tags that have been applied to the recipe.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The date and time that the recipe was created.
- Returns:
- The date and time that the recipe was created.
-
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
The last modification date and time of the recipe.
- Returns:
- The last modification date and time of the recipe.
-
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
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
The date and time when the recipe was published.
- Returns:
- The date and time when the recipe was published.
-
description
The description of the recipe.
- Returns:
- The description of the recipe.
-
name
The unique name for the recipe.
- Returns:
- The unique name for the recipe.
-
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
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
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
The identifier for the version for the recipe. Must be one of the following:
-
Numeric version (
X.Y
) -X
andY
stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. BothX
andY
are 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
) -X
andY
stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. BothX
andY
are 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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Recipe.Builder,
Recipe> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-