software.amazon.awssdk.services.ses.model.DescribeReceiptRuleSetResponse 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 the specified receipt rule set.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeReceiptRuleSetResponse extends SesResponse implements
ToCopyableBuilder {
private static final SdkField METADATA_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Metadata")
.getter(getter(DescribeReceiptRuleSetResponse::metadata)).setter(setter(Builder::metadata))
.constructor(ReceiptRuleSetMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Metadata").build()).build();
private static final SdkField> RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Rules")
.getter(getter(DescribeReceiptRuleSetResponse::rules))
.setter(setter(Builder::rules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Rules").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ReceiptRule::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(METADATA_FIELD, RULES_FIELD));
private final ReceiptRuleSetMetadata metadata;
private final List rules;
private DescribeReceiptRuleSetResponse(BuilderImpl builder) {
super(builder);
this.metadata = builder.metadata;
this.rules = builder.rules;
}
/**
*
* The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set
* was created.
*
*
* @return The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the
* rule set was created.
*/
public final ReceiptRuleSetMetadata metadata() {
return metadata;
}
/**
* For responses, this returns true if the service returned a value for the Rules 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 hasRules() {
return rules != null && !(rules instanceof SdkAutoConstructList);
}
/**
*
* A list of the receipt rules that belong to the specified receipt rule 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 #hasRules} method.
*
*
* @return A list of the receipt rules that belong to the specified receipt rule set.
*/
public final List rules() {
return rules;
}
@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(metadata());
hashCode = 31 * hashCode + Objects.hashCode(hasRules() ? rules() : 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 DescribeReceiptRuleSetResponse)) {
return false;
}
DescribeReceiptRuleSetResponse other = (DescribeReceiptRuleSetResponse) obj;
return Objects.equals(metadata(), other.metadata()) && hasRules() == other.hasRules()
&& Objects.equals(rules(), other.rules());
}
/**
* 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("DescribeReceiptRuleSetResponse").add("Metadata", metadata())
.add("Rules", hasRules() ? rules() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Metadata":
return Optional.ofNullable(clazz.cast(metadata()));
case "Rules":
return Optional.ofNullable(clazz.cast(rules()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeReceiptRuleSetResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SesResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule
* set was created.
*
*
* @param metadata
* The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when
* the rule set was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metadata(ReceiptRuleSetMetadata metadata);
/**
*
* The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule
* set was created.
*
* This is a convenience method that creates an instance of the {@link ReceiptRuleSetMetadata.Builder} avoiding
* the need to create one manually via {@link ReceiptRuleSetMetadata#builder()}.
*
*
* When the {@link Consumer} completes, {@link ReceiptRuleSetMetadata.Builder#build()} is called immediately and
* its result is passed to {@link #metadata(ReceiptRuleSetMetadata)}.
*
* @param metadata
* a consumer that will call methods on {@link ReceiptRuleSetMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #metadata(ReceiptRuleSetMetadata)
*/
default Builder metadata(Consumer metadata) {
return metadata(ReceiptRuleSetMetadata.builder().applyMutation(metadata).build());
}
/**
*
* A list of the receipt rules that belong to the specified receipt rule set.
*
*
* @param rules
* A list of the receipt rules that belong to the specified receipt rule set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rules(Collection rules);
/**
*
* A list of the receipt rules that belong to the specified receipt rule set.
*
*
* @param rules
* A list of the receipt rules that belong to the specified receipt rule set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rules(ReceiptRule... rules);
/**
*
* A list of the receipt rules that belong to the specified receipt rule set.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ses.model.ReceiptRule.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ses.model.ReceiptRule#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ses.model.ReceiptRule.Builder#build()} is called immediately and its
* result is passed to {@link #rules(List)}.
*
* @param rules
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ses.model.ReceiptRule.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #rules(java.util.Collection)
*/
Builder rules(Consumer... rules);
}
static final class BuilderImpl extends SesResponse.BuilderImpl implements Builder {
private ReceiptRuleSetMetadata metadata;
private List rules = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeReceiptRuleSetResponse model) {
super(model);
metadata(model.metadata);
rules(model.rules);
}
public final ReceiptRuleSetMetadata.Builder getMetadata() {
return metadata != null ? metadata.toBuilder() : null;
}
public final void setMetadata(ReceiptRuleSetMetadata.BuilderImpl metadata) {
this.metadata = metadata != null ? metadata.build() : null;
}
@Override
public final Builder metadata(ReceiptRuleSetMetadata metadata) {
this.metadata = metadata;
return this;
}
public final List getRules() {
List result = ReceiptRulesListCopier.copyToBuilder(this.rules);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRules(Collection rules) {
this.rules = ReceiptRulesListCopier.copyFromBuilder(rules);
}
@Override
public final Builder rules(Collection rules) {
this.rules = ReceiptRulesListCopier.copy(rules);
return this;
}
@Override
@SafeVarargs
public final Builder rules(ReceiptRule... rules) {
rules(Arrays.asList(rules));
return this;
}
@Override
@SafeVarargs
public final Builder rules(Consumer... rules) {
rules(Stream.of(rules).map(c -> ReceiptRule.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public DescribeReceiptRuleSetResponse build() {
return new DescribeReceiptRuleSetResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}