software.amazon.awssdk.services.personalizeruntime.model.PredictedAction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of personalizeruntime Show documentation
Show all versions of personalizeruntime Show documentation
The AWS Java SDK for Personalize Runtime module holds the client classes that are used for
communicating with Personalize Runtime.
/*
* 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.personalizeruntime.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* An object that identifies an action.
*
*
* The API returns a list of PredictedActions.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PredictedAction implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ACTION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("actionId").getter(getter(PredictedAction::actionId)).setter(setter(Builder::actionId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("actionId").build()).build();
private static final SdkField SCORE_FIELD = SdkField. builder(MarshallingType.DOUBLE).memberName("score")
.getter(getter(PredictedAction::score)).setter(setter(Builder::score))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("score").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACTION_ID_FIELD, SCORE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("actionId", ACTION_ID_FIELD);
put("score", SCORE_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String actionId;
private final Double score;
private PredictedAction(BuilderImpl builder) {
this.actionId = builder.actionId;
this.score = builder.score;
}
/**
*
* The ID of the recommended action.
*
*
* @return The ID of the recommended action.
*/
public final String actionId() {
return actionId;
}
/**
*
* The score of the recommended action. For information about action scores, see How action
* recommendation scoring works.
*
*
* @return The score of the recommended action. For information about action scores, see How
* action recommendation scoring works.
*/
public final Double score() {
return score;
}
@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(actionId());
hashCode = 31 * hashCode + Objects.hashCode(score());
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 PredictedAction)) {
return false;
}
PredictedAction other = (PredictedAction) obj;
return Objects.equals(actionId(), other.actionId()) && Objects.equals(score(), other.score());
}
/**
* 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("PredictedAction").add("ActionId", actionId()).add("Score", score()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "actionId":
return Optional.ofNullable(clazz.cast(actionId()));
case "score":
return Optional.ofNullable(clazz.cast(score()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((PredictedAction) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ID of the recommended action.
*
*
* @param actionId
* The ID of the recommended action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actionId(String actionId);
/**
*
* The score of the recommended action. For information about action scores, see How
* action recommendation scoring works.
*
*
* @param score
* The score of the recommended action. For information about action scores, see How
* action recommendation scoring works.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder score(Double score);
}
static final class BuilderImpl implements Builder {
private String actionId;
private Double score;
private BuilderImpl() {
}
private BuilderImpl(PredictedAction model) {
actionId(model.actionId);
score(model.score);
}
public final String getActionId() {
return actionId;
}
public final void setActionId(String actionId) {
this.actionId = actionId;
}
@Override
public final Builder actionId(String actionId) {
this.actionId = actionId;
return this;
}
public final Double getScore() {
return score;
}
public final void setScore(Double score) {
this.score = score;
}
@Override
public final Builder score(Double score) {
this.score = score;
return this;
}
@Override
public PredictedAction build() {
return new PredictedAction(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}