software.amazon.awssdk.services.cloudfront.model.DistributionIdList Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudfront Show documentation
Show all versions of cloudfront Show documentation
The AWS Java SDK for Amazon CloudFront module holds the client classes that are used for communicating
with Amazon CloudFront Service
/*
* 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.cloudfront.model;
import java.io.Serializable;
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.Function;
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;
/**
*
* A list of distribution IDs.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DistributionIdList implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MARKER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Marker")
.getter(getter(DistributionIdList::marker))
.setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker")
.unmarshallLocationName("Marker").build()).build();
private static final SdkField NEXT_MARKER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NextMarker")
.getter(getter(DistributionIdList::nextMarker))
.setter(setter(Builder::nextMarker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextMarker")
.unmarshallLocationName("NextMarker").build()).build();
private static final SdkField MAX_ITEMS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("MaxItems")
.getter(getter(DistributionIdList::maxItems))
.setter(setter(Builder::maxItems))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxItems")
.unmarshallLocationName("MaxItems").build()).build();
private static final SdkField IS_TRUNCATED_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("IsTruncated")
.getter(getter(DistributionIdList::isTruncated))
.setter(setter(Builder::isTruncated))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IsTruncated")
.unmarshallLocationName("IsTruncated").build()).build();
private static final SdkField QUANTITY_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("Quantity")
.getter(getter(DistributionIdList::quantity))
.setter(setter(Builder::quantity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Quantity")
.unmarshallLocationName("Quantity").build()).build();
private static final SdkField> ITEMS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Items")
.getter(getter(DistributionIdList::items))
.setter(setter(Builder::items))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Items")
.unmarshallLocationName("Items").build(),
ListTrait
.builder()
.memberLocationName("DistributionId")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("DistributionId").unmarshallLocationName("DistributionId")
.build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MARKER_FIELD,
NEXT_MARKER_FIELD, MAX_ITEMS_FIELD, IS_TRUNCATED_FIELD, QUANTITY_FIELD, ITEMS_FIELD));
private static final long serialVersionUID = 1L;
private final String marker;
private final String nextMarker;
private final Integer maxItems;
private final Boolean isTruncated;
private final Integer quantity;
private final List items;
private DistributionIdList(BuilderImpl builder) {
this.marker = builder.marker;
this.nextMarker = builder.nextMarker;
this.maxItems = builder.maxItems;
this.isTruncated = builder.isTruncated;
this.quantity = builder.quantity;
this.items = builder.items;
}
/**
*
* The value provided in the Marker request field.
*
*
* @return The value provided in the Marker request field.
*/
public final String marker() {
return marker;
}
/**
*
* Contains the value that you should use in the Marker field of a subsequent request to continue
* listing distribution IDs where you left off.
*
*
* @return Contains the value that you should use in the Marker field of a subsequent request to
* continue listing distribution IDs where you left off.
*/
public final String nextMarker() {
return nextMarker;
}
/**
*
* The maximum number of distribution IDs requested.
*
*
* @return The maximum number of distribution IDs requested.
*/
public final Integer maxItems() {
return maxItems;
}
/**
*
* A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can
* make a subsequent request using the Marker request field to retrieve more distribution IDs in the
* list.
*
*
* @return A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated,
* you can make a subsequent request using the Marker request field to retrieve more
* distribution IDs in the list.
*/
public final Boolean isTruncated() {
return isTruncated;
}
/**
*
* The total number of distribution IDs returned in the response.
*
*
* @return The total number of distribution IDs returned in the response.
*/
public final Integer quantity() {
return quantity;
}
/**
* For responses, this returns true if the service returned a value for the Items 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 hasItems() {
return items != null && !(items instanceof SdkAutoConstructList);
}
/**
*
* Contains the distribution IDs in the list.
*
*
* 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 #hasItems} method.
*
*
* @return Contains the distribution IDs in the list.
*/
public final List items() {
return items;
}
@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 + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(nextMarker());
hashCode = 31 * hashCode + Objects.hashCode(maxItems());
hashCode = 31 * hashCode + Objects.hashCode(isTruncated());
hashCode = 31 * hashCode + Objects.hashCode(quantity());
hashCode = 31 * hashCode + Objects.hashCode(hasItems() ? items() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DistributionIdList)) {
return false;
}
DistributionIdList other = (DistributionIdList) obj;
return Objects.equals(marker(), other.marker()) && Objects.equals(nextMarker(), other.nextMarker())
&& Objects.equals(maxItems(), other.maxItems()) && Objects.equals(isTruncated(), other.isTruncated())
&& Objects.equals(quantity(), other.quantity()) && hasItems() == other.hasItems()
&& Objects.equals(items(), other.items());
}
/**
* 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("DistributionIdList").add("Marker", marker()).add("NextMarker", nextMarker())
.add("MaxItems", maxItems()).add("IsTruncated", isTruncated()).add("Quantity", quantity())
.add("Items", hasItems() ? items() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "NextMarker":
return Optional.ofNullable(clazz.cast(nextMarker()));
case "MaxItems":
return Optional.ofNullable(clazz.cast(maxItems()));
case "IsTruncated":
return Optional.ofNullable(clazz.cast(isTruncated()));
case "Quantity":
return Optional.ofNullable(clazz.cast(quantity()));
case "Items":
return Optional.ofNullable(clazz.cast(items()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DistributionIdList) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The value provided in the Marker request field.
*
*
* @param marker
* The value provided in the Marker request field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* Contains the value that you should use in the Marker field of a subsequent request to continue
* listing distribution IDs where you left off.
*
*
* @param nextMarker
* Contains the value that you should use in the Marker field of a subsequent request to
* continue listing distribution IDs where you left off.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextMarker(String nextMarker);
/**
*
* The maximum number of distribution IDs requested.
*
*
* @param maxItems
* The maximum number of distribution IDs requested.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxItems(Integer maxItems);
/**
*
* A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you
* can make a subsequent request using the Marker request field to retrieve more distribution IDs
* in the list.
*
*
* @param isTruncated
* A flag that indicates whether more distribution IDs remain to be listed. If your results were
* truncated, you can make a subsequent request using the Marker request field to retrieve
* more distribution IDs in the list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder isTruncated(Boolean isTruncated);
/**
*
* The total number of distribution IDs returned in the response.
*
*
* @param quantity
* The total number of distribution IDs returned in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder quantity(Integer quantity);
/**
*
* Contains the distribution IDs in the list.
*
*
* @param items
* Contains the distribution IDs in the list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder items(Collection items);
/**
*
* Contains the distribution IDs in the list.
*
*
* @param items
* Contains the distribution IDs in the list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder items(String... items);
}
static final class BuilderImpl implements Builder {
private String marker;
private String nextMarker;
private Integer maxItems;
private Boolean isTruncated;
private Integer quantity;
private List items = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DistributionIdList model) {
marker(model.marker);
nextMarker(model.nextMarker);
maxItems(model.maxItems);
isTruncated(model.isTruncated);
quantity(model.quantity);
items(model.items);
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final String getNextMarker() {
return nextMarker;
}
public final void setNextMarker(String nextMarker) {
this.nextMarker = nextMarker;
}
@Override
public final Builder nextMarker(String nextMarker) {
this.nextMarker = nextMarker;
return this;
}
public final Integer getMaxItems() {
return maxItems;
}
public final void setMaxItems(Integer maxItems) {
this.maxItems = maxItems;
}
@Override
public final Builder maxItems(Integer maxItems) {
this.maxItems = maxItems;
return this;
}
public final Boolean getIsTruncated() {
return isTruncated;
}
public final void setIsTruncated(Boolean isTruncated) {
this.isTruncated = isTruncated;
}
@Override
public final Builder isTruncated(Boolean isTruncated) {
this.isTruncated = isTruncated;
return this;
}
public final Integer getQuantity() {
return quantity;
}
public final void setQuantity(Integer quantity) {
this.quantity = quantity;
}
@Override
public final Builder quantity(Integer quantity) {
this.quantity = quantity;
return this;
}
public final Collection getItems() {
if (items instanceof SdkAutoConstructList) {
return null;
}
return items;
}
public final void setItems(Collection items) {
this.items = DistributionIdListSummaryCopier.copy(items);
}
@Override
public final Builder items(Collection items) {
this.items = DistributionIdListSummaryCopier.copy(items);
return this;
}
@Override
@SafeVarargs
public final Builder items(String... items) {
items(Arrays.asList(items));
return this;
}
@Override
public DistributionIdList build() {
return new DistributionIdList(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}