software.amazon.awssdk.services.pinpointemail.model.GetDomainStatisticsReportResponse 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.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*
* An object that includes statistics that are related to the domain that you specified.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetDomainStatisticsReportResponse extends PinpointEmailResponse implements
ToCopyableBuilder {
private static final SdkField OVERALL_VOLUME_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OverallVolume")
.getter(getter(GetDomainStatisticsReportResponse::overallVolume)).setter(setter(Builder::overallVolume))
.constructor(OverallVolume::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OverallVolume").build()).build();
private static final SdkField> DAILY_VOLUMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DailyVolumes")
.getter(getter(GetDomainStatisticsReportResponse::dailyVolumes))
.setter(setter(Builder::dailyVolumes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DailyVolumes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DailyVolume::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OVERALL_VOLUME_FIELD,
DAILY_VOLUMES_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("OverallVolume", OVERALL_VOLUME_FIELD);
put("DailyVolumes", DAILY_VOLUMES_FIELD);
}
});
private final OverallVolume overallVolume;
private final List dailyVolumes;
private GetDomainStatisticsReportResponse(BuilderImpl builder) {
super(builder);
this.overallVolume = builder.overallVolume;
this.dailyVolumes = builder.dailyVolumes;
}
/**
*
* An object that contains deliverability metrics for the domain that you specified. The data in this object is a
* summary of all of the data that was collected from the StartDate to the EndDate.
*
*
* @return An object that contains deliverability metrics for the domain that you specified. The data in this object
* is a summary of all of the data that was collected from the StartDate to the
* EndDate.
*/
public final OverallVolume overallVolume() {
return overallVolume;
}
/**
* For responses, this returns true if the service returned a value for the DailyVolumes 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 hasDailyVolumes() {
return dailyVolumes != null && !(dailyVolumes instanceof SdkAutoConstructList);
}
/**
*
* An object that contains deliverability metrics for the domain that you specified. This object contains data for
* each day, starting on the StartDate and ending on the EndDate.
*
*
* 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 #hasDailyVolumes} method.
*
*
* @return An object that contains deliverability metrics for the domain that you specified. This object contains
* data for each day, starting on the StartDate and ending on the EndDate.
*/
public final List dailyVolumes() {
return dailyVolumes;
}
@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(overallVolume());
hashCode = 31 * hashCode + Objects.hashCode(hasDailyVolumes() ? dailyVolumes() : 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 GetDomainStatisticsReportResponse)) {
return false;
}
GetDomainStatisticsReportResponse other = (GetDomainStatisticsReportResponse) obj;
return Objects.equals(overallVolume(), other.overallVolume()) && hasDailyVolumes() == other.hasDailyVolumes()
&& Objects.equals(dailyVolumes(), other.dailyVolumes());
}
/**
* 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("GetDomainStatisticsReportResponse").add("OverallVolume", overallVolume())
.add("DailyVolumes", hasDailyVolumes() ? dailyVolumes() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "OverallVolume":
return Optional.ofNullable(clazz.cast(overallVolume()));
case "DailyVolumes":
return Optional.ofNullable(clazz.cast(dailyVolumes()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((GetDomainStatisticsReportResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PinpointEmailResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* An object that contains deliverability metrics for the domain that you specified. The data in this object is
* a summary of all of the data that was collected from the StartDate to the EndDate.
*
*
* @param overallVolume
* An object that contains deliverability metrics for the domain that you specified. The data in this
* object is a summary of all of the data that was collected from the StartDate to the
* EndDate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder overallVolume(OverallVolume overallVolume);
/**
*
* An object that contains deliverability metrics for the domain that you specified. The data in this object is
* a summary of all of the data that was collected from the StartDate to the EndDate.
*
* This is a convenience method that creates an instance of the {@link OverallVolume.Builder} avoiding the need
* to create one manually via {@link OverallVolume#builder()}.
*
*
* When the {@link Consumer} completes, {@link OverallVolume.Builder#build()} is called immediately and its
* result is passed to {@link #overallVolume(OverallVolume)}.
*
* @param overallVolume
* a consumer that will call methods on {@link OverallVolume.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #overallVolume(OverallVolume)
*/
default Builder overallVolume(Consumer overallVolume) {
return overallVolume(OverallVolume.builder().applyMutation(overallVolume).build());
}
/**
*
* An object that contains deliverability metrics for the domain that you specified. This object contains data
* for each day, starting on the StartDate and ending on the EndDate.
*
*
* @param dailyVolumes
* An object that contains deliverability metrics for the domain that you specified. This object contains
* data for each day, starting on the StartDate and ending on the EndDate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dailyVolumes(Collection dailyVolumes);
/**
*
* An object that contains deliverability metrics for the domain that you specified. This object contains data
* for each day, starting on the StartDate and ending on the EndDate.
*
*
* @param dailyVolumes
* An object that contains deliverability metrics for the domain that you specified. This object contains
* data for each day, starting on the StartDate and ending on the EndDate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dailyVolumes(DailyVolume... dailyVolumes);
/**
*
* An object that contains deliverability metrics for the domain that you specified. This object contains data
* for each day, starting on the StartDate and ending on the EndDate.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.pinpointemail.model.DailyVolume.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.pinpointemail.model.DailyVolume#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.pinpointemail.model.DailyVolume.Builder#build()} is called immediately
* and its result is passed to {@link #dailyVolumes(List)}.
*
* @param dailyVolumes
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.DailyVolume.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dailyVolumes(java.util.Collection)
*/
Builder dailyVolumes(Consumer... dailyVolumes);
}
static final class BuilderImpl extends PinpointEmailResponse.BuilderImpl implements Builder {
private OverallVolume overallVolume;
private List dailyVolumes = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetDomainStatisticsReportResponse model) {
super(model);
overallVolume(model.overallVolume);
dailyVolumes(model.dailyVolumes);
}
public final OverallVolume.Builder getOverallVolume() {
return overallVolume != null ? overallVolume.toBuilder() : null;
}
public final void setOverallVolume(OverallVolume.BuilderImpl overallVolume) {
this.overallVolume = overallVolume != null ? overallVolume.build() : null;
}
@Override
public final Builder overallVolume(OverallVolume overallVolume) {
this.overallVolume = overallVolume;
return this;
}
public final List getDailyVolumes() {
List result = DailyVolumesCopier.copyToBuilder(this.dailyVolumes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDailyVolumes(Collection dailyVolumes) {
this.dailyVolumes = DailyVolumesCopier.copyFromBuilder(dailyVolumes);
}
@Override
public final Builder dailyVolumes(Collection dailyVolumes) {
this.dailyVolumes = DailyVolumesCopier.copy(dailyVolumes);
return this;
}
@Override
@SafeVarargs
public final Builder dailyVolumes(DailyVolume... dailyVolumes) {
dailyVolumes(Arrays.asList(dailyVolumes));
return this;
}
@Override
@SafeVarargs
public final Builder dailyVolumes(Consumer... dailyVolumes) {
dailyVolumes(Stream.of(dailyVolumes).map(c -> DailyVolume.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public GetDomainStatisticsReportResponse build() {
return new GetDomainStatisticsReportResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}