software.amazon.awssdk.services.personalize.model.TrainingDataConfig 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.io.Serializable;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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.DefaultSdkAutoConstructMap;
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;
/**
*
* The training data configuration to use when creating a domain recommender or custom solution version (trained model).
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TrainingDataConfig implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField>> EXCLUDED_DATASET_COLUMNS_FIELD = SdkField
.>> builder(MarshallingType.MAP)
.memberName("excludedDatasetColumns")
.getter(getter(TrainingDataConfig::excludedDatasetColumns))
.setter(setter(Builder::excludedDatasetColumns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("excludedDatasetColumns").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField.> builder(MarshallingType.LIST)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build())
.build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
.asList(EXCLUDED_DATASET_COLUMNS_FIELD));
private static final long serialVersionUID = 1L;
private final Map> excludedDatasetColumns;
private TrainingDataConfig(BuilderImpl builder) {
this.excludedDatasetColumns = builder.excludedDatasetColumns;
}
/**
* For responses, this returns true if the service returned a value for the ExcludedDatasetColumns 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 hasExcludedDatasetColumns() {
return excludedDatasetColumns != null && !(excludedDatasetColumns instanceof SdkAutoConstructMap);
}
/**
*
* Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns.
* Exclude columns to control what data Amazon Personalize uses to generate recommendations.
*
*
* For example, you might have a column that you want to use only to filter recommendations. You can exclude this
* column from training and Amazon Personalize considers it only when filtering.
*
*
* 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 #hasExcludedDatasetColumns} method.
*
*
* @return Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of
* columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.
*
* For example, you might have a column that you want to use only to filter recommendations. You can exclude
* this column from training and Amazon Personalize considers it only when filtering.
*/
public final Map> excludedDatasetColumns() {
return excludedDatasetColumns;
}
@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 + Objects.hashCode(hasExcludedDatasetColumns() ? excludedDatasetColumns() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TrainingDataConfig)) {
return false;
}
TrainingDataConfig other = (TrainingDataConfig) obj;
return hasExcludedDatasetColumns() == other.hasExcludedDatasetColumns()
&& Objects.equals(excludedDatasetColumns(), other.excludedDatasetColumns());
}
/**
* 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("TrainingDataConfig")
.add("ExcludedDatasetColumns", hasExcludedDatasetColumns() ? excludedDatasetColumns() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "excludedDatasetColumns":
return Optional.ofNullable(clazz.cast(excludedDatasetColumns()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TrainingDataConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of
* columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.
*
*
* For example, you might have a column that you want to use only to filter recommendations. You can exclude
* this column from training and Amazon Personalize considers it only when filtering.
*
*
* @param excludedDatasetColumns
* Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list
* of columns. Exclude columns to control what data Amazon Personalize uses to generate
* recommendations.
*
* For example, you might have a column that you want to use only to filter recommendations. You can
* exclude this column from training and Amazon Personalize considers it only when filtering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder excludedDatasetColumns(Map> excludedDatasetColumns);
}
static final class BuilderImpl implements Builder {
private Map> excludedDatasetColumns = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(TrainingDataConfig model) {
excludedDatasetColumns(model.excludedDatasetColumns);
}
public final Map> getExcludedDatasetColumns() {
if (excludedDatasetColumns instanceof SdkAutoConstructMap) {
return null;
}
return excludedDatasetColumns;
}
public final void setExcludedDatasetColumns(Map> excludedDatasetColumns) {
this.excludedDatasetColumns = ExcludedDatasetColumnsCopier.copy(excludedDatasetColumns);
}
@Override
public final Builder excludedDatasetColumns(Map> excludedDatasetColumns) {
this.excludedDatasetColumns = ExcludedDatasetColumnsCopier.copy(excludedDatasetColumns);
return this;
}
@Override
public TrainingDataConfig build() {
return new TrainingDataConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}