software.amazon.awssdk.services.pinpointemail.model.CreateEmailIdentityRequest 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.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;
/**
*
* A request to begin the verification process for an email identity (an email address or domain).
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateEmailIdentityRequest extends PinpointEmailRequest implements
ToCopyableBuilder {
private static final SdkField EMAIL_IDENTITY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EmailIdentity").getter(getter(CreateEmailIdentityRequest::emailIdentity))
.setter(setter(Builder::emailIdentity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EmailIdentity").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateEmailIdentityRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(EMAIL_IDENTITY_FIELD,
TAGS_FIELD));
private final String emailIdentity;
private final List tags;
private CreateEmailIdentityRequest(BuilderImpl builder) {
super(builder);
this.emailIdentity = builder.emailIdentity;
this.tags = builder.tags;
}
/**
*
* The email address or domain that you want to verify.
*
*
* @return The email address or domain that you want to verify.
*/
public final String emailIdentity() {
return emailIdentity;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that define the tags (keys and values) that you want to associate with the email identity.
*
*
* 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 #hasTags} method.
*
*
* @return An array of objects that define the tags (keys and values) that you want to associate with the email
* identity.
*/
public final List tags() {
return tags;
}
@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(hasTags() ? tags() : 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 CreateEmailIdentityRequest)) {
return false;
}
CreateEmailIdentityRequest other = (CreateEmailIdentityRequest) obj;
return Objects.equals(emailIdentity(), other.emailIdentity()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateEmailIdentityRequest").add("EmailIdentity", emailIdentity())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EmailIdentity":
return Optional.ofNullable(clazz.cast(emailIdentity()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateEmailIdentityRequest) 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 address or domain that you want to verify.
*
*
* @param emailIdentity
* The email address or domain that you want to verify.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder emailIdentity(String emailIdentity);
/**
*
* An array of objects that define the tags (keys and values) that you want to associate with the email
* identity.
*
*
* @param tags
* An array of objects that define the tags (keys and values) that you want to associate with the email
* identity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* An array of objects that define the tags (keys and values) that you want to associate with the email
* identity.
*
*
* @param tags
* An array of objects that define the tags (keys and values) that you want to associate with the email
* identity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* An array of objects that define the tags (keys and values) that you want to associate with the email
* identity.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.pinpointemail.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.pinpointemail.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.pinpointemail.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends PinpointEmailRequest.BuilderImpl implements Builder {
private String emailIdentity;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateEmailIdentityRequest model) {
super(model);
emailIdentity(model.emailIdentity);
tags(model.tags);
}
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 List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.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 CreateEmailIdentityRequest build() {
return new CreateEmailIdentityRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}