software.amazon.awssdk.services.personalize.model.BatchInferenceJobConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of personalize Show documentation
Show all versions of personalize Show documentation
The AWS Java SDK for Personalize module holds the client classes that are used for
communicating with Personalize.
/*
* 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.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.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 configuration details of a batch inference job.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BatchInferenceJobConfig implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> ITEM_EXPLORATION_CONFIG_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("itemExplorationConfig")
.getter(getter(BatchInferenceJobConfig::itemExplorationConfig))
.setter(setter(Builder::itemExplorationConfig))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("itemExplorationConfig").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(ITEM_EXPLORATION_CONFIG_FIELD));
private static final long serialVersionUID = 1L;
private final Map itemExplorationConfig;
private BatchInferenceJobConfig(BuilderImpl builder) {
this.itemExplorationConfig = builder.itemExplorationConfig;
}
/**
* For responses, this returns true if the service returned a value for the ItemExplorationConfig 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 hasItemExplorationConfig() {
return itemExplorationConfig != null && !(itemExplorationConfig instanceof SdkAutoConstructMap);
}
/**
*
* A string to string map specifying the exploration configuration hyperparameters, including
* explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount
* of item exploration Amazon Personalize uses when recommending items. See User-Personalization.
*
*
* 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 #hasItemExplorationConfig} method.
*
*
* @return A string to string map specifying the exploration configuration hyperparameters, including
* explorationWeight and explorationItemAgeCutOff, you want to use to configure
* the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.
*/
public final Map itemExplorationConfig() {
return itemExplorationConfig;
}
@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(hasItemExplorationConfig() ? itemExplorationConfig() : 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 BatchInferenceJobConfig)) {
return false;
}
BatchInferenceJobConfig other = (BatchInferenceJobConfig) obj;
return hasItemExplorationConfig() == other.hasItemExplorationConfig()
&& Objects.equals(itemExplorationConfig(), other.itemExplorationConfig());
}
/**
* 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("BatchInferenceJobConfig")
.add("ItemExplorationConfig", hasItemExplorationConfig() ? itemExplorationConfig() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "itemExplorationConfig":
return Optional.ofNullable(clazz.cast(itemExplorationConfig()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BatchInferenceJobConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A string to string map specifying the exploration configuration hyperparameters, including
* explorationWeight and explorationItemAgeCutOff, you want to use to configure the
* amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.
*
*
* @param itemExplorationConfig
* A string to string map specifying the exploration configuration hyperparameters, including
* explorationWeight and explorationItemAgeCutOff, you want to use to configure
* the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder itemExplorationConfig(Map itemExplorationConfig);
}
static final class BuilderImpl implements Builder {
private Map itemExplorationConfig = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BatchInferenceJobConfig model) {
itemExplorationConfig(model.itemExplorationConfig);
}
public final Map getItemExplorationConfig() {
if (itemExplorationConfig instanceof SdkAutoConstructMap) {
return null;
}
return itemExplorationConfig;
}
public final void setItemExplorationConfig(Map itemExplorationConfig) {
this.itemExplorationConfig = HyperParametersCopier.copy(itemExplorationConfig);
}
@Override
public final Builder itemExplorationConfig(Map itemExplorationConfig) {
this.itemExplorationConfig = HyperParametersCopier.copy(itemExplorationConfig);
return this;
}
@Override
public BatchInferenceJobConfig build() {
return new BatchInferenceJobConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}