software.amazon.awssdk.services.ses.model.BulkEmailDestinationStatus Maven / Gradle / Ivy
Show all versions of ses 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.ses.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;
/**
*
* An object that contains the response from the SendBulkTemplatedEmail operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BulkEmailDestinationStatus implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(BulkEmailDestinationStatus::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField ERROR_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(BulkEmailDestinationStatus::error)).setter(setter(Builder::error))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Error").build()).build();
private static final SdkField MESSAGE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(BulkEmailDestinationStatus::messageId)).setter(setter(Builder::messageId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessageId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATUS_FIELD, ERROR_FIELD,
MESSAGE_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String status;
private final String error;
private final String messageId;
private BulkEmailDestinationStatus(BuilderImpl builder) {
this.status = builder.status;
this.error = builder.error;
this.messageId = builder.messageId;
}
/**
*
* The status of a message sent using the SendBulkTemplatedEmail operation.
*
*
* Possible values for this parameter include:
*
*
* -
*
* Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
*
*
* -
*
* MessageRejected: The message was rejected because it contained a virus.
*
*
* -
*
* MailFromDomainNotVerified: The sender's email address or domain was not verified.
*
*
* -
*
* ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
*
*
* -
*
* TemplateDoesNotExist: The template you specified does not exist.
*
*
* -
*
* AccountSuspended: Your account has been shut down because of issues related to your email sending
* practices.
*
*
* -
*
* AccountThrottled: The number of emails you can send has been reduced because your account has
* exceeded its allocated sending limit.
*
*
* -
*
* AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send
* from your account in a 24-hour period.
*
*
* -
*
* InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not
* exist.
*
*
* -
*
* AccountSendingPaused: Email sending for the Amazon SES account was disabled using the
* UpdateAccountSendingEnabled operation.
*
*
* -
*
* ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the
* UpdateConfigurationSetSendingEnabled operation.
*
*
* -
*
* InvalidParameterValue: One or more of the parameters you specified when calling this operation was
* invalid. See the error message for additional information.
*
*
* -
*
* TransientFailure: Amazon SES was unable to process your request because of a temporary issue.
*
*
* -
*
* Failed: Amazon SES was unable to process your request. See the error message for additional
* information.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link BulkEmailStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of a message sent using the SendBulkTemplatedEmail operation.
*
* Possible values for this parameter include:
*
*
* -
*
* Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
*
*
* -
*
* MessageRejected: The message was rejected because it contained a virus.
*
*
* -
*
* MailFromDomainNotVerified: The sender's email address or domain was not verified.
*
*
* -
*
* ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
*
*
* -
*
* TemplateDoesNotExist: The template you specified does not exist.
*
*
* -
*
* AccountSuspended: Your account has been shut down because of issues related to your email
* sending practices.
*
*
* -
*
* AccountThrottled: The number of emails you can send has been reduced because your account
* has exceeded its allocated sending limit.
*
*
* -
*
* AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can
* send from your account in a 24-hour period.
*
*
* -
*
* InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does
* not exist.
*
*
* -
*
* AccountSendingPaused: Email sending for the Amazon SES account was disabled using the
* UpdateAccountSendingEnabled operation.
*
*
* -
*
* ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using
* the UpdateConfigurationSetSendingEnabled operation.
*
*
* -
*
* InvalidParameterValue: One or more of the parameters you specified when calling this
* operation was invalid. See the error message for additional information.
*
*
* -
*
* TransientFailure: Amazon SES was unable to process your request because of a temporary
* issue.
*
*
* -
*
* Failed: Amazon SES was unable to process your request. See the error message for additional
* information.
*
*
* @see BulkEmailStatus
*/
public BulkEmailStatus status() {
return BulkEmailStatus.fromValue(status);
}
/**
*
* The status of a message sent using the SendBulkTemplatedEmail operation.
*
*
* Possible values for this parameter include:
*
*
* -
*
* Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
*
*
* -
*
* MessageRejected: The message was rejected because it contained a virus.
*
*
* -
*
* MailFromDomainNotVerified: The sender's email address or domain was not verified.
*
*
* -
*
* ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
*
*
* -
*
* TemplateDoesNotExist: The template you specified does not exist.
*
*
* -
*
* AccountSuspended: Your account has been shut down because of issues related to your email sending
* practices.
*
*
* -
*
* AccountThrottled: The number of emails you can send has been reduced because your account has
* exceeded its allocated sending limit.
*
*
* -
*
* AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send
* from your account in a 24-hour period.
*
*
* -
*
* InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not
* exist.
*
*
* -
*
* AccountSendingPaused: Email sending for the Amazon SES account was disabled using the
* UpdateAccountSendingEnabled operation.
*
*
* -
*
* ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the
* UpdateConfigurationSetSendingEnabled operation.
*
*
* -
*
* InvalidParameterValue: One or more of the parameters you specified when calling this operation was
* invalid. See the error message for additional information.
*
*
* -
*
* TransientFailure: Amazon SES was unable to process your request because of a temporary issue.
*
*
* -
*
* Failed: Amazon SES was unable to process your request. See the error message for additional
* information.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link BulkEmailStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of a message sent using the SendBulkTemplatedEmail operation.
*
* Possible values for this parameter include:
*
*
* -
*
* Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
*
*
* -
*
* MessageRejected: The message was rejected because it contained a virus.
*
*
* -
*
* MailFromDomainNotVerified: The sender's email address or domain was not verified.
*
*
* -
*
* ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
*
*
* -
*
* TemplateDoesNotExist: The template you specified does not exist.
*
*
* -
*
* AccountSuspended: Your account has been shut down because of issues related to your email
* sending practices.
*
*
* -
*
* AccountThrottled: The number of emails you can send has been reduced because your account
* has exceeded its allocated sending limit.
*
*
* -
*
* AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can
* send from your account in a 24-hour period.
*
*
* -
*
* InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does
* not exist.
*
*
* -
*
* AccountSendingPaused: Email sending for the Amazon SES account was disabled using the
* UpdateAccountSendingEnabled operation.
*
*
* -
*
* ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using
* the UpdateConfigurationSetSendingEnabled operation.
*
*
* -
*
* InvalidParameterValue: One or more of the parameters you specified when calling this
* operation was invalid. See the error message for additional information.
*
*
* -
*
* TransientFailure: Amazon SES was unable to process your request because of a temporary
* issue.
*
*
* -
*
* Failed: Amazon SES was unable to process your request. See the error message for additional
* information.
*
*
* @see BulkEmailStatus
*/
public String statusAsString() {
return status;
}
/**
*
* A description of an error that prevented a message being sent using the SendBulkTemplatedEmail
* operation.
*
*
* @return A description of an error that prevented a message being sent using the
* SendBulkTemplatedEmail operation.
*/
public String error() {
return error;
}
/**
*
* The unique message identifier returned from the SendBulkTemplatedEmail operation.
*
*
* @return The unique message identifier returned from the SendBulkTemplatedEmail operation.
*/
public String messageId() {
return messageId;
}
@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(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(error());
hashCode = 31 * hashCode + Objects.hashCode(messageId());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof BulkEmailDestinationStatus)) {
return false;
}
BulkEmailDestinationStatus other = (BulkEmailDestinationStatus) obj;
return Objects.equals(statusAsString(), other.statusAsString()) && Objects.equals(error(), other.error())
&& Objects.equals(messageId(), other.messageId());
}
/**
* 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("BulkEmailDestinationStatus").add("Status", statusAsString()).add("Error", error())
.add("MessageId", messageId()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "Error":
return Optional.ofNullable(clazz.cast(error()));
case "MessageId":
return Optional.ofNullable(clazz.cast(messageId()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BulkEmailDestinationStatus) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The status of a message sent using the SendBulkTemplatedEmail operation.
*
*
* Possible values for this parameter include:
*
*
* -
*
* Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
*
*
* -
*
* MessageRejected: The message was rejected because it contained a virus.
*
*
* -
*
* MailFromDomainNotVerified: The sender's email address or domain was not verified.
*
*
* -
*
* ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
*
*
* -
*
* TemplateDoesNotExist: The template you specified does not exist.
*
*
* -
*
* AccountSuspended: Your account has been shut down because of issues related to your email
* sending practices.
*
*
* -
*
* AccountThrottled: The number of emails you can send has been reduced because your account has
* exceeded its allocated sending limit.
*
*
* -
*
* AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can
* send from your account in a 24-hour period.
*
*
* -
*
* InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not
* exist.
*
*
* -
*
* AccountSendingPaused: Email sending for the Amazon SES account was disabled using the
* UpdateAccountSendingEnabled operation.
*
*
* -
*
* ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the
* UpdateConfigurationSetSendingEnabled operation.
*
*
* -
*
* InvalidParameterValue: One or more of the parameters you specified when calling this operation
* was invalid. See the error message for additional information.
*
*
* -
*
* TransientFailure: Amazon SES was unable to process your request because of a temporary issue.
*
*
* -
*
* Failed: Amazon SES was unable to process your request. See the error message for additional
* information.
*
*
*
*
* @param status
* The status of a message sent using the SendBulkTemplatedEmail operation.
*
* Possible values for this parameter include:
*
*
* -
*
* Success: Amazon SES accepted the message, and will attempt to deliver it to the
* recipients.
*
*
* -
*
* MessageRejected: The message was rejected because it contained a virus.
*
*
* -
*
* MailFromDomainNotVerified: The sender's email address or domain was not verified.
*
*
* -
*
* ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
*
*
* -
*
* TemplateDoesNotExist: The template you specified does not exist.
*
*
* -
*
* AccountSuspended: Your account has been shut down because of issues related to your email
* sending practices.
*
*
* -
*
* AccountThrottled: The number of emails you can send has been reduced because your account
* has exceeded its allocated sending limit.
*
*
* -
*
* AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you
* can send from your account in a 24-hour period.
*
*
* -
*
* InvalidSendingPoolName: The configuration set you specified refers to an IP pool that
* does not exist.
*
*
* -
*
* AccountSendingPaused: Email sending for the Amazon SES account was disabled using the
* UpdateAccountSendingEnabled operation.
*
*
* -
*
* ConfigurationSetSendingPaused: Email sending for this configuration set was disabled
* using the UpdateConfigurationSetSendingEnabled operation.
*
*
* -
*
* InvalidParameterValue: One or more of the parameters you specified when calling this
* operation was invalid. See the error message for additional information.
*
*
* -
*
* TransientFailure: Amazon SES was unable to process your request because of a temporary
* issue.
*
*
* -
*
* Failed: Amazon SES was unable to process your request. See the error message for
* additional information.
*
*
* @see BulkEmailStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see BulkEmailStatus
*/
Builder status(String status);
/**
*
* The status of a message sent using the SendBulkTemplatedEmail operation.
*
*
* Possible values for this parameter include:
*
*
* -
*
* Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
*
*
* -
*
* MessageRejected: The message was rejected because it contained a virus.
*
*
* -
*
* MailFromDomainNotVerified: The sender's email address or domain was not verified.
*
*
* -
*
* ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
*
*
* -
*
* TemplateDoesNotExist: The template you specified does not exist.
*
*
* -
*
* AccountSuspended: Your account has been shut down because of issues related to your email
* sending practices.
*
*
* -
*
* AccountThrottled: The number of emails you can send has been reduced because your account has
* exceeded its allocated sending limit.
*
*
* -
*
* AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can
* send from your account in a 24-hour period.
*
*
* -
*
* InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not
* exist.
*
*
* -
*
* AccountSendingPaused: Email sending for the Amazon SES account was disabled using the
* UpdateAccountSendingEnabled operation.
*
*
* -
*
* ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the
* UpdateConfigurationSetSendingEnabled operation.
*
*
* -
*
* InvalidParameterValue: One or more of the parameters you specified when calling this operation
* was invalid. See the error message for additional information.
*
*
* -
*
* TransientFailure: Amazon SES was unable to process your request because of a temporary issue.
*
*
* -
*
* Failed: Amazon SES was unable to process your request. See the error message for additional
* information.
*
*
*
*
* @param status
* The status of a message sent using the SendBulkTemplatedEmail operation.
*
* Possible values for this parameter include:
*
*
* -
*
* Success: Amazon SES accepted the message, and will attempt to deliver it to the
* recipients.
*
*
* -
*
* MessageRejected: The message was rejected because it contained a virus.
*
*
* -
*
* MailFromDomainNotVerified: The sender's email address or domain was not verified.
*
*
* -
*
* ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
*
*
* -
*
* TemplateDoesNotExist: The template you specified does not exist.
*
*
* -
*
* AccountSuspended: Your account has been shut down because of issues related to your email
* sending practices.
*
*
* -
*
* AccountThrottled: The number of emails you can send has been reduced because your account
* has exceeded its allocated sending limit.
*
*
* -
*
* AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you
* can send from your account in a 24-hour period.
*
*
* -
*
* InvalidSendingPoolName: The configuration set you specified refers to an IP pool that
* does not exist.
*
*
* -
*
* AccountSendingPaused: Email sending for the Amazon SES account was disabled using the
* UpdateAccountSendingEnabled operation.
*
*
* -
*
* ConfigurationSetSendingPaused: Email sending for this configuration set was disabled
* using the UpdateConfigurationSetSendingEnabled operation.
*
*
* -
*
* InvalidParameterValue: One or more of the parameters you specified when calling this
* operation was invalid. See the error message for additional information.
*
*
* -
*
* TransientFailure: Amazon SES was unable to process your request because of a temporary
* issue.
*
*
* -
*
* Failed: Amazon SES was unable to process your request. See the error message for
* additional information.
*
*
* @see BulkEmailStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see BulkEmailStatus
*/
Builder status(BulkEmailStatus status);
/**
*
* A description of an error that prevented a message being sent using the SendBulkTemplatedEmail
* operation.
*
*
* @param error
* A description of an error that prevented a message being sent using the
* SendBulkTemplatedEmail operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder error(String error);
/**
*
* The unique message identifier returned from the SendBulkTemplatedEmail operation.
*
*
* @param messageId
* The unique message identifier returned from the SendBulkTemplatedEmail operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messageId(String messageId);
}
static final class BuilderImpl implements Builder {
private String status;
private String error;
private String messageId;
private BuilderImpl() {
}
private BuilderImpl(BulkEmailDestinationStatus model) {
status(model.status);
error(model.error);
messageId(model.messageId);
}
public final String getStatus() {
return status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(BulkEmailStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final void setStatus(String status) {
this.status = status;
}
public final String getError() {
return error;
}
@Override
public final Builder error(String error) {
this.error = error;
return this;
}
public final void setError(String error) {
this.error = error;
}
public final String getMessageId() {
return messageId;
}
@Override
public final Builder messageId(String messageId) {
this.messageId = messageId;
return this;
}
public final void setMessageId(String messageId) {
this.messageId = messageId;
}
@Override
public BulkEmailDestinationStatus build() {
return new BulkEmailDestinationStatus(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}