Class ListObjectsResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.s3.model.S3Response
-
- software.amazon.awssdk.services.s3.model.ListObjectsResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>
@Generated("software.amazon.awssdk:codegen") public final class ListObjectsResponse extends S3Response implements ToCopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ListObjectsResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListObjectsResponse.Builder
builder()
List<CommonPrefix>
commonPrefixes()
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.List<S3Object>
contents()
Metadata about each object returned.String
delimiter()
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in theCommonPrefixes
collection.EncodingType
encodingType()
Encoding type used by Amazon S3 to encode object keys in the response.String
encodingTypeAsString()
Encoding type used by Amazon S3 to encode object keys in the response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasCommonPrefixes()
For responses, this returns true if the service returned a value for the CommonPrefixes property.boolean
hasContents()
For responses, this returns true if the service returned a value for the Contents property.int
hashCode()
Boolean
isTruncated()
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.String
marker()
Indicates where in the bucket listing begins.Integer
maxKeys()
The maximum number of keys returned in the response body.String
name()
The bucket name.String
nextMarker()
When the response is truncated (theIsTruncated
element value in the response istrue
), you can use the key name in this field as themarker
parameter in the subsequent request to get the next set of objects.String
prefix()
Keys that begin with the indicated prefix.RequestCharged
requestCharged()
Returns the value of the RequestCharged property for this object.String
requestChargedAsString()
Returns the value of the RequestCharged property for this object.List<SdkField<?>>
sdkFields()
static Class<? extends ListObjectsResponse.Builder>
serializableBuilderClass()
ListObjectsResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
isTruncated
public final Boolean isTruncated()
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
- Returns:
- A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
-
marker
public final String marker()
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
- Returns:
- Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
-
nextMarker
public final String nextMarker()
When the response is truncated (the
IsTruncated
element value in the response istrue
), you can use the key name in this field as themarker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.This element is returned only if you have the
delimiter
request parameter specified. If the response does not include theNextMarker
element and it is truncated, you can use the value of the lastKey
element in the response as themarker
parameter in the subsequent request to get the next set of object keys.- Returns:
- When the response is truncated (the
IsTruncated
element value in the response istrue
), you can use the key name in this field as themarker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.This element is returned only if you have the
delimiter
request parameter specified. If the response does not include theNextMarker
element and it is truncated, you can use the value of the lastKey
element in the response as themarker
parameter in the subsequent request to get the next set of object keys.
-
hasContents
public final boolean hasContents()
For responses, this returns true if the service returned a value for the Contents 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.
-
contents
public final List<S3Object> contents()
Metadata about each object returned.
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
hasContents()
method.- Returns:
- Metadata about each object returned.
-
name
public final String name()
The bucket name.
- Returns:
- The bucket name.
-
prefix
public final String prefix()
Keys that begin with the indicated prefix.
- Returns:
- Keys that begin with the indicated prefix.
-
delimiter
public final String delimiter()
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the
CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against theMaxKeys
value.- Returns:
- Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to
be rolled up into a single result element in the
CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against theMaxKeys
value.
-
maxKeys
public final Integer maxKeys()
The maximum number of keys returned in the response body.
- Returns:
- The maximum number of keys returned in the response body.
-
hasCommonPrefixes
public final boolean hasCommonPrefixes()
For responses, this returns true if the service returned a value for the CommonPrefixes 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.
-
commonPrefixes
public final List<CommonPrefix> commonPrefixes()
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.
A response can contain
CommonPrefixes
only if you specify a delimiter.CommonPrefixes
contains all (if there are any) keys betweenPrefix
and the next occurrence of the string specified by the delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
), as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.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
hasCommonPrefixes()
method.- Returns:
- All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the
number of returns.
A response can contain
CommonPrefixes
only if you specify a delimiter.CommonPrefixes
contains all (if there are any) keys betweenPrefix
and the next occurrence of the string specified by the delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
), as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
-
encodingType
public final EncodingType encodingType()
Encoding type used by Amazon S3 to encode object keys in the response.
If the service returns an enum value that is not available in the current SDK version,
encodingType
will returnEncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingTypeAsString()
.- Returns:
- Encoding type used by Amazon S3 to encode object keys in the response.
- See Also:
EncodingType
-
encodingTypeAsString
public final String encodingTypeAsString()
Encoding type used by Amazon S3 to encode object keys in the response.
If the service returns an enum value that is not available in the current SDK version,
encodingType
will returnEncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingTypeAsString()
.- Returns:
- Encoding type used by Amazon S3 to encode object keys in the response.
- See Also:
EncodingType
-
requestCharged
public final RequestCharged requestCharged()
Returns the value of the RequestCharged property for this object.If the service returns an enum value that is not available in the current SDK version,
requestCharged
will returnRequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestChargedAsString()
.- Returns:
- The value of the RequestCharged property for this object.
- See Also:
RequestCharged
-
requestChargedAsString
public final String requestChargedAsString()
Returns the value of the RequestCharged property for this object.If the service returns an enum value that is not available in the current SDK version,
requestCharged
will returnRequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestChargedAsString()
.- Returns:
- The value of the RequestCharged property for this object.
- See Also:
RequestCharged
-
toBuilder
public ListObjectsResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static ListObjectsResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListObjectsResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-