software.amazon.awssdk.services.personalizeevents.model.PutEventsRequest Maven / Gradle / Ivy
Show all versions of personalizeevents Show documentation
/*
* 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.personalizeevents.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 PutEventsRequest extends PersonalizeEventsRequest implements
ToCopyableBuilder {
private static final SdkField TRACKING_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("trackingId").getter(getter(PutEventsRequest::trackingId)).setter(setter(Builder::trackingId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("trackingId").build()).build();
private static final SdkField USER_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("userId")
.getter(getter(PutEventsRequest::userId)).setter(setter(Builder::userId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("userId").build()).build();
private static final SdkField SESSION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("sessionId").getter(getter(PutEventsRequest::sessionId)).setter(setter(Builder::sessionId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("sessionId").build()).build();
private static final SdkField> EVENT_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("eventList")
.getter(getter(PutEventsRequest::eventList))
.setter(setter(Builder::eventList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("eventList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Event::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TRACKING_ID_FIELD,
USER_ID_FIELD, SESSION_ID_FIELD, EVENT_LIST_FIELD));
private final String trackingId;
private final String userId;
private final String sessionId;
private final List eventList;
private PutEventsRequest(BuilderImpl builder) {
super(builder);
this.trackingId = builder.trackingId;
this.userId = builder.userId;
this.sessionId = builder.sessionId;
this.eventList = builder.eventList;
}
/**
*
* The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.
*
*
* @return The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.
*/
public final String trackingId() {
return trackingId;
}
/**
*
* The user associated with the event.
*
*
* @return The user associated with the event.
*/
public final String userId() {
return userId;
}
/**
*
* The session ID associated with the user's visit. Your application generates the sessionId when a user first
* visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the
* user before they log in. For more information, see Recording item
* interaction events.
*
*
* @return The session ID associated with the user's visit. Your application generates the sessionId when a user
* first visits your website or uses your application. Amazon Personalize uses the sessionId to associate
* events with the user before they log in. For more information, see Recording
* item interaction events.
*/
public final String sessionId() {
return sessionId;
}
/**
* For responses, this returns true if the service returned a value for the EventList 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 hasEventList() {
return eventList != null && !(eventList instanceof SdkAutoConstructList);
}
/**
*
* A list of event data from the session.
*
*
* 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 #hasEventList} method.
*
*
* @return A list of event data from the session.
*/
public final List eventList() {
return eventList;
}
@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(trackingId());
hashCode = 31 * hashCode + Objects.hashCode(userId());
hashCode = 31 * hashCode + Objects.hashCode(sessionId());
hashCode = 31 * hashCode + Objects.hashCode(hasEventList() ? eventList() : 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 PutEventsRequest)) {
return false;
}
PutEventsRequest other = (PutEventsRequest) obj;
return Objects.equals(trackingId(), other.trackingId()) && Objects.equals(userId(), other.userId())
&& Objects.equals(sessionId(), other.sessionId()) && hasEventList() == other.hasEventList()
&& Objects.equals(eventList(), other.eventList());
}
/**
* 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("PutEventsRequest").add("TrackingId", trackingId())
.add("UserId", userId() == null ? null : "*** Sensitive Data Redacted ***").add("SessionId", sessionId())
.add("EventList", eventList() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "trackingId":
return Optional.ofNullable(clazz.cast(trackingId()));
case "userId":
return Optional.ofNullable(clazz.cast(userId()));
case "sessionId":
return Optional.ofNullable(clazz.cast(sessionId()));
case "eventList":
return Optional.ofNullable(clazz.cast(eventList()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutEventsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PersonalizeEventsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The tracking ID for the event. The ID is generated by a call to the CreateEventTracker
* API.
*
*
* @param trackingId
* The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trackingId(String trackingId);
/**
*
* The user associated with the event.
*
*
* @param userId
* The user associated with the event.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userId(String userId);
/**
*
* The session ID associated with the user's visit. Your application generates the sessionId when a user first
* visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with
* the user before they log in. For more information, see Recording
* item interaction events.
*
*
* @param sessionId
* The session ID associated with the user's visit. Your application generates the sessionId when a user
* first visits your website or uses your application. Amazon Personalize uses the sessionId to associate
* events with the user before they log in. For more information, see Recording item interaction events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sessionId(String sessionId);
/**
*
* A list of event data from the session.
*
*
* @param eventList
* A list of event data from the session.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventList(Collection eventList);
/**
*
* A list of event data from the session.
*
*
* @param eventList
* A list of event data from the session.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventList(Event... eventList);
/**
*
* A list of event data from the session.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.personalizeevents.model.Event.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.personalizeevents.model.Event#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.personalizeevents.model.Event.Builder#build()} is called immediately
* and its result is passed to {@link #eventList(List)}.
*
* @param eventList
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.personalizeevents.model.Event.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #eventList(java.util.Collection)
*/
Builder eventList(Consumer... eventList);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends PersonalizeEventsRequest.BuilderImpl implements Builder {
private String trackingId;
private String userId;
private String sessionId;
private List eventList = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PutEventsRequest model) {
super(model);
trackingId(model.trackingId);
userId(model.userId);
sessionId(model.sessionId);
eventList(model.eventList);
}
public final String getTrackingId() {
return trackingId;
}
public final void setTrackingId(String trackingId) {
this.trackingId = trackingId;
}
@Override
public final Builder trackingId(String trackingId) {
this.trackingId = trackingId;
return this;
}
public final String getUserId() {
return userId;
}
public final void setUserId(String userId) {
this.userId = userId;
}
@Override
public final Builder userId(String userId) {
this.userId = userId;
return this;
}
public final String getSessionId() {
return sessionId;
}
public final void setSessionId(String sessionId) {
this.sessionId = sessionId;
}
@Override
public final Builder sessionId(String sessionId) {
this.sessionId = sessionId;
return this;
}
public final List getEventList() {
List result = EventListCopier.copyToBuilder(this.eventList);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setEventList(Collection eventList) {
this.eventList = EventListCopier.copyFromBuilder(eventList);
}
@Override
public final Builder eventList(Collection eventList) {
this.eventList = EventListCopier.copy(eventList);
return this;
}
@Override
@SafeVarargs
public final Builder eventList(Event... eventList) {
eventList(Arrays.asList(eventList));
return this;
}
@Override
@SafeVarargs
public final Builder eventList(Consumer... eventList) {
eventList(Stream.of(eventList).map(c -> Event.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 PutEventsRequest build() {
return new PutEventsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}