@Generated(value="software.amazon.awssdk:codegen") public final class ListObjectsResponse extends S3Response implements ToCopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
ListObjectsResponse.Builder |
Modifier and Type | Method and 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 the
CommonPrefixes 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 (the
IsTruncated element value in the response is true ),
you can use the key name in this field as the marker 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.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Boolean isTruncated()
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
public final String marker()
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
public final String nextMarker()
When the response is truncated (the IsTruncated
element value in the response is true
),
you can use the key name in this field as the marker
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 the NextMarker
element and it is truncated, you can use the value of the last
Key
element in the response as the marker
parameter in the subsequent request to get
the next set of object keys.
IsTruncated
element value in the response is
true
), you can use the key name in this field as the marker
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 the NextMarker
element and it is truncated, you can use the value
of the last Key
element in the response as the marker
parameter in the
subsequent request to get the next set of object keys.
public final boolean hasContents()
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 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.
public final String name()
The bucket name.
public final String prefix()
Keys that begin with the indicated prefix.
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 the
MaxKeys
value.
CommonPrefixes
collection. These rolled-up
keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against
the MaxKeys
value.public final Integer maxKeys()
The maximum number of keys returned in the response body.
public final boolean hasCommonPrefixes()
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 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 between Prefix
and the next
occurrence of the string specified by the delimiter.
CommonPrefixes
lists keys that act like subdirectories in the directory specified by
Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash (/
), as in
notes/summer/july
, the common prefix is notes/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.
A response can contain CommonPrefixes
only if you specify a delimiter.
CommonPrefixes
contains all (if there are any) keys between Prefix
and the next
occurrence of the string specified by the delimiter.
CommonPrefixes
lists keys that act like subdirectories in the directory specified by
Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash (/
), as in
notes/summer/july
, the common prefix is notes/summer/
. All of the keys that
roll up into a common prefix count as a single return when calculating the number of returns.
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
return EncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
encodingTypeAsString()
.
EncodingType
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
return EncodingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
encodingTypeAsString()
.
EncodingType
public final RequestCharged requestCharged()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public final String requestChargedAsString()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public ListObjectsResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>
toBuilder
in class AwsResponse
public static ListObjectsResponse.Builder builder()
public static Class<? extends ListObjectsResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2023. All rights reserved.