software.amazon.awssdk.services.pinpoint.model.EndpointSendConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinpoint Show documentation
Show all versions of pinpoint Show documentation
The AWS Java SDK for Amazon Pinpoint module holds the client classes that are used for communicating
with Amazon Pinpoint Service
/*
* Copyright 2014-2019 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.pinpoint.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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
* Endpoint send configuration.
*/
@Generated("software.amazon.awssdk:codegen")
public final class EndpointSendConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField BODY_OVERRIDE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(EndpointSendConfiguration::bodyOverride)).setter(setter(Builder::bodyOverride))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BodyOverride").build()).build();
private static final SdkField> CONTEXT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.getter(getter(EndpointSendConfiguration::context))
.setter(setter(Builder::context))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Context").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 SdkField RAW_CONTENT_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(EndpointSendConfiguration::rawContent)).setter(setter(Builder::rawContent))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RawContent").build()).build();
private static final SdkField>> SUBSTITUTIONS_FIELD = SdkField
.>> builder(MarshallingType.MAP)
.getter(getter(EndpointSendConfiguration::substitutions))
.setter(setter(Builder::substitutions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Substitutions").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 SdkField TITLE_OVERRIDE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(EndpointSendConfiguration::titleOverride)).setter(setter(Builder::titleOverride))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TitleOverride").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BODY_OVERRIDE_FIELD,
CONTEXT_FIELD, RAW_CONTENT_FIELD, SUBSTITUTIONS_FIELD, TITLE_OVERRIDE_FIELD));
private static final long serialVersionUID = 1L;
private final String bodyOverride;
private final Map context;
private final String rawContent;
private final Map> substitutions;
private final String titleOverride;
private EndpointSendConfiguration(BuilderImpl builder) {
this.bodyOverride = builder.bodyOverride;
this.context = builder.context;
this.rawContent = builder.rawContent;
this.substitutions = builder.substitutions;
this.titleOverride = builder.titleOverride;
}
/**
* Body override. If specified will override default body.
*
* @return Body override. If specified will override default body.
*/
public String bodyOverride() {
return bodyOverride;
}
/**
* A map of custom attributes to attributes to be attached to the message for this address. This payload is added to
* the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A map of custom attributes to attributes to be attached to the message for this address. This payload is
* added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event
* attributes.
*/
public Map context() {
return context;
}
/**
* The Raw JSON formatted string to be used as the payload. This value overrides the message.
*
* @return The Raw JSON formatted string to be used as the payload. This value overrides the message.
*/
public String rawContent() {
return rawContent;
}
/**
* A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions
* on this map take precedence over the all other substitutions.
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A map of substitution values for the message to be merged with the DefaultMessage's substitutions.
* Substitutions on this map take precedence over the all other substitutions.
*/
public Map> substitutions() {
return substitutions;
}
/**
* Title override. If specified will override default title if applicable.
*
* @return Title override. If specified will override default title if applicable.
*/
public String titleOverride() {
return titleOverride;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(bodyOverride());
hashCode = 31 * hashCode + Objects.hashCode(context());
hashCode = 31 * hashCode + Objects.hashCode(rawContent());
hashCode = 31 * hashCode + Objects.hashCode(substitutions());
hashCode = 31 * hashCode + Objects.hashCode(titleOverride());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EndpointSendConfiguration)) {
return false;
}
EndpointSendConfiguration other = (EndpointSendConfiguration) obj;
return Objects.equals(bodyOverride(), other.bodyOverride()) && Objects.equals(context(), other.context())
&& Objects.equals(rawContent(), other.rawContent()) && Objects.equals(substitutions(), other.substitutions())
&& Objects.equals(titleOverride(), other.titleOverride());
}
/**
* 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 String toString() {
return ToString.builder("EndpointSendConfiguration").add("BodyOverride", bodyOverride()).add("Context", context())
.add("RawContent", rawContent()).add("Substitutions", substitutions()).add("TitleOverride", titleOverride())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "BodyOverride":
return Optional.ofNullable(clazz.cast(bodyOverride()));
case "Context":
return Optional.ofNullable(clazz.cast(context()));
case "RawContent":
return Optional.ofNullable(clazz.cast(rawContent()));
case "Substitutions":
return Optional.ofNullable(clazz.cast(substitutions()));
case "TitleOverride":
return Optional.ofNullable(clazz.cast(titleOverride()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((EndpointSendConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* Body override. If specified will override default body.
*
* @param bodyOverride
* Body override. If specified will override default body.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bodyOverride(String bodyOverride);
/**
* A map of custom attributes to attributes to be attached to the message for this address. This payload is
* added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event
* attributes.
*
* @param context
* A map of custom attributes to attributes to be attached to the message for this address. This payload
* is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt
* event attributes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder context(Map context);
/**
* The Raw JSON formatted string to be used as the payload. This value overrides the message.
*
* @param rawContent
* The Raw JSON formatted string to be used as the payload. This value overrides the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rawContent(String rawContent);
/**
* A map of substitution values for the message to be merged with the DefaultMessage's substitutions.
* Substitutions on this map take precedence over the all other substitutions.
*
* @param substitutions
* A map of substitution values for the message to be merged with the DefaultMessage's substitutions.
* Substitutions on this map take precedence over the all other substitutions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder substitutions(Map> substitutions);
/**
* Title override. If specified will override default title if applicable.
*
* @param titleOverride
* Title override. If specified will override default title if applicable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder titleOverride(String titleOverride);
}
static final class BuilderImpl implements Builder {
private String bodyOverride;
private Map context = DefaultSdkAutoConstructMap.getInstance();
private String rawContent;
private Map> substitutions = DefaultSdkAutoConstructMap.getInstance();
private String titleOverride;
private BuilderImpl() {
}
private BuilderImpl(EndpointSendConfiguration model) {
bodyOverride(model.bodyOverride);
context(model.context);
rawContent(model.rawContent);
substitutions(model.substitutions);
titleOverride(model.titleOverride);
}
public final String getBodyOverride() {
return bodyOverride;
}
@Override
public final Builder bodyOverride(String bodyOverride) {
this.bodyOverride = bodyOverride;
return this;
}
public final void setBodyOverride(String bodyOverride) {
this.bodyOverride = bodyOverride;
}
public final Map getContext() {
return context;
}
@Override
public final Builder context(Map context) {
this.context = MapOf__stringCopier.copy(context);
return this;
}
public final void setContext(Map context) {
this.context = MapOf__stringCopier.copy(context);
}
public final String getRawContent() {
return rawContent;
}
@Override
public final Builder rawContent(String rawContent) {
this.rawContent = rawContent;
return this;
}
public final void setRawContent(String rawContent) {
this.rawContent = rawContent;
}
public final Map> getSubstitutions() {
return substitutions;
}
@Override
public final Builder substitutions(Map> substitutions) {
this.substitutions = MapOfListOf__stringCopier.copy(substitutions);
return this;
}
public final void setSubstitutions(Map> substitutions) {
this.substitutions = MapOfListOf__stringCopier.copy(substitutions);
}
public final String getTitleOverride() {
return titleOverride;
}
@Override
public final Builder titleOverride(String titleOverride) {
this.titleOverride = titleOverride;
return this;
}
public final void setTitleOverride(String titleOverride) {
this.titleOverride = titleOverride;
}
@Override
public EndpointSendConfiguration build() {
return new EndpointSendConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}