Class ListObjectsResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListObjectsResponse.Builder,
ListObjectsResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListObjectsResponse.Builder
builder()
final List
<CommonPrefix> 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.contents()
Metadata about each object returned.final String
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.final EncodingType
Encoding type used by Amazon S3 to encode object keys in the response.final String
Encoding type used by Amazon S3 to encode object keys in the response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the CommonPrefixes property.final boolean
For responses, this returns true if the service returned a value for the Contents property.final int
hashCode()
final Boolean
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.final String
marker()
Indicates where in the bucket listing begins.final Integer
maxKeys()
The maximum number of keys returned in the response body.final String
name()
The bucket name.final String
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.final String
prefix()
Keys that begin with the indicated prefix.final RequestCharged
Returns the value of the RequestCharged property for this object.final String
Returns the value of the RequestCharged property for this object.static Class
<? extends ListObjectsResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
The bucket name.
- Returns:
- The bucket name.
-
prefix
Keys that begin with the indicated prefix.
- Returns:
- Keys that begin with the indicated prefix.
-
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
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
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
Encoding type used by Amazon S3 to encode object keys in the response. If using
url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.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. If using
url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png. - See Also:
-
encodingTypeAsString
Encoding type used by Amazon S3 to encode object keys in the response. If using
url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.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. If using
url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png. - See Also:
-
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:
-
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:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListObjectsResponse.Builder,
ListObjectsResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-