software.amazon.awssdk.services.personalize.model.MetricAttribute 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.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;
/**
*
* Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of
* recommendations.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MetricAttribute implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField EVENT_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("eventType").getter(getter(MetricAttribute::eventType)).setter(setter(Builder::eventType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("eventType").build()).build();
private static final SdkField METRIC_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("metricName").getter(getter(MetricAttribute::metricName)).setter(setter(Builder::metricName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metricName").build()).build();
private static final SdkField EXPRESSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("expression").getter(getter(MetricAttribute::expression)).setter(setter(Builder::expression))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("expression").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(EVENT_TYPE_FIELD,
METRIC_NAME_FIELD, EXPRESSION_FIELD));
private static final long serialVersionUID = 1L;
private final String eventType;
private final String metricName;
private final String expression;
private MetricAttribute(BuilderImpl builder) {
this.eventType = builder.eventType;
this.metricName = builder.metricName;
this.expression = builder.expression;
}
/**
*
* The metric's event type.
*
*
* @return The metric's event type.
*/
public final String eventType() {
return eventType;
}
/**
*
* The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
*
*
* @return The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
*/
public final String metricName() {
return metricName;
}
/**
*
* The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM()
* functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example
* SUM(Items.PRICE).
*
*
* @return The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For
* SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a
* parameter. For example SUM(Items.PRICE).
*/
public final String expression() {
return expression;
}
@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(eventType());
hashCode = 31 * hashCode + Objects.hashCode(metricName());
hashCode = 31 * hashCode + Objects.hashCode(expression());
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 MetricAttribute)) {
return false;
}
MetricAttribute other = (MetricAttribute) obj;
return Objects.equals(eventType(), other.eventType()) && Objects.equals(metricName(), other.metricName())
&& Objects.equals(expression(), other.expression());
}
/**
* 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("MetricAttribute").add("EventType", eventType()).add("MetricName", metricName())
.add("Expression", expression()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "eventType":
return Optional.ofNullable(clazz.cast(eventType()));
case "metricName":
return Optional.ofNullable(clazz.cast(metricName()));
case "expression":
return Optional.ofNullable(clazz.cast(expression()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MetricAttribute) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The metric's event type.
*
*
* @param eventType
* The metric's event type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventType(String eventType);
/**
*
* The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
*
*
* @param metricName
* The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricName(String metricName);
/**
*
* The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For
* SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter.
* For example SUM(Items.PRICE).
*
*
* @param expression
* The attribute's expression. Available functions are SUM() or SAMPLECOUNT().
* For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a
* parameter. For example SUM(Items.PRICE).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expression(String expression);
}
static final class BuilderImpl implements Builder {
private String eventType;
private String metricName;
private String expression;
private BuilderImpl() {
}
private BuilderImpl(MetricAttribute model) {
eventType(model.eventType);
metricName(model.metricName);
expression(model.expression);
}
public final String getEventType() {
return eventType;
}
public final void setEventType(String eventType) {
this.eventType = eventType;
}
@Override
public final Builder eventType(String eventType) {
this.eventType = eventType;
return this;
}
public final String getMetricName() {
return metricName;
}
public final void setMetricName(String metricName) {
this.metricName = metricName;
}
@Override
public final Builder metricName(String metricName) {
this.metricName = metricName;
return this;
}
public final String getExpression() {
return expression;
}
public final void setExpression(String expression) {
this.expression = expression;
}
@Override
public final Builder expression(String expression) {
this.expression = expression;
return this;
}
@Override
public MetricAttribute build() {
return new MetricAttribute(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}