Class ListObjectVersionsResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListObjectVersionsResponse.Builder,
ListObjectVersionsResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final List
<CommonPrefix> All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.final List
<DeleteMarkerEntry> Container for an object that is a delete marker.final String
The delimiter grouping the included keys.final EncodingType
Encoding type used by Amazon S3 to encode object key names in the XML response.final String
Encoding type used by Amazon S3 to encode object key names in the XML 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 DeleteMarkers property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Versions property.final Boolean
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.final String
Marks the last key returned in a truncated response.final Integer
maxKeys()
Specifies the maximum number of objects to return.final String
name()
The bucket name.final String
When the number of responses exceeds the value ofMaxKeys
,NextKeyMarker
specifies the first key not returned that satisfies the search criteria.final String
When the number of responses exceeds the value ofMaxKeys
,NextVersionIdMarker
specifies the first object version not returned that satisfies the search criteria.final String
prefix()
Selects objects that start with the value supplied by this parameter.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 ListObjectVersionsResponse.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.final String
Marks the last version of the key returned in a truncated response.final List
<ObjectVersion> versions()
Container for version information.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. If your results were truncated, you can make a follow-up paginated request by using the
NextKeyMarker
andNextVersionIdMarker
response parameters as a starting place in another request to return the rest of the results.- Returns:
- 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 by using the
NextKeyMarker
andNextVersionIdMarker
response parameters as a starting place in another request to return the rest of the results.
-
keyMarker
Marks the last key returned in a truncated response.
- Returns:
- Marks the last key returned in a truncated response.
-
versionIdMarker
Marks the last version of the key returned in a truncated response.
- Returns:
- Marks the last version of the key returned in a truncated response.
-
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.- Returns:
- 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.
-
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 theversion-id-marker
request parameter in a subsequent request.- Returns:
- 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 theversion-id-marker
request parameter in a subsequent request.
-
hasVersions
public final boolean hasVersions()For responses, this returns true if the service returned a value for the Versions 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. -
versions
Container for version information.
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
hasVersions()
method.- Returns:
- Container for version information.
-
hasDeleteMarkers
public final boolean hasDeleteMarkers()For responses, this returns true if the service returned a value for the DeleteMarkers 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. -
deleteMarkers
Container for an object that is a delete marker.
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
hasDeleteMarkers()
method.- Returns:
- Container for an object that is a delete marker.
-
name
The bucket name.
- Returns:
- The bucket name.
-
prefix
Selects objects that start with the value supplied by this parameter.
- Returns:
- Selects objects that start with the value supplied by this parameter.
-
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 themax-keys
limitation. These keys are not returned elsewhere in the response.- Returns:
- 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 themax-keys
limitation. These keys are not returned elsewhere in the response.
-
maxKeys
Specifies the maximum number of objects to return.
- Returns:
- Specifies the maximum number of objects to return.
-
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 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.
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 rolled 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 key names in the XML response.
If you specify the
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
, andDelimiter
.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 key names in the XML response.
If you specify the
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
, andDelimiter
. - See Also:
-
encodingTypeAsString
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify the
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
, andDelimiter
.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 key names in the XML response.
If you specify the
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
, andDelimiter
. - 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<ListObjectVersionsResponse.Builder,
ListObjectVersionsResponse> - 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
-