software.amazon.awssdk.services.ses.model.DescribeConfigurationSetResponse 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.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.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;
/**
*
* Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For
* information about using configuration sets, see the Amazon SES Developer Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeConfigurationSetResponse extends SesResponse implements
ToCopyableBuilder {
private static final SdkField CONFIGURATION_SET_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ConfigurationSet")
.getter(getter(DescribeConfigurationSetResponse::configurationSet)).setter(setter(Builder::configurationSet))
.constructor(ConfigurationSet::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConfigurationSet").build()).build();
private static final SdkField> EVENT_DESTINATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EventDestinations")
.getter(getter(DescribeConfigurationSetResponse::eventDestinations))
.setter(setter(Builder::eventDestinations))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventDestinations").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EventDestination::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField TRACKING_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TrackingOptions")
.getter(getter(DescribeConfigurationSetResponse::trackingOptions)).setter(setter(Builder::trackingOptions))
.constructor(TrackingOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TrackingOptions").build()).build();
private static final SdkField DELIVERY_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DeliveryOptions")
.getter(getter(DescribeConfigurationSetResponse::deliveryOptions)).setter(setter(Builder::deliveryOptions))
.constructor(DeliveryOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeliveryOptions").build()).build();
private static final SdkField REPUTATION_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ReputationOptions")
.getter(getter(DescribeConfigurationSetResponse::reputationOptions)).setter(setter(Builder::reputationOptions))
.constructor(ReputationOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReputationOptions").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONFIGURATION_SET_FIELD,
EVENT_DESTINATIONS_FIELD, TRACKING_OPTIONS_FIELD, DELIVERY_OPTIONS_FIELD, REPUTATION_OPTIONS_FIELD));
private final ConfigurationSet configurationSet;
private final List eventDestinations;
private final TrackingOptions trackingOptions;
private final DeliveryOptions deliveryOptions;
private final ReputationOptions reputationOptions;
private DescribeConfigurationSetResponse(BuilderImpl builder) {
super(builder);
this.configurationSet = builder.configurationSet;
this.eventDestinations = builder.eventDestinations;
this.trackingOptions = builder.trackingOptions;
this.deliveryOptions = builder.deliveryOptions;
this.reputationOptions = builder.reputationOptions;
}
/**
*
* The configuration set object associated with the specified configuration set.
*
*
* @return The configuration set object associated with the specified configuration set.
*/
public final ConfigurationSet configurationSet() {
return configurationSet;
}
/**
* For responses, this returns true if the service returned a value for the EventDestinations 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 hasEventDestinations() {
return eventDestinations != null && !(eventDestinations instanceof SdkAutoConstructList);
}
/**
*
* A list of event destinations associated with the configuration set.
*
*
* 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 #hasEventDestinations} method.
*
*
* @return A list of event destinations associated with the configuration set.
*/
public final List eventDestinations() {
return eventDestinations;
}
/**
*
* The name of the custom open and click tracking domain associated with the configuration set.
*
*
* @return The name of the custom open and click tracking domain associated with the configuration set.
*/
public final TrackingOptions trackingOptions() {
return trackingOptions;
}
/**
* Returns the value of the DeliveryOptions property for this object.
*
* @return The value of the DeliveryOptions property for this object.
*/
public final DeliveryOptions deliveryOptions() {
return deliveryOptions;
}
/**
*
* An object that represents the reputation settings for the configuration set.
*
*
* @return An object that represents the reputation settings for the configuration set.
*/
public final ReputationOptions reputationOptions() {
return reputationOptions;
}
@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(configurationSet());
hashCode = 31 * hashCode + Objects.hashCode(hasEventDestinations() ? eventDestinations() : null);
hashCode = 31 * hashCode + Objects.hashCode(trackingOptions());
hashCode = 31 * hashCode + Objects.hashCode(deliveryOptions());
hashCode = 31 * hashCode + Objects.hashCode(reputationOptions());
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 DescribeConfigurationSetResponse)) {
return false;
}
DescribeConfigurationSetResponse other = (DescribeConfigurationSetResponse) obj;
return Objects.equals(configurationSet(), other.configurationSet())
&& hasEventDestinations() == other.hasEventDestinations()
&& Objects.equals(eventDestinations(), other.eventDestinations())
&& Objects.equals(trackingOptions(), other.trackingOptions())
&& Objects.equals(deliveryOptions(), other.deliveryOptions())
&& Objects.equals(reputationOptions(), other.reputationOptions());
}
/**
* 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("DescribeConfigurationSetResponse").add("ConfigurationSet", configurationSet())
.add("EventDestinations", hasEventDestinations() ? eventDestinations() : null)
.add("TrackingOptions", trackingOptions()).add("DeliveryOptions", deliveryOptions())
.add("ReputationOptions", reputationOptions()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ConfigurationSet":
return Optional.ofNullable(clazz.cast(configurationSet()));
case "EventDestinations":
return Optional.ofNullable(clazz.cast(eventDestinations()));
case "TrackingOptions":
return Optional.ofNullable(clazz.cast(trackingOptions()));
case "DeliveryOptions":
return Optional.ofNullable(clazz.cast(deliveryOptions()));
case "ReputationOptions":
return Optional.ofNullable(clazz.cast(reputationOptions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeConfigurationSetResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SesResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The configuration set object associated with the specified configuration set.
*
*
* @param configurationSet
* The configuration set object associated with the specified configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configurationSet(ConfigurationSet configurationSet);
/**
*
* The configuration set object associated with the specified configuration set.
*
* This is a convenience method that creates an instance of the {@link ConfigurationSet.Builder} avoiding the
* need to create one manually via {@link ConfigurationSet#builder()}.
*
*
* When the {@link Consumer} completes, {@link ConfigurationSet.Builder#build()} is called immediately and its
* result is passed to {@link #configurationSet(ConfigurationSet)}.
*
* @param configurationSet
* a consumer that will call methods on {@link ConfigurationSet.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #configurationSet(ConfigurationSet)
*/
default Builder configurationSet(Consumer configurationSet) {
return configurationSet(ConfigurationSet.builder().applyMutation(configurationSet).build());
}
/**
*
* A list of event destinations associated with the configuration set.
*
*
* @param eventDestinations
* A list of event destinations associated with the configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventDestinations(Collection eventDestinations);
/**
*
* A list of event destinations associated with the configuration set.
*
*
* @param eventDestinations
* A list of event destinations associated with the configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventDestinations(EventDestination... eventDestinations);
/**
*
* A list of event destinations associated with the configuration set.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ses.model.EventDestination.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ses.model.EventDestination#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ses.model.EventDestination.Builder#build()} is called immediately and
* its result is passed to {@link #eventDestinations(List)}.
*
* @param eventDestinations
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ses.model.EventDestination.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #eventDestinations(java.util.Collection)
*/
Builder eventDestinations(Consumer... eventDestinations);
/**
*
* The name of the custom open and click tracking domain associated with the configuration set.
*
*
* @param trackingOptions
* The name of the custom open and click tracking domain associated with the configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trackingOptions(TrackingOptions trackingOptions);
/**
*
* The name of the custom open and click tracking domain associated with the configuration set.
*
* This is a convenience method that creates an instance of the {@link TrackingOptions.Builder} avoiding the
* need to create one manually via {@link TrackingOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link TrackingOptions.Builder#build()} is called immediately and its
* result is passed to {@link #trackingOptions(TrackingOptions)}.
*
* @param trackingOptions
* a consumer that will call methods on {@link TrackingOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #trackingOptions(TrackingOptions)
*/
default Builder trackingOptions(Consumer trackingOptions) {
return trackingOptions(TrackingOptions.builder().applyMutation(trackingOptions).build());
}
/**
* Sets the value of the DeliveryOptions property for this object.
*
* @param deliveryOptions
* The new value for the DeliveryOptions property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deliveryOptions(DeliveryOptions deliveryOptions);
/**
* Sets the value of the DeliveryOptions property for this object.
*
* This is a convenience method that creates an instance of the {@link DeliveryOptions.Builder} avoiding the
* need to create one manually via {@link DeliveryOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link DeliveryOptions.Builder#build()} is called immediately and its
* result is passed to {@link #deliveryOptions(DeliveryOptions)}.
*
* @param deliveryOptions
* a consumer that will call methods on {@link DeliveryOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #deliveryOptions(DeliveryOptions)
*/
default Builder deliveryOptions(Consumer deliveryOptions) {
return deliveryOptions(DeliveryOptions.builder().applyMutation(deliveryOptions).build());
}
/**
*
* An object that represents the reputation settings for the configuration set.
*
*
* @param reputationOptions
* An object that represents the reputation settings for the configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reputationOptions(ReputationOptions reputationOptions);
/**
*
* An object that represents the reputation settings for the configuration set.
*
* This is a convenience method that creates an instance of the {@link ReputationOptions.Builder} avoiding the
* need to create one manually via {@link ReputationOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link ReputationOptions.Builder#build()} is called immediately and its
* result is passed to {@link #reputationOptions(ReputationOptions)}.
*
* @param reputationOptions
* a consumer that will call methods on {@link ReputationOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #reputationOptions(ReputationOptions)
*/
default Builder reputationOptions(Consumer reputationOptions) {
return reputationOptions(ReputationOptions.builder().applyMutation(reputationOptions).build());
}
}
static final class BuilderImpl extends SesResponse.BuilderImpl implements Builder {
private ConfigurationSet configurationSet;
private List eventDestinations = DefaultSdkAutoConstructList.getInstance();
private TrackingOptions trackingOptions;
private DeliveryOptions deliveryOptions;
private ReputationOptions reputationOptions;
private BuilderImpl() {
}
private BuilderImpl(DescribeConfigurationSetResponse model) {
super(model);
configurationSet(model.configurationSet);
eventDestinations(model.eventDestinations);
trackingOptions(model.trackingOptions);
deliveryOptions(model.deliveryOptions);
reputationOptions(model.reputationOptions);
}
public final ConfigurationSet.Builder getConfigurationSet() {
return configurationSet != null ? configurationSet.toBuilder() : null;
}
public final void setConfigurationSet(ConfigurationSet.BuilderImpl configurationSet) {
this.configurationSet = configurationSet != null ? configurationSet.build() : null;
}
@Override
public final Builder configurationSet(ConfigurationSet configurationSet) {
this.configurationSet = configurationSet;
return this;
}
public final List getEventDestinations() {
List result = EventDestinationsCopier.copyToBuilder(this.eventDestinations);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setEventDestinations(Collection eventDestinations) {
this.eventDestinations = EventDestinationsCopier.copyFromBuilder(eventDestinations);
}
@Override
public final Builder eventDestinations(Collection eventDestinations) {
this.eventDestinations = EventDestinationsCopier.copy(eventDestinations);
return this;
}
@Override
@SafeVarargs
public final Builder eventDestinations(EventDestination... eventDestinations) {
eventDestinations(Arrays.asList(eventDestinations));
return this;
}
@Override
@SafeVarargs
public final Builder eventDestinations(Consumer... eventDestinations) {
eventDestinations(Stream.of(eventDestinations).map(c -> EventDestination.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final TrackingOptions.Builder getTrackingOptions() {
return trackingOptions != null ? trackingOptions.toBuilder() : null;
}
public final void setTrackingOptions(TrackingOptions.BuilderImpl trackingOptions) {
this.trackingOptions = trackingOptions != null ? trackingOptions.build() : null;
}
@Override
public final Builder trackingOptions(TrackingOptions trackingOptions) {
this.trackingOptions = trackingOptions;
return this;
}
public final DeliveryOptions.Builder getDeliveryOptions() {
return deliveryOptions != null ? deliveryOptions.toBuilder() : null;
}
public final void setDeliveryOptions(DeliveryOptions.BuilderImpl deliveryOptions) {
this.deliveryOptions = deliveryOptions != null ? deliveryOptions.build() : null;
}
@Override
public final Builder deliveryOptions(DeliveryOptions deliveryOptions) {
this.deliveryOptions = deliveryOptions;
return this;
}
public final ReputationOptions.Builder getReputationOptions() {
return reputationOptions != null ? reputationOptions.toBuilder() : null;
}
public final void setReputationOptions(ReputationOptions.BuilderImpl reputationOptions) {
this.reputationOptions = reputationOptions != null ? reputationOptions.build() : null;
}
@Override
public final Builder reputationOptions(ReputationOptions reputationOptions) {
this.reputationOptions = reputationOptions;
return this;
}
@Override
public DescribeConfigurationSetResponse build() {
return new DescribeConfigurationSetResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}