software.amazon.awssdk.services.personalize.model.CreateSolutionVersionRequest Maven / Gradle / Ivy
/*
* 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.personalize.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
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.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 CreateSolutionVersionRequest extends PersonalizeRequest implements
ToCopyableBuilder {
private static final SdkField SOLUTION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("solutionArn").getter(getter(CreateSolutionVersionRequest::solutionArn))
.setter(setter(Builder::solutionArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("solutionArn").build()).build();
private static final SdkField TRAINING_MODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("trainingMode").getter(getter(CreateSolutionVersionRequest::trainingModeAsString))
.setter(setter(Builder::trainingMode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("trainingMode").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateSolutionVersionRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SOLUTION_ARN_FIELD,
TRAINING_MODE_FIELD, TAGS_FIELD));
private final String solutionArn;
private final String trainingMode;
private final List tags;
private CreateSolutionVersionRequest(BuilderImpl builder) {
super(builder);
this.solutionArn = builder.solutionArn;
this.trainingMode = builder.trainingMode;
this.tags = builder.tags;
}
/**
*
* The Amazon Resource Name (ARN) of the solution containing the training configuration information.
*
*
* @return The Amazon Resource Name (ARN) of the solution containing the training configuration information.
*/
public final String solutionArn() {
return solutionArn;
}
/**
*
* The scope of training to be performed when creating the solution version. The FULL option trains the
* solution version based on the entirety of the input solution's training data, while the UPDATE
* option processes only the data that has changed in comparison to the input solution. Choose UPDATE
* when you want to incrementally update your solution version instead of creating an entirely new one.
*
*
*
* The UPDATE option can only be used when you already have an active solution version created from the
* input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart
* recipe.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #trainingMode} will
* return {@link TrainingMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #trainingModeAsString}.
*
*
* @return The scope of training to be performed when creating the solution version. The FULL option
* trains the solution version based on the entirety of the input solution's training data, while the
* UPDATE option processes only the data that has changed in comparison to the input solution.
* Choose UPDATE when you want to incrementally update your solution version instead of
* creating an entirely new one.
*
* The UPDATE option can only be used when you already have an active solution version created
* from the input solution using the FULL option and the input solution was trained with the
* User-Personalization recipe or the HRNN-Coldstart recipe.
*
* @see TrainingMode
*/
public final TrainingMode trainingMode() {
return TrainingMode.fromValue(trainingMode);
}
/**
*
* The scope of training to be performed when creating the solution version. The FULL option trains the
* solution version based on the entirety of the input solution's training data, while the UPDATE
* option processes only the data that has changed in comparison to the input solution. Choose UPDATE
* when you want to incrementally update your solution version instead of creating an entirely new one.
*
*
*
* The UPDATE option can only be used when you already have an active solution version created from the
* input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart
* recipe.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #trainingMode} will
* return {@link TrainingMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #trainingModeAsString}.
*
*
* @return The scope of training to be performed when creating the solution version. The FULL option
* trains the solution version based on the entirety of the input solution's training data, while the
* UPDATE option processes only the data that has changed in comparison to the input solution.
* Choose UPDATE when you want to incrementally update your solution version instead of
* creating an entirely new one.
*
* The UPDATE option can only be used when you already have an active solution version created
* from the input solution using the FULL option and the input solution was trained with the
* User-Personalization recipe or the HRNN-Coldstart recipe.
*
* @see TrainingMode
*/
public final String trainingModeAsString() {
return trainingMode;
}
/**
* 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 SdkAutoConstructList);
}
/**
*
* A list of tags to apply
* to the solution version.
*
*
* 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 A list of tags to
* apply to the solution version.
*/
public final List 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(solutionArn());
hashCode = 31 * hashCode + Objects.hashCode(trainingModeAsString());
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 CreateSolutionVersionRequest)) {
return false;
}
CreateSolutionVersionRequest other = (CreateSolutionVersionRequest) obj;
return Objects.equals(solutionArn(), other.solutionArn())
&& Objects.equals(trainingModeAsString(), other.trainingModeAsString()) && 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("CreateSolutionVersionRequest").add("SolutionArn", solutionArn())
.add("TrainingMode", trainingModeAsString()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "solutionArn":
return Optional.ofNullable(clazz.cast(solutionArn()));
case "trainingMode":
return Optional.ofNullable(clazz.cast(trainingModeAsString()));
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((CreateSolutionVersionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PersonalizeRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the solution containing the training configuration information.
*
*
* @param solutionArn
* The Amazon Resource Name (ARN) of the solution containing the training configuration information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder solutionArn(String solutionArn);
/**
*
* The scope of training to be performed when creating the solution version. The FULL option trains
* the solution version based on the entirety of the input solution's training data, while the
* UPDATE option processes only the data that has changed in comparison to the input solution.
* Choose UPDATE when you want to incrementally update your solution version instead of creating an
* entirely new one.
*
*
*
* The UPDATE option can only be used when you already have an active solution version created from
* the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart
* recipe.
*
*
*
* @param trainingMode
* The scope of training to be performed when creating the solution version. The FULL option
* trains the solution version based on the entirety of the input solution's training data, while the
* UPDATE option processes only the data that has changed in comparison to the input
* solution. Choose UPDATE when you want to incrementally update your solution version
* instead of creating an entirely new one.
*
* The UPDATE option can only be used when you already have an active solution version
* created from the input solution using the FULL option and the input solution was trained
* with the User-Personalization recipe or the HRNN-Coldstart recipe.
*
* @see TrainingMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingMode
*/
Builder trainingMode(String trainingMode);
/**
*
* The scope of training to be performed when creating the solution version. The FULL option trains
* the solution version based on the entirety of the input solution's training data, while the
* UPDATE option processes only the data that has changed in comparison to the input solution.
* Choose UPDATE when you want to incrementally update your solution version instead of creating an
* entirely new one.
*
*
*
* The UPDATE option can only be used when you already have an active solution version created from
* the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart
* recipe.
*
*
*
* @param trainingMode
* The scope of training to be performed when creating the solution version. The FULL option
* trains the solution version based on the entirety of the input solution's training data, while the
* UPDATE option processes only the data that has changed in comparison to the input
* solution. Choose UPDATE when you want to incrementally update your solution version
* instead of creating an entirely new one.
*
* The UPDATE option can only be used when you already have an active solution version
* created from the input solution using the FULL option and the input solution was trained
* with the User-Personalization recipe or the HRNN-Coldstart recipe.
*
* @see TrainingMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingMode
*/
Builder trainingMode(TrainingMode trainingMode);
/**
*
* A list of tags to
* apply to the solution version.
*
*
* @param tags
* A list of tags
* to apply to the solution version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags to
* apply to the solution version.
*
*
* @param tags
* A list of tags
* to apply to the solution version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags to
* apply to the solution version.
*
* This is a convenience method that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends PersonalizeRequest.BuilderImpl implements Builder {
private String solutionArn;
private String trainingMode;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateSolutionVersionRequest model) {
super(model);
solutionArn(model.solutionArn);
trainingMode(model.trainingMode);
tags(model.tags);
}
public final String getSolutionArn() {
return solutionArn;
}
public final void setSolutionArn(String solutionArn) {
this.solutionArn = solutionArn;
}
@Override
public final Builder solutionArn(String solutionArn) {
this.solutionArn = solutionArn;
return this;
}
public final String getTrainingMode() {
return trainingMode;
}
public final void setTrainingMode(String trainingMode) {
this.trainingMode = trainingMode;
}
@Override
public final Builder trainingMode(String trainingMode) {
this.trainingMode = trainingMode;
return this;
}
@Override
public final Builder trainingMode(TrainingMode trainingMode) {
this.trainingMode(trainingMode == null ? null : trainingMode.toString());
return this;
}
public final List getTags() {
List result = TagsCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 CreateSolutionVersionRequest build() {
return new CreateSolutionVersionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}