Package software.amazon.awssdk.services.cloudfront.model

Class DistributionIdList

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.DistributionIdList

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DistributionIdList.Builder,DistributionIdList>

@Generated("software.amazon.awssdk:codegen")
public final class DistributionIdList
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DistributionIdList.Builder,DistributionIdList>

A list of distribution IDs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DistributionIdList.Builder

Method Summary

Modifier and Type	Method	Description
static DistributionIdList.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItems()	For responses, this returns true if the service returned a value for the Items property.
Boolean	isTruncated()	A flag that indicates whether more distribution IDs remain to be listed.
List<String>	items()	Contains the distribution IDs in the list.
String	marker()	The value provided in the Marker request field.
Integer	maxItems()	The maximum number of distribution IDs requested.
String	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.
Integer	quantity()	The total number of distribution IDs returned in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DistributionIdList.Builder>	serializableBuilderClass()
DistributionIdList.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

marker

public final String marker()

The value provided in the Marker request field.

Returns:

The value provided in the Marker request field.

nextMarker

public final String 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.

Returns:

Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off.

maxItems

public final Integer maxItems()

The maximum number of distribution IDs requested.

Returns:

The maximum number of distribution IDs requested.

isTruncated

public final Boolean 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.

Returns:

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.

quantity

public final Integer quantity()

The total number of distribution IDs returned in the response.

Returns:

The total number of distribution IDs returned in the response.

hasItems

public final boolean hasItems()

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 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.

items

public final List<String> items()

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 hasItems() method.

Returns:

Contains the distribution IDs in the list.

toBuilder

public DistributionIdList.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DistributionIdList.Builder,DistributionIdList>

builder

public static DistributionIdList.Builder builder()

serializableBuilderClass

public static Class<? extends DistributionIdList.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo