software.amazon.awssdk.services.cloudfront.model.CloudFrontOriginAccessIdentityList Maven / Gradle / Ivy
Show all versions of cloudfront 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.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.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;
/**
*
* Lists the origin access identities for CloudFront.Send a GET
request to the
* /CloudFront API version/origin-access-identity/cloudfront
resource. The response includes a
* CloudFrontOriginAccessIdentityList
element with zero or more
* CloudFrontOriginAccessIdentitySummary
child elements. By default, your entire list of origin access
* identities is returned in one single page. If the list is long, you can paginate it using the MaxItems
* and Marker
parameters.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CloudFrontOriginAccessIdentityList implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MARKER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Marker")
.getter(getter(CloudFrontOriginAccessIdentityList::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(CloudFrontOriginAccessIdentityList::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(CloudFrontOriginAccessIdentityList::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(CloudFrontOriginAccessIdentityList::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(CloudFrontOriginAccessIdentityList::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(CloudFrontOriginAccessIdentityList::items))
.setter(setter(Builder::items))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Items")
.unmarshallLocationName("Items").build(),
ListTrait
.builder()
.memberLocationName("CloudFrontOriginAccessIdentitySummary")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CloudFrontOriginAccessIdentitySummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("CloudFrontOriginAccessIdentitySummary")
.unmarshallLocationName("CloudFrontOriginAccessIdentitySummary").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 CloudFrontOriginAccessIdentityList(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;
}
/**
*
* Use this when paginating results to indicate where to begin in your list of origin access identities. The results
* include identities in the list that occur after the marker. To get the next page of results, set the
* Marker
to the value of the NextMarker
from the current page's response (which is also
* the ID of the last identity on that page).
*
*
* @return Use this when paginating results to indicate where to begin in your list of origin access identities. The
* results include identities in the list that occur after the marker. To get the next page of results, set
* the Marker
to the value of the NextMarker
from the current page's response
* (which is also the ID of the last identity on that page).
*/
public final String marker() {
return marker;
}
/**
*
* If IsTruncated
is true
, this element is present and contains the value you can use for
* the Marker
request parameter to continue listing your origin access identities where they left off.
*
*
* @return If IsTruncated
is true
, this element is present and contains the value you can
* use for the Marker
request parameter to continue listing your origin access identities where
* they left off.
*/
public final String nextMarker() {
return nextMarker;
}
/**
*
* The maximum number of origin access identities you want in the response body.
*
*
* @return The maximum number of origin access identities you want in the response body.
*/
public final Integer maxItems() {
return maxItems;
}
/**
*
* A flag that indicates whether more origin access identities remain to be listed. If your results were truncated,
* you can make a follow-up pagination request using the Marker
request parameter to retrieve more
* items in the list.
*
*
* @return A flag that indicates whether more origin access identities remain to be listed. If your results were
* truncated, you can make a follow-up pagination request using the Marker
request parameter to
* retrieve more items in the list.
*/
public final Boolean isTruncated() {
return isTruncated;
}
/**
*
* The number of CloudFront origin access identities that were created by the current Amazon Web Services account.
*
*
* @return The number of CloudFront origin access identities that were created by the current Amazon Web Services
* account.
*/
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);
}
/**
*
* A complex type that contains one CloudFrontOriginAccessIdentitySummary
element for each origin
* access identity that was created by the current Amazon Web Services account.
*
*
* 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 A complex type that contains one CloudFrontOriginAccessIdentitySummary
element for each
* origin access identity that was created by the current Amazon Web Services account.
*/
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 CloudFrontOriginAccessIdentityList)) {
return false;
}
CloudFrontOriginAccessIdentityList other = (CloudFrontOriginAccessIdentityList) 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("CloudFrontOriginAccessIdentityList").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