@Generated(value="software.amazon.awssdk:codegen") public final class ListObjectsV2Response extends S3Response implements ToCopyableBuilder<ListObjectsV2Response.Builder,ListObjectsV2Response>
Modifier and Type | Class and Description |
---|---|
static interface |
ListObjectsV2Response.Builder |
Modifier and Type | Method and Description |
---|---|
static ListObjectsV2Response.Builder |
builder() |
List<CommonPrefix> |
commonPrefixes()
CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string
specified by delimiter
|
List<S3Object> |
contents()
Metadata about each object returned.
|
String |
continuationToken()
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.
|
String |
delimiter()
A delimiter is a character you use to group keys.
|
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Boolean |
isTruncated()
A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
|
Integer |
keyCount()
KeyCount is the number of keys returned with this request.
|
Integer |
maxKeys()
Sets the maximum number of keys returned in the response.
|
String |
name()
Name of the bucket to list.
|
String |
nextContinuationToken()
NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be
listed.
|
String |
prefix()
Limits the response to keys that begin with the specified prefix.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListObjectsV2Response.Builder> |
serializableBuilderClass() |
String |
startAfter()
StartAfter is where you want Amazon S3 to start listing from.
|
ListObjectsV2Response.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public Boolean isTruncated()
A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
public List<S3Object> contents()
Metadata about each object returned.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String name()
Name of the bucket to list.
public String prefix()
Limits the response to keys that begin with the specified prefix.
public String delimiter()
A delimiter is a character you use to group keys.
public Integer maxKeys()
Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
public List<CommonPrefix> commonPrefixes()
CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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 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 Integer keyCount()
KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
public String continuationToken()
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key
public String nextContinuationToken()
NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
public String startAfter()
StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket
public ListObjectsV2Response.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListObjectsV2Response.Builder,ListObjectsV2Response>
toBuilder
in class AwsResponse
public static ListObjectsV2Response.Builder builder()
public static Class<? extends ListObjectsV2Response.Builder> serializableBuilderClass()
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2019. All rights reserved.