@Generated(value="software.amazon.awssdk:codegen") public final class ListObjectVersionsResponse extends S3Response implements ToCopyableBuilder<ListObjectVersionsResponse.Builder,ListObjectVersionsResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
ListObjectVersionsResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static ListObjectVersionsResponse.Builder |
builder() |
List<CommonPrefix> |
commonPrefixes()
All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
|
List<DeleteMarkerEntry> |
deleteMarkers()
Container for an object that is a delete marker.
|
String |
delimiter()
The delimiter grouping the included keys.
|
EncodingType |
encodingType()
Encoding type used by Amazon S3 to encode object key names in the XML response.
|
String |
encodingTypeAsString()
Encoding type used by Amazon S3 to encode object key names in the XML response.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCommonPrefixes()
Returns true if the CommonPrefixes property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasDeleteMarkers()
Returns true if the DeleteMarkers property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasVersions()
Returns true if the Versions property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
Boolean |
isTruncated()
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
|
String |
keyMarker()
Marks the last key returned in a truncated response.
|
Integer |
maxKeys()
Specifies the maximum number of objects to return.
|
String |
name()
Bucket name.
|
String |
nextKeyMarker()
When the number of responses exceeds the value of
MaxKeys , NextKeyMarker specifies the
first key not returned that satisfies the search criteria. |
String |
nextVersionIdMarker()
When the number of responses exceeds the value of
MaxKeys , NextVersionIdMarker
specifies the first object version not returned that satisfies the search criteria. |
String |
prefix()
Selects objects that start with the value supplied by this parameter.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListObjectVersionsResponse.Builder> |
serializableBuilderClass() |
ListObjectVersionsResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionIdMarker()
Marks the last version of the key returned in a truncated response.
|
List<ObjectVersion> |
versions()
Container for version information.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public Boolean isTruncated()
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
public String keyMarker()
Marks the last key returned in a truncated response.
public String versionIdMarker()
Marks the last version of the key returned in a truncated response.
public String nextKeyMarker()
When the number of responses exceeds the value of MaxKeys
, NextKeyMarker
specifies the
first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in
a subsequent request.
MaxKeys
, NextKeyMarker
specifies the first key not returned that satisfies the search criteria. Use this value for the
key-marker request parameter in a subsequent request.public String nextVersionIdMarker()
When the number of responses exceeds the value of MaxKeys
, NextVersionIdMarker
specifies the first object version not returned that satisfies the search criteria. Use this value for the
version-id-marker request parameter in a subsequent request.
MaxKeys
, NextVersionIdMarker
specifies the first object version not returned that satisfies the search criteria. Use this value for
the version-id-marker request parameter in a subsequent request.public boolean hasVersions()
public List<ObjectVersion> versions()
Container for version information.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasVersions()
to see if a value was sent in this field.
public boolean hasDeleteMarkers()
public List<DeleteMarkerEntry> deleteMarkers()
Container for an object that is a delete marker.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDeleteMarkers()
to see if a value was sent in this field.
public String name()
Bucket name.
public String prefix()
Selects objects that start with the value supplied by this parameter.
public String delimiter()
The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys
that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a
single result element in CommonPrefixes
. These groups are counted as one result against the max-keys
limitation. These keys are not returned elsewhere in the response.
CommonPrefixes
. These groups are counted as one
result against the max-keys limitation. These keys are not returned elsewhere in the response.public Integer maxKeys()
Specifies the maximum number of objects to return.
public boolean hasCommonPrefixes()
public List<CommonPrefix> commonPrefixes()
All of the keys rolled 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.
You can use hasCommonPrefixes()
to see if a value was sent in this field.
public EncodingType encodingType()
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
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()
.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
EncodingType
public String encodingTypeAsString()
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
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()
.
If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
EncodingType
public ListObjectVersionsResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<ListObjectVersionsResponse.Builder,ListObjectVersionsResponse>
toBuilder
in class AwsResponse
public static ListObjectVersionsResponse.Builder builder()
public static Class<? extends ListObjectVersionsResponse.Builder> serializableBuilderClass()
public int hashCode()
hashCode
in class AwsResponse
public boolean equals(Object obj)
equals
in class AwsResponse
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2020. All rights reserved.