Class CloudFrontOriginAccessIdentityList
- java.lang.Object
-
- software.amazon.awssdk.services.cloudfront.model.CloudFrontOriginAccessIdentityList
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CloudFrontOriginAccessIdentityList.Builder,CloudFrontOriginAccessIdentityList>
@Generated("software.amazon.awssdk:codegen") public final class CloudFrontOriginAccessIdentityList extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CloudFrontOriginAccessIdentityList.Builder,CloudFrontOriginAccessIdentityList>
Lists the origin access identities for CloudFront.Send a
GET
request to the/CloudFront API version/origin-access-identity/cloudfront
resource. The response includes aCloudFrontOriginAccessIdentityList
element with zero or moreCloudFrontOriginAccessIdentitySummary
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 theMaxItems
andMarker
parameters.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CloudFrontOriginAccessIdentityList.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CloudFrontOriginAccessIdentityList.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 origin access identities remain to be listed.List<CloudFrontOriginAccessIdentitySummary>
items()
A complex type that contains oneCloudFrontOriginAccessIdentitySummary
element for each origin access identity that was created by the current Amazon Web Services account.String
marker()
Use this when paginating results to indicate where to begin in your list of origin access identities.Integer
maxItems()
The maximum number of origin access identities you want in the response body.String
nextMarker()
IfIsTruncated
istrue
, this element is present and contains the value you can use for theMarker
request parameter to continue listing your origin access identities where they left off.Integer
quantity()
The number of CloudFront origin access identities that were created by the current Amazon Web Services account.List<SdkField<?>>
sdkFields()
static Class<? extends CloudFrontOriginAccessIdentityList.Builder>
serializableBuilderClass()
CloudFrontOriginAccessIdentityList.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()
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 theNextMarker
from the current page's response (which is also the ID of the last identity on that page).- Returns:
- 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 theNextMarker
from the current page's response (which is also the ID of the last identity on that page).
-
nextMarker
public final String nextMarker()
If
IsTruncated
istrue
, this element is present and contains the value you can use for theMarker
request parameter to continue listing your origin access identities where they left off.- Returns:
- If
IsTruncated
istrue
, this element is present and contains the value you can use for theMarker
request parameter to continue listing your origin access identities where they left off.
-
maxItems
public final Integer maxItems()
The maximum number of origin access identities you want in the response body.
- Returns:
- The maximum number of origin access identities you want in the response body.
-
isTruncated
public final Boolean isTruncated()
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.- Returns:
- 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.
-
quantity
public final Integer quantity()
The number of CloudFront origin access identities that were created by the current Amazon Web Services account.
- Returns:
- The number of CloudFront origin access identities that were created by the current Amazon Web Services account.
-
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 theisEmpty()
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<CloudFrontOriginAccessIdentitySummary> items()
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
hasItems()
method.- Returns:
- A complex type that contains one
CloudFrontOriginAccessIdentitySummary
element for each origin access identity that was created by the current Amazon Web Services account.
-
toBuilder
public CloudFrontOriginAccessIdentityList.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CloudFrontOriginAccessIdentityList.Builder,CloudFrontOriginAccessIdentityList>
-
builder
public static CloudFrontOriginAccessIdentityList.Builder builder()
-
serializableBuilderClass
public static Class<? extends CloudFrontOriginAccessIdentityList.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-