software.amazon.awssdk.services.ses.model.DescribeConfigurationSetRequest Maven / Gradle / Ivy
/*
* 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 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;
/**
*
* Represents a request to return 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 DescribeConfigurationSetRequest extends SesRequest implements
ToCopyableBuilder {
private static final SdkField CONFIGURATION_SET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConfigurationSetName").getter(getter(DescribeConfigurationSetRequest::configurationSetName))
.setter(setter(Builder::configurationSetName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConfigurationSetName").build())
.build();
private static final SdkField> CONFIGURATION_SET_ATTRIBUTE_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ConfigurationSetAttributeNames")
.getter(getter(DescribeConfigurationSetRequest::configurationSetAttributeNamesAsStrings))
.setter(setter(Builder::configurationSetAttributeNamesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConfigurationSetAttributeNames")
.build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONFIGURATION_SET_NAME_FIELD,
CONFIGURATION_SET_ATTRIBUTE_NAMES_FIELD));
private final String configurationSetName;
private final List configurationSetAttributeNames;
private DescribeConfigurationSetRequest(BuilderImpl builder) {
super(builder);
this.configurationSetName = builder.configurationSetName;
this.configurationSetAttributeNames = builder.configurationSetAttributeNames;
}
/**
*
* The name of the configuration set to describe.
*
*
* @return The name of the configuration set to describe.
*/
public final String configurationSetName() {
return configurationSetName;
}
/**
*
* A list of configuration set attributes to return.
*
*
* 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 #hasConfigurationSetAttributeNames} method.
*
*
* @return A list of configuration set attributes to return.
*/
public final List configurationSetAttributeNames() {
return ConfigurationSetAttributeListCopier.copyStringToEnum(configurationSetAttributeNames);
}
/**
* For responses, this returns true if the service returned a value for the ConfigurationSetAttributeNames 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 hasConfigurationSetAttributeNames() {
return configurationSetAttributeNames != null && !(configurationSetAttributeNames instanceof SdkAutoConstructList);
}
/**
*
* A list of configuration set attributes to return.
*
*
* 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 #hasConfigurationSetAttributeNames} method.
*
*
* @return A list of configuration set attributes to return.
*/
public final List configurationSetAttributeNamesAsStrings() {
return configurationSetAttributeNames;
}
@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(configurationSetName());
hashCode = 31 * hashCode
+ Objects.hashCode(hasConfigurationSetAttributeNames() ? configurationSetAttributeNamesAsStrings() : 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 DescribeConfigurationSetRequest)) {
return false;
}
DescribeConfigurationSetRequest other = (DescribeConfigurationSetRequest) obj;
return Objects.equals(configurationSetName(), other.configurationSetName())
&& hasConfigurationSetAttributeNames() == other.hasConfigurationSetAttributeNames()
&& Objects.equals(configurationSetAttributeNamesAsStrings(), other.configurationSetAttributeNamesAsStrings());
}
/**
* 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("DescribeConfigurationSetRequest")
.add("ConfigurationSetName", configurationSetName())
.add("ConfigurationSetAttributeNames",
hasConfigurationSetAttributeNames() ? configurationSetAttributeNamesAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ConfigurationSetName":
return Optional.ofNullable(clazz.cast(configurationSetName()));
case "ConfigurationSetAttributeNames":
return Optional.ofNullable(clazz.cast(configurationSetAttributeNamesAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeConfigurationSetRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SesRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the configuration set to describe.
*
*
* @param configurationSetName
* The name of the configuration set to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configurationSetName(String configurationSetName);
/**
*
* A list of configuration set attributes to return.
*
*
* @param configurationSetAttributeNames
* A list of configuration set attributes to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configurationSetAttributeNamesWithStrings(Collection configurationSetAttributeNames);
/**
*
* A list of configuration set attributes to return.
*
*
* @param configurationSetAttributeNames
* A list of configuration set attributes to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configurationSetAttributeNamesWithStrings(String... configurationSetAttributeNames);
/**
*
* A list of configuration set attributes to return.
*
*
* @param configurationSetAttributeNames
* A list of configuration set attributes to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configurationSetAttributeNames(Collection configurationSetAttributeNames);
/**
*
* A list of configuration set attributes to return.
*
*
* @param configurationSetAttributeNames
* A list of configuration set attributes to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configurationSetAttributeNames(ConfigurationSetAttribute... configurationSetAttributeNames);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SesRequest.BuilderImpl implements Builder {
private String configurationSetName;
private List configurationSetAttributeNames = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeConfigurationSetRequest model) {
super(model);
configurationSetName(model.configurationSetName);
configurationSetAttributeNamesWithStrings(model.configurationSetAttributeNames);
}
public final String getConfigurationSetName() {
return configurationSetName;
}
public final void setConfigurationSetName(String configurationSetName) {
this.configurationSetName = configurationSetName;
}
@Override
public final Builder configurationSetName(String configurationSetName) {
this.configurationSetName = configurationSetName;
return this;
}
public final Collection getConfigurationSetAttributeNames() {
if (configurationSetAttributeNames instanceof SdkAutoConstructList) {
return null;
}
return configurationSetAttributeNames;
}
public final void setConfigurationSetAttributeNames(Collection configurationSetAttributeNames) {
this.configurationSetAttributeNames = ConfigurationSetAttributeListCopier.copy(configurationSetAttributeNames);
}
@Override
public final Builder configurationSetAttributeNamesWithStrings(Collection configurationSetAttributeNames) {
this.configurationSetAttributeNames = ConfigurationSetAttributeListCopier.copy(configurationSetAttributeNames);
return this;
}
@Override
@SafeVarargs
public final Builder configurationSetAttributeNamesWithStrings(String... configurationSetAttributeNames) {
configurationSetAttributeNamesWithStrings(Arrays.asList(configurationSetAttributeNames));
return this;
}
@Override
public final Builder configurationSetAttributeNames(Collection configurationSetAttributeNames) {
this.configurationSetAttributeNames = ConfigurationSetAttributeListCopier
.copyEnumToString(configurationSetAttributeNames);
return this;
}
@Override
@SafeVarargs
public final Builder configurationSetAttributeNames(ConfigurationSetAttribute... configurationSetAttributeNames) {
configurationSetAttributeNames(Arrays.asList(configurationSetAttributeNames));
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 DescribeConfigurationSetRequest build() {
return new DescribeConfigurationSetRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy