software.amazon.awssdk.services.pinpointemail.model.PutEmailIdentityFeedbackAttributesRequest Maven / Gradle / Ivy
Show all versions of pinpointemail 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.pinpointemail.model;
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.Consumer;
import java.util.function.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A request to set the attributes that control how bounce and complaint events are processed.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutEmailIdentityFeedbackAttributesRequest extends PinpointEmailRequest implements
ToCopyableBuilder {
private static final SdkField EMAIL_IDENTITY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EmailIdentity").getter(getter(PutEmailIdentityFeedbackAttributesRequest::emailIdentity))
.setter(setter(Builder::emailIdentity))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("EmailIdentity").build()).build();
private static final SdkField EMAIL_FORWARDING_ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("EmailForwardingEnabled")
.getter(getter(PutEmailIdentityFeedbackAttributesRequest::emailForwardingEnabled))
.setter(setter(Builder::emailForwardingEnabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EmailForwardingEnabled").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(EMAIL_IDENTITY_FIELD,
EMAIL_FORWARDING_ENABLED_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("EmailIdentity", EMAIL_IDENTITY_FIELD);
put("EmailForwardingEnabled", EMAIL_FORWARDING_ENABLED_FIELD);
}
});
private final String emailIdentity;
private final Boolean emailForwardingEnabled;
private PutEmailIdentityFeedbackAttributesRequest(BuilderImpl builder) {
super(builder);
this.emailIdentity = builder.emailIdentity;
this.emailForwardingEnabled = builder.emailForwardingEnabled;
}
/**
*
* The email identity that you want to configure bounce and complaint feedback forwarding for.
*
*
* @return The email identity that you want to configure bounce and complaint feedback forwarding for.
*/
public final String emailIdentity() {
return emailIdentity;
}
/**
*
* Sets the feedback forwarding configuration for the identity.
*
*
* If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events
* occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the
* original email.
*
*
* When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such
* as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking
* bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications,
* Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).
*
*
* @return Sets the feedback forwarding configuration for the identity.
*
* If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint
* events occur. Amazon Pinpoint sends this notification to the address that you specified in the
* Return-Path header of the original email.
*
*
* When you set this value to false, Amazon Pinpoint sends notifications through other
* mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to
* have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving
* bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur
* (even if this setting is disabled).
*/
public final Boolean emailForwardingEnabled() {
return emailForwardingEnabled;
}
@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(emailIdentity());
hashCode = 31 * hashCode + Objects.hashCode(emailForwardingEnabled());
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 PutEmailIdentityFeedbackAttributesRequest)) {
return false;
}
PutEmailIdentityFeedbackAttributesRequest other = (PutEmailIdentityFeedbackAttributesRequest) obj;
return Objects.equals(emailIdentity(), other.emailIdentity())
&& Objects.equals(emailForwardingEnabled(), other.emailForwardingEnabled());
}
/**
* 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("PutEmailIdentityFeedbackAttributesRequest").add("EmailIdentity", emailIdentity())
.add("EmailForwardingEnabled", emailForwardingEnabled()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EmailIdentity":
return Optional.ofNullable(clazz.cast(emailIdentity()));
case "EmailForwardingEnabled":
return Optional.ofNullable(clazz.cast(emailForwardingEnabled()));
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((PutEmailIdentityFeedbackAttributesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PinpointEmailRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The email identity that you want to configure bounce and complaint feedback forwarding for.
*
*
* @param emailIdentity
* The email identity that you want to configure bounce and complaint feedback forwarding for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder emailIdentity(String emailIdentity);
/**
*
* Sets the feedback forwarding configuration for the identity.
*
*
* If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint
* events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path
* header of the original email.
*
*
* When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms,
* such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of
* tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint
* notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is
* disabled).
*
*
* @param emailForwardingEnabled
* Sets the feedback forwarding configuration for the identity.
*
* If the value is true, Amazon Pinpoint sends you email notifications when bounce or
* complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in
* the Return-Path header of the original email.
*
*
* When you set this value to false, Amazon Pinpoint sends notifications through other
* mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to
* have a method of tracking bounces and complaints. If you haven't set up another mechanism for
* receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these
* events occur (even if this setting is disabled).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder emailForwardingEnabled(Boolean emailForwardingEnabled);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends PinpointEmailRequest.BuilderImpl implements Builder {
private String emailIdentity;
private Boolean emailForwardingEnabled;
private BuilderImpl() {
}
private BuilderImpl(PutEmailIdentityFeedbackAttributesRequest model) {
super(model);
emailIdentity(model.emailIdentity);
emailForwardingEnabled(model.emailForwardingEnabled);
}
public final String getEmailIdentity() {
return emailIdentity;
}
public final void setEmailIdentity(String emailIdentity) {
this.emailIdentity = emailIdentity;
}
@Override
public final Builder emailIdentity(String emailIdentity) {
this.emailIdentity = emailIdentity;
return this;
}
public final Boolean getEmailForwardingEnabled() {
return emailForwardingEnabled;
}
public final void setEmailForwardingEnabled(Boolean emailForwardingEnabled) {
this.emailForwardingEnabled = emailForwardingEnabled;
}
@Override
public final Builder emailForwardingEnabled(Boolean emailForwardingEnabled) {
this.emailForwardingEnabled = emailForwardingEnabled;
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 PutEmailIdentityFeedbackAttributesRequest build() {
return new PutEmailIdentityFeedbackAttributesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}