software.amazon.awssdk.services.databrew.model.CreateRecipeRequest Maven / Gradle / Ivy
Show all versions of databrew Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.databrew.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateRecipeRequest extends DataBrewRequest implements
ToCopyableBuilder {
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateRecipeRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateRecipeRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField> STEPS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Steps")
.getter(getter(CreateRecipeRequest::steps))
.setter(setter(Builder::steps))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Steps").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RecipeStep::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateRecipeRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DESCRIPTION_FIELD, NAME_FIELD,
STEPS_FIELD, TAGS_FIELD));
private final String description;
private final String name;
private final List steps;
private final Map tags;
private CreateRecipeRequest(BuilderImpl builder) {
super(builder);
this.description = builder.description;
this.name = builder.name;
this.steps = builder.steps;
this.tags = builder.tags;
}
/**
*
* A description for the recipe.
*
*
* @return A description for the recipe.
*/
public final String description() {
return description;
}
/**
*
* A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and
* space.
*
*
* @return A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.),
* and space.
*/
public final String name() {
return name;
}
/**
* 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 the {@code isEmpty()} 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.
*/
public final boolean hasSteps() {
return steps != null && !(steps instanceof SdkAutoConstructList);
}
/**
*
* An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action and
* (optionally) an array of condition expressions.
*
*
* 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 {@link #hasSteps} method.
*
*
* @return An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe
* action and (optionally) an array of condition expressions.
*/
public final List steps() {
return steps;
}
/**
* 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 the {@code isEmpty()} 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* Metadata tags to apply to this 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 {@link #hasTags} method.
*
*
* @return Metadata tags to apply to this recipe.
*/
public final Map tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(hasSteps() ? steps() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateRecipeRequest)) {
return false;
}
CreateRecipeRequest other = (CreateRecipeRequest) obj;
return Objects.equals(description(), other.description()) && Objects.equals(name(), other.name())
&& hasSteps() == other.hasSteps() && Objects.equals(steps(), other.steps()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateRecipeRequest").add("Description", description()).add("Name", name())
.add("Steps", hasSteps() ? steps() : null).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Steps":
return Optional.ofNullable(clazz.cast(steps()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateRecipeRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DataBrewRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A description for the recipe.
*
*
* @param description
* A description for the recipe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and
* space.
*
*
* @param name
* A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period
* (.), and space.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action
* and (optionally) an array of condition expressions.
*
*
* @param steps
* An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe
* action and (optionally) an array of condition expressions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder steps(Collection steps);
/**
*
* An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action
* and (optionally) an array of condition expressions.
*
*
* @param steps
* An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe
* action and (optionally) an array of condition expressions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder steps(RecipeStep... steps);
/**
*
* An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action
* and (optionally) an array of condition expressions.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.databrew.model.RecipeStep.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.databrew.model.RecipeStep#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.databrew.model.RecipeStep.Builder#build()} is called immediately and
* its result is passed to {@link #steps(List)}.
*
* @param steps
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.databrew.model.RecipeStep.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #steps(java.util.Collection)
*/
Builder steps(Consumer... steps);
/**
*
* Metadata tags to apply to this recipe.
*
*
* @param tags
* Metadata tags to apply to this recipe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DataBrewRequest.BuilderImpl implements Builder {
private String description;
private String name;
private List steps = DefaultSdkAutoConstructList.getInstance();
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateRecipeRequest model) {
super(model);
description(model.description);
name(model.name);
steps(model.steps);
tags(model.tags);
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final List getSteps() {
List result = RecipeStepListCopier.copyToBuilder(this.steps);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSteps(Collection steps) {
this.steps = RecipeStepListCopier.copyFromBuilder(steps);
}
@Override
public final Builder steps(Collection steps) {
this.steps = RecipeStepListCopier.copy(steps);
return this;
}
@Override
@SafeVarargs
public final Builder steps(RecipeStep... steps) {
steps(Arrays.asList(steps));
return this;
}
@Override
@SafeVarargs
public final Builder steps(Consumer... steps) {
steps(Stream.of(steps).map(c -> RecipeStep.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateRecipeRequest build() {
return new CreateRecipeRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}